com.sun.star.lib.connections.socket

Class SocketConnection

java.lang.Object

com.sun.star.lib.connections.socket.SocketConnection

public class SocketConnection
extends java.lang.Object

The SocketConnection implements the XConnection interface and is uses by the SocketConnector and the SocketAcceptor. This class is not part of the provided api.

Since:

UDK1.0

See Also:

com.sun.star.comp.connections.SocketAcceptor, com.sun.star.comp.connections.SocketConnector, com.sun.star.connections.XConnection

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_description
protected boolean	_firstRead
protected java.io.InputStream	_inputStream
protected java.util.Vector	_listeners
protected java.io.OutputStream	_outputStream
protected java.net.Socket	_socket
static boolean	DEBUG When set to true, enables various debugging output.

Constructor Summary

Constructors

Constructor and Description
SocketConnection(java.lang.String description, java.net.Socket socket) Constructs a new SocketConnection.

Method Summary

Modifier and Type	Method and Description
void	addStreamListener(XStreamListener aListener)
void	close() Closes the connection.
void	flush() Flushes the buffer.
java.lang.String	getDescription() Gives a description of the connection.
int	read(byte[][] bytes, int nBytesToRead) Read the required number of bytes.
void	removeStreamListener(XStreamListener aListener)
void	write(byte[] aData) Write bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

public static final boolean DEBUG

When set to true, enables various debugging output.

See Also:

Constant Field Values

_description

protected java.lang.String _description

_socket

protected java.net.Socket _socket

_inputStream

protected java.io.InputStream _inputStream

_outputStream

protected java.io.OutputStream _outputStream

_listeners

protected java.util.Vector _listeners

_firstRead

protected boolean _firstRead

Constructor Detail

SocketConnection

public SocketConnection(java.lang.String description,
                        java.net.Socket socket)
                 throws java.io.IOException

Constructs a new SocketConnection.

Parameters:

description - the description of the connection

socket - the socket of the connection

Throws:

java.io.IOException

Method Detail

addStreamListener

public void addStreamListener(XStreamListener aListener)
                       throws com.sun.star.uno.RuntimeException

Throws:

com.sun.star.uno.RuntimeException

removeStreamListener

public void removeStreamListener(XStreamListener aListener)
                          throws com.sun.star.uno.RuntimeException

Throws:

com.sun.star.uno.RuntimeException

read

public int read(byte[][] bytes,
                int nBytesToRead)
         throws com.sun.star.io.IOException,
                com.sun.star.uno.RuntimeException

Read the required number of bytes.

Parameters:

aReadBytes - the outparameter, where the bytes have to be placed

nBytesToRead - the number of bytes to read

Returns:

the number of bytes read

Throws:

com.sun.star.io.IOException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#read

write

public void write(byte[] aData)
           throws com.sun.star.io.IOException,
                  com.sun.star.uno.RuntimeException

Write bytes.

Parameters:

aData - the bytes to write

Throws:

com.sun.star.io.IOException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#write

flush

public void flush()
           throws com.sun.star.io.IOException,
                  com.sun.star.uno.RuntimeException

Flushes the buffer.

Throws:

com.sun.star.io.IOException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#flush

close

public void close()
           throws com.sun.star.io.IOException,
                  com.sun.star.uno.RuntimeException

Closes the connection.

Throws:

com.sun.star.io.IOException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#close

getDescription

public java.lang.String getDescription()
                                throws com.sun.star.uno.RuntimeException

Gives a description of the connection.

Returns:

the description

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#getDescription