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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*************************************************************************
*
* $RCSfile: XInputStream.idl,v $
*
* $Revision: 1.12 $
*
* last change: $Author: mi $ $Date: 2002-12-11 13:35:26 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_io_XInputStream_idl__
#define __com_sun_star_io_XInputStream_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_io_NotConnectedException_idl__
#include <com/sun/star/io/NotConnectedException.idl>
#endif
#ifndef __com_sun_star_io_BufferSizeExceededException_idl__
#include <com/sun/star/io/BufferSizeExceededException.idl>
#endif
//=============================================================================
module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XInputStream
/** This is the basic interface to read data from a stream.
<p>
See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
streaming document</a> for further information on chaining and piping streams.
*/
interface XInputStream: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::readBytes
/** reads the specified number of bytes in the given sequence.
<p>The return value specifies the number of bytes which have been
put into the sequence. A difference between <var>nBytesToRead</var>
and the return value indicates that EOF has been reached. This means
that the method blocks until the specified number of bytes are
available or the EOF is reached. </p>
@param aData
after the call, the byte sequence contains the requested number
of bytes (or less as a sign of EOF).
<p>
C++ only : Note that for unbridged (e.g., in-process)
calls, using the same sequence for repetive readBytes()-calls
can bear a performance advantage. The callee can put the data
directly into the sequence so that no buffer reallocation is
necessary.
But this holds only when
<ol>
<li> neither caller nor callee keep a second reference to the same
sequence.
<li> the sequence is pre-allocated with the requested number of bytes.
<li> the same sequence is reused ( simply preallocationg a new
sequence for every call bears no advantage ).
<li> the call is not bridged (e.g., betweeen different compilers
or different processes ).
</ol>
If the same 'optimized' code runs against an interface in a different process,
there is an unnecessary memory allocation/deallocation (the out parameter
is of course NOT transported over the connection), but this should
be negligible compared to a synchron call.
*/
long readBytes( [out] sequence<byte> aData,
[in] long nBytesToRead )
raises( com::sun::star::io::NotConnectedException,
com::sun::star::io::BufferSizeExceededException,
com::sun::star::io::IOException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::readSomeBytes
/** reads the available number of bytes, at maximum
<var>nMaxBytesToRead</var>.
<p>This method is very similar to the readBytes method, except that
it has different blocking behaviour.
The method blocks as long as at least 1 byte is available or
EOF has been reached. EOF has only been reached, when the method
returns 0 and the corresponding byte sequence is empty.
Otherwise, after the call, aData contains the available,
but no more than nMaxBytesToRead, bytes.
@param aData contains the data read from the stream.
@param nMaxBytesToRead The maximum number of bytes to be read from this
stream during the call.
@see com::sun::star::io::XInputStream::readBytes
*/
long readSomeBytes( [out] sequence<byte> aData,
[in] long nMaxBytesToRead )
raises( com::sun::star::io::NotConnectedException,
com::sun::star::io::BufferSizeExceededException,
com::sun::star::io::IOException );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::skipBytes
/** skips the next <var>nBytesToSkip</var> bytes (must be positive).
<p>It is up to the implementation whether this method is
blocking the thread or not. </p>
*/
void skipBytes( [in] long nBytesToSkip )
raises( com::sun::star::io::NotConnectedException,
com::sun::star::io::BufferSizeExceededException,
com::sun::star::io::IOException );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::available
/** states how many bytes can be read or skipped without blocking.
<p>Note: This method offers no information on whether the EOF
has been reached. </p>
*/
long available()
raises( com::sun::star::io::NotConnectedException,
com::sun::star::io::IOException
);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::closeInput
/** closes the stream.
<p>Users must close the stream explicitly when no further
reading should be done. (There may exist ring references to
chained objects that can only be released during this call.
Thus not calling this method would result in a leak of memory or
external resources.) </p>
*/
void closeInput()
raises( com::sun::star::io::NotConnectedException,
com::sun::star::io::IOException);
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif
|
