|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
A bidirectional bytestream. More...
import "XConnection.idl";
Public Member Functions | |
| long | read ([out] sequence< byte > aReadBytes, [in] long nBytesToRead) raises ( com::sun::star::io::IOException ) |
| reads a requested number of bytes from the connection. | |
| void | write ([in] sequence< byte > aData) raises ( com::sun::star::io::IOException ) |
| writes the given bytesequence to the stream. | |
| void | flush () raises ( com::sun::star::io::IOException ) |
| Empties all internal buffers. | |
| void | close () raises ( com::sun::star::io::IOException ) |
| Immediately terminates any ongoing read or write calls. | |
| string | getDescription () |
| A unique string describing the connection. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
| void close | ( | ) | ||||
| raises | ( | com::sun::star::io::IOException ) | ||||
Immediately terminates any ongoing read or write calls.
All subsequent read or write calls()
| void flush | ( | ) | ||||
| raises | ( | com::sun::star::io::IOException ) | ||||
Empties all internal buffers.
| string getDescription | ( | ) |
A unique string describing the connection.
This string is different from the arguments to XConnection::accept() and XConnector::connect(). In general, the string contains an additional handle value. For example, "socket,host=localhost,port=2002,uniqueValue=2324".
| long read | ( | [out] sequence< byte > | aReadBytes, | |||
| [in] long | nBytesToRead ) | |||||
| raises | ( | com::sun::star::io::IOException ) | ||||
reads a requested number of bytes from the connection.
This method is blocking, meaning that it always returns a bytesequence with the requested number of bytes, unless it has reached end of file (which often means, that close() has been called).
please see also the readSomeBytes() method of XConnection2.
| aReadBytes | The buffer to receive the read bytes. |
| nBytesToRead | The number of bytes to be read from the stream. |
| com::sun::star::io::IOException | in case an error occurred during reading from the stream. |
| void write | ( | [in] sequence< byte > | aData | ) | ||
| raises | ( | com::sun::star::io::IOException ) | ||||
writes the given bytesequence to the stream.
The method blocks until the whole sequence is written.
| com::sun::star::io::IOException | in case an error occurred during writing to the stream. |