1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_io_XOutputStream_idl__
24#define __com_sun_star_io_XOutputStream_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_io_NotConnectedException_idl__
31#include <com/sun/star/io/NotConnectedException.idl>
32#endif
33
34#ifndef __com_sun_star_io_BufferSizeExceededException_idl__
35#include <com/sun/star/io/BufferSizeExceededException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module io {
42
43//=============================================================================
44
45// DocMerge from xml: interface com::sun::star::io::XOutputStream
46/** This is the basic interface to write data to a stream.
47    <p>
48    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
49    streaming document</a> for further information on chaining and piping streams.
50 */
51published interface XOutputStream: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	// DocMerge from xml: method com::sun::star::io::XOutputStream::writeBytes
56	/** writes the whole sequence to the stream. (blocking call)
57	 */
58	void writeBytes( [in] sequence<byte> aData )
59			raises( com::sun::star::io::NotConnectedException,
60					com::sun::star::io::BufferSizeExceededException,
61					com::sun::star::io::IOException);
62
63	//-------------------------------------------------------------------------
64
65	// DocMerge from xml: method com::sun::star::io::XOutputStream::flush
66	/** flushes out of the stream any data that may exist in buffers.
67
68        <p>The semantics of this method are rather vague.  See
69        <member scope="com::sun::star::io">
70        XAsyncOutputMonitor::waitForCompletion</member> for a similar method
71        with very specific semantics, that is useful in certain scenarios.</p>
72	 */
73	void flush()
74			raises( com::sun::star::io::NotConnectedException,
75					com::sun::star::io::BufferSizeExceededException,
76					com::sun::star::io::IOException);
77
78	//-------------------------------------------------------------------------
79
80	// DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput
81	/** gets called to indicate that all data has been written.
82
83		<p>If this method has not yet been called, no attached
84		<type>XInputStream</type> receives an EOF signal. No further
85		bytes may be written after this method has been called.</p>
86	 */
87	void closeOutput()
88			raises( com::sun::star::io::NotConnectedException,
89					com::sun::star::io::BufferSizeExceededException,
90					com::sun::star::io::IOException);
91
92};
93
94//=============================================================================
95
96}; }; }; };
97
98/*=============================================================================
99
100=============================================================================*/
101#endif
102