1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_ObjectInputStream_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_io_ObjectInputStream_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XObjectInputStream_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XObjectInputStream.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XActiveDataSink_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XActiveDataSink.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XConnectable_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XConnectable.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XMarkableStream_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XMarkableStream.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski module com { module sun { module star { module io { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski// DocMerge from xml: service com::sun::star::io::ObjectInputStream 50*b1cdbd2cSJim Jagielski/** is a stream which allows reading the data of persistent objects. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p>Implementations of this service must fulfill the specifications of the 53*b1cdbd2cSJim Jagielski <type>DataInputStream</type> service. It must be chained to an 54*b1cdbd2cSJim Jagielski <type>XMarkableStream</type>. Therefore, it provides the 55*b1cdbd2cSJim Jagielski <type>XMarkableStream</type> interface, and delegates the calls to the 56*b1cdbd2cSJim Jagielski chained object. </p> 57*b1cdbd2cSJim Jagielski <p>The written objects are held until this instance is destroyed. 58*b1cdbd2cSJim Jagielski The references to the objects are read as four-byte integers. 59*b1cdbd2cSJim Jagielski Data format reads:</p> 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski <pre> 62*b1cdbd2cSJim Jagielski short InfoLength 63*b1cdbd2cSJim Jagielski long ObjectReference // 0 indicates no object 64*b1cdbd2cSJim Jagielski UTF ServiceName // length of 0 indicates this is only a reference 65*b1cdbd2cSJim Jagielski long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data 66*b1cdbd2cSJim Jagielski Object ObjectData // the data of the object 67*b1cdbd2cSJim Jagielski ... // skipping additional data 68*b1cdbd2cSJim Jagielski </pre> 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @guarantees 71*b1cdbd2cSJim Jagielski <ul> 72*b1cdbd2cSJim Jagielski <li>-thread safe</li> 73*b1cdbd2cSJim Jagielski <li>-allow buffer size is 2 ^ 31 -1</li> 74*b1cdbd2cSJim Jagielski <li>-maximum object reference identifier must be the number of objects. </li> 75*b1cdbd2cSJim Jagielski <li>-object reference identifier 0 indicates no object</li> 76*b1cdbd2cSJim Jagielski <li>-skip addition data</li> 77*b1cdbd2cSJim Jagielski <li>-set the stream position behind the object data</li> 78*b1cdbd2cSJim Jagielski </ul> 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielskipublished service ObjectInputStream 81*b1cdbd2cSJim Jagielski{ 82*b1cdbd2cSJim Jagielski /** allows to read the data from the stream. 83*b1cdbd2cSJim Jagielski */ 84*b1cdbd2cSJim Jagielski interface com::sun::star::io::XObjectInputStream; 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski /** allows to set the underlying inputstream */ 87*b1cdbd2cSJim Jagielski interface com::sun::star::io::XActiveDataSink; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** allows to navigate via a chain of streams */ 90*b1cdbd2cSJim Jagielski interface com::sun::star::io::XConnectable; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski /** allows to set marks within the stream. The implementation 93*b1cdbd2cSJim Jagielski may forward calls to this interface to a chained markablestream. */ 94*b1cdbd2cSJim Jagielski interface com::sun::star::io::XMarkableStream; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski}; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski//============================================================================= 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski}; }; }; }; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski/*============================================================================= 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski=============================================================================*/ 105*b1cdbd2cSJim Jagielski#endif 106