com.sun.star.lib.connections.pipe

Class PipeConnection

java.lang.Object

com.sun.star.lib.connections.pipe.PipeConnection

public class PipeConnection
extends java.lang.Object

The PipeConnection implements the XConnection interface and is uses by the PipeConnector and the PipeAcceptor. This class is not part of the provided api.

Since:

UDK1.0

See Also:

com.sun.star.comp.connections.PipeAcceptor, com.sun.star.comp.connections.PipeConnector, com.sun.star.connections.XConnection

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_aDescription
protected java.util.Vector	_aListeners
protected boolean	_bFirstRead
protected long	_nPipeHandle
static boolean	DEBUG When set to true, enables various debugging output.

Constructor Summary

Constructors

Constructor and Description
PipeConnection(java.lang.String description) Constructs a new PipeConnection.

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

_aDescription

protected java.lang.String _aDescription

_nPipeHandle

protected long _nPipeHandle

_aListeners

protected java.util.Vector _aListeners

_bFirstRead

protected boolean _bFirstRead

Constructor Detail

PipeConnection

public PipeConnection(java.lang.String description)
               throws java.io.IOException

Constructs a new PipeConnection.

Parameters:

description - the description of the connection

pipe - the pipe 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