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