interface XConnection in module com::sun::star::connection::

(Global Index)

Syntax

interface XConnection : com::sun::star::uno::XInterface ;

Description

A bidirectional bytestream.

You should additionally implement XConnection2.

See also

XConnection2

Method Summary

read reads a requested number of bytes from the connection.

write writes the given bytesequence to the stream.

flush Empties all internal buffers.

close Immediately terminates any ongoing read or write calls. All subsequent read or write calls()

getDescription A unique string describing the connection.

Method Details



read

Syntax

long read (
sequence< byte > aReadBytes,
long nBytesToRead )
raises ( com::sun::star::io::IOException );

Description

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.

Returns

The read number of bytes. The return value and the length of the returned sequence must be identical.

Parameter nBytesToRead

The number of bytes to be read from the stream.

Throws

com::sun::star::io::IOException in case an error occurred during reading from the stream.

write

Syntax

void write (
sequence< byte > aData )
raises ( com::sun::star::io::IOException );

Description

writes the given bytesequence to the stream.

The method blocks until the whole sequence is written.

Throws

com::sun::star::io::IOException in case an error occurred during writing to the stream.

flush

Syntax

void flush ();
raises ( com::sun::star::io::IOException );

Description

Empties all internal buffers.


close

Syntax

void close ();
raises ( com::sun::star::io::IOException );

Description

Immediately terminates any ongoing read or write calls. All subsequent read or write calls()


getDescription

Syntax

string getDescription ();

Description

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".

Top of Page