LibreOffice
LibreOffice 24.2 SDK API Reference
List of all members
Pipe Service Referencepublished

the implementation of an output stream and an input stream. More...

import"Pipe.idl";

Inheritance diagram for Pipe:
XPipe XOutputStream XInputStream XInterface XInterface

Additional Inherited Members

- Exported Interfaces inherited from XPipe
interface com::sun::star::io::XOutputStream
 
interface com::sun::star::io::XInputStream
 
- Public Member Functions inherited from XOutputStream
void writeBytes ([in] sequence< byte > aData) raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::BufferSizeExceededException, com::sun::star::io::IOException)
 writes the whole sequence to the stream. More...
 
void flush () raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::BufferSizeExceededException, com::sun::star::io::IOException)
 flushes out of the stream any data that may exist in buffers. More...
 
void closeOutput () raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::BufferSizeExceededException, com::sun::star::io::IOException)
 gets called to indicate that all data has been written. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XInputStream
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)
 reads the specified number of bytes in the given sequence. More...
 
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 )
 reads the available number of bytes, at maximum nMaxBytesToRead. More...
 
void skipBytes ([in] long nBytesToSkip) raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::BufferSizeExceededException, com::sun::star::io::IOException )
 skips the next nBytesToSkip bytes (must be positive). More...
 
long available () raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::IOException )
 states how many bytes can be read or skipped without blocking. More...
 
void closeInput () raises ( com::sun::star::io::NotConnectedException, com::sun::star::io::IOException)
 closes the stream. More...
 

Detailed Description

the implementation of an output stream and an input stream.

All data written through the outputstream is buffered until it is read again from the input stream. Often two different threads access input and outputstream.

With the pipe-service, an outputstream can be converted into an input stream at the cost of an additional buffer.


The documentation for this service was generated from the following file: