com.sun.star.comp.connections

Class PipedConnection

java.lang.Object

com.sun.star.comp.connections.PipedConnection

public class PipedConnection
extends java.lang.Object

The PipedConnection is a component that implements the XConnection Interface. It is useful for Thread communication in one Process.

Since:

UDK1.0

See Also:

com.sun.star.connections.XConnection, com.sun.star.loader.JavaLoader

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	__waitTime The amount of time in milliseconds, to wait to see check the buffers.
protected byte[]	_buffer
protected boolean	_closed
protected int	_in
protected PipedConnection	_otherSide
protected int	_out
static boolean	DEBUG When set to true, enables various debugging output.

Constructor Summary

Constructors

Constructor and Description
PipedConnection(java.lang.Object[] args) Constructs a new PipedConnection, sees if there is an other side, which it should be connected to.

Method Summary

Modifier and Type	Method and Description
static XSingleServiceFactory	__getServiceFactory(java.lang.String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey) Gives a factory for creating the service.
void	close() Closes the pipe.
void	flush() Flushes the buffer, notifies if necessary the other side that new data has arrived.
java.lang.String	getDescription() Gives a description of this pipe.
int	read(byte[][] aReadBytes, int nBytesToRead) Read the required number of bytes.
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

__waitTime

protected static final int __waitTime

The amount of time in milliseconds, to wait to see check the buffers.

See Also:

Constant Field Values

_buffer

protected byte[] _buffer

_in

protected int _in

_out

protected int _out

_closed

protected boolean _closed

_otherSide

protected PipedConnection _otherSide

Constructor Detail

PipedConnection

public PipedConnection(java.lang.Object[] args)
                throws com.sun.star.uno.RuntimeException

Constructs a new PipedConnection, sees if there is an other side, which it should be connected to.

Parameters:

args - Another side could be in index 0.

Throws:

com.sun.star.uno.RuntimeException

Method Detail

__getServiceFactory

public static XSingleServiceFactory __getServiceFactory(java.lang.String implName,
                                                        XMultiServiceFactory multiFactory,
                                                        XRegistryKey regKey)

Gives a factory for creating the service. This method is called by the JavaLoader

Parameters:

implName - the name of the implementation for which a service is desired

multiFactory - the service manager to be uses if needed

regKey - the registryKey

Returns:

returns a XSingleServiceFactory for creating the component

See Also:

JavaLoader

read

public int read(byte[][] aReadBytes,
                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, notifies if necessary the other side that new data has arrived.

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

Throws:

com.sun.star.io.IOException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#closed

getDescription

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

Gives a description of this pipe.

Returns:

the description

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.connections.XConnection#getDescription