udkapi/com/sun/star/io/ObjectOutputStream.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 #ifndef __com_sun_star_io_ObjectOutputStream_idl__
  20 #define __com_sun_star_io_ObjectOutputStream_idl__
  21
  22 #include <com/sun/star/io/XObjectOutputStream.idl>
  23
  24 #include <com/sun/star/io/XActiveDataSource.idl>
  25
  26 #include <com/sun/star/io/XConnectable.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module io {
  31
  32 /** is a stream which allows writing the data of persistent objects.
  33
  34     <p>Implementations of this service must fulfill the specifications of the
  35     DataOutputStream service; furthermore, the stream needs to be chained to a
  36     XMarkableStream. Therefore, it also provides the XMarkableStream
  37     interface, but it delegates the calls to the chained object.
  38     The written objects are held until this instance is destroyed.
  39     The references to the objects are written as four-byte integers
  40     and begin at 1. Data format is written: </p>
  41     <pre>
  42     short   InfoLength
  43     long    ObjectReference // 0 indicates no object
  44     UTF     ServiceName     // length of 0 indicates this is only a reference
  45     long    ObjectLength    // 0 if it is a reference or no object, otherwise the len of the object data
  46     Object  ObjectData      // the data of the object
  47     </pre>
  48
  49     @note
  50     <ul>
  51         <li>-thread safe </li>
  52         <li>-allow buffer size is 2 ^ 31 -1 </li>
  53         <li>-maximum object reference identifier is the number of objects.  </li>
  54         <li>-object reference identifier 0 indicates no object </li>
  55     </ul>
  56  */
  57 published service ObjectOutputStream
  58 {
  59     /** allows to write the data to the stream.
  60      */
  61     interface com::sun::star::io::XObjectOutputStream;
  62
  63     /** allows to set the underlying outputstream */
  64     interface com::sun::star::io::XActiveDataSource;
  65
  66     /** allows to navigate via a chain of streams */
  67     interface com::sun::star::io::XConnectable;
  68
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */