udkapi/com/sun/star/io/ObjectInputStream.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module io {
  23
  24 /** is a stream which allows reading the data of persistent objects.
  25
  26     <p>Implementations of this service must fulfill the specifications of the
  27     DataInputStream service. It must be chained to an
  28     XMarkableStream. Therefore, it provides the
  29     XMarkableStream interface, and delegates the calls to the
  30     chained object.  </p>
  31     <p>The written objects are held until this instance is destroyed.
  32     The references to the objects are read as four-byte integers.
  33     Data format reads:</p>
  34
  35     <pre>
  36     short   InfoLength
  37     long    ObjectReference  // 0 indicates no object
  38     UTF     ServiceName      // length of 0 indicates this is only a reference
  39     long    ObjectLength     // 0 if it is a reference or no object, otherwise the len of the object data
  40     Object  ObjectData       // the data of the object
  41     ...                      // skipping additional data
  42     </pre>
  43
  44     @note
  45     <ul>
  46         <li>-thread safe</li>
  47         <li>-allow buffer size is 2 ^ 31 -1</li>
  48         <li>-maximum object reference identifier must be the number of objects. </li>
  49         <li>-object reference identifier 0 indicates no object</li>
  50         <li>-skip addition data</li>
  51         <li>-set the stream position behind the object data</li>
  52     </ul>
  53  */
  54 published service ObjectInputStream
  55 {
  56     /** allows to read the data from the stream.
  57      */
  58     interface com::sun::star::io::XObjectInputStream;
  59
  60     /** allows to set the underlying inputstream */
  61     interface com::sun::star::io::XActiveDataSink;
  62
  63     /** allows to navigate via a chain of streams */
  64     interface com::sun::star::io::XConnectable;
  65
  66     /** allows to set marks within the stream. The implementation
  67      may forward calls to this interface to a chained markablestream. */
  68     interface com::sun::star::io::XMarkableStream;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */