info.pppc.base.plugin.common.util

Class MultiplexFactory

java.lang.Object

info.pppc.base.plugin.common.util.MultiplexFactory

public final class MultiplexFactory
extends java.lang.Object

The multiplexer enables the creation of an arbitrary number of stream and packet-based connectors using a single underlying input and output stream. The typical approach to use a multiplexer is to open the streams and to connect a multiplexer to both ends of the streams.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_PACKET_CLOSED The event constant that is used to signal that a packet connector has been closed.
static int	EVENT_PACKET_OPENED The event constant that is used to signal that a new packet connector has been created.
static int	EVENT_PACKET_RECEIVED The event constant that is used to signal that a new packet has been received.
static int	EVENT_STREAM_CLOSED The event constant that is used to signal that a stream connector has been closed.
static int	EVENT_STREAM_OPENED The event constant that is used to signal that a stream connector has been opened.
static int	EVENT_STREAM_RECEIVED The event constant that is used to signal that a stream connector has received some data.

Constructor Summary

Constructors

Constructor and Description
MultiplexFactory(IMultiplexPlugin plugin, java.io.InputStream input, java.io.OutputStream output) Creates a new multiplexer with the specified input and output stream.
MultiplexFactory(IMultiplexPlugin plugin, java.io.InputStream input, java.io.OutputStream output, boolean acknowledged) Creates a new multiplexer with the specified input and output stream.
MultiplexFactory(IMultiplexPlugin plugin, java.io.InputStream input, java.io.OutputStream output, boolean acknowledged, int size) Creates a new multiplexer with the specified input and output stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMultiplexListener(int types, IListener listener) Adds a multiplex listener to the set of registered listeners.
void	close() Closes the multiplexer and performs the necessary cleanup by shutting down the streams.
IStreamConnector	openConnector() Creates a new stream connector that is connected through a stream connector on the other end of the streams.
IPacketConnector	openConnector(short group) Creates a packet connector that is connected to the specified group.
boolean	removeMultiplexListener(int types, IListener listener) Removes a previously registered listener from the set of registered listeners.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_PACKET_OPENED

public static final int EVENT_PACKET_OPENED

The event constant that is used to signal that a new packet connector has been created. The source will be this multiplexer. The data object will be the packet connector that has been created.

See Also:

Constant Field Values

EVENT_PACKET_RECEIVED

public static final int EVENT_PACKET_RECEIVED

The event constant that is used to signal that a new packet has been received. The source will be this multiplexer. The data object will be the packet connector that has received a packet.

See Also:

Constant Field Values

EVENT_PACKET_CLOSED

public static final int EVENT_PACKET_CLOSED

The event constant that is used to signal that a packet connector has been closed. The source will be this multiplexer. The data object will be the packet connector that has been closed.

See Also:

Constant Field Values

EVENT_STREAM_OPENED

public static final int EVENT_STREAM_OPENED

The event constant that is used to signal that a stream connector has been opened. The source will be this multiplexer. The data object will be the connector that has been opened.

See Also:

Constant Field Values

EVENT_STREAM_RECEIVED

public static final int EVENT_STREAM_RECEIVED

The event constant that is used to signal that a stream connector has received some data. The source will be this multiplexer. The data object will be the connector that has received some data.

See Also:

Constant Field Values

EVENT_STREAM_CLOSED

public static final int EVENT_STREAM_CLOSED

The event constant that is used to signal that a stream connector has been closed. The source will be this multiplexer. The data object will be the connector that has been closed.

See Also:

Constant Field Values

Constructor Detail

MultiplexFactory

public MultiplexFactory(IMultiplexPlugin plugin,
                java.io.InputStream input,
                java.io.OutputStream output)

Creates a new multiplexer with the specified input and output stream. Note that at the other ends of the input and output stream, there must be another multiplexer. If this constructor is used, transmissions are not acknowledged.

Parameters:

plugin - The plug-in that uses the multiplexer. This plug-in will be issued as responsible plug-in whenever a connector is requested for its plug-in.

input - The input stream used by the multiplexer.

output - The output stream used by the multiplexer.

MultiplexFactory

public MultiplexFactory(IMultiplexPlugin plugin,
                java.io.InputStream input,
                java.io.OutputStream output,
                boolean acknowledged)

Creates a new multiplexer with the specified input and output stream. Note that at the other ends of the input and output stream, there must be another multiplexer. The acknowledged flag indicates whether each transmission must be acknowledged. Note that the multiplexers at both ends must be configured equally.

Parameters:

plugin - The plug-in that uses the multiplexer. This plug-in will be issued as responsible plug-in whenever a connector is requested for its plug-in.

input - The input stream used by the multiplexer.

output - The output stream used by the multiplexer.

acknowledged - A flag that enables a stop and wait protocol for application layer flow control on nokia series 60 mobile phones.

MultiplexFactory

public MultiplexFactory(IMultiplexPlugin plugin,
                java.io.InputStream input,
                java.io.OutputStream output,
                boolean acknowledged,
                int size)

Creates a new multiplexer with the specified input and output stream. Note that at the other ends of the input and output stream, there must be another multiplexer. The acknowledged flag indicates whether each transmission must be acknowledged. The size indicates the maximum data unit that will be transfered via the multiplexer at once. Together with the acknowledgement configuration, this enables flexible control over the buffer that is filled at most. Note that the multiplexers at both ends must be configured equally.

Parameters:

plugin - The plug-in that uses the multiplexer. This plug-in will be issued as responsible plug-in whenever a connector is requested for its plug-in.

input - The input stream used by the multiplexer.

output - The output stream used by the multiplexer.

acknowledged - A flag that enables a stop and wait protocol for application layer flow control on nokia series 60 mobile phones.

size - The size of the maximum data unit. Note that 10 additional bytes may be used due to the header sizes. This has been added for sun spots as they can only buffer 255 bytes reliably.

Method Detail

addMultiplexListener

public void addMultiplexListener(int types,
                        IListener listener)

Adds a multiplex listener to the set of registered listeners. Possible events are defined by the event constants of this interface.

Parameters:

types - The types of events to register for.

listener - The listener to register for.

removeMultiplexListener

public boolean removeMultiplexListener(int types,
                              IListener listener)

Removes a previously registered listener from the set of registered listeners. Possible events are defined by the event constants of this interface.

Parameters:

types - The types of events to unregister.

listener - The listener to unregister.

Returns:

True if the listener has been removed, false otherwise.

openConnector

public IPacketConnector openConnector(short group)
                               throws java.io.IOException

Creates a packet connector that is connected to the specified group. It is allowed to create an arbitrary number of packet connector that is connected to the same group. All registered packet connectors will receive all incoming packets.

Parameters:

group - The group that the packet connector should be in.

Returns:

A packet connector that is connected to the specified group.

Throws:

java.io.IOException - Thrown if the connector cannot be opened, this indicates that the streams are malfunctioning.

openConnector

public IStreamConnector openConnector()
                               throws java.io.IOException

Creates a new stream connector that is connected through a stream connector on the other end of the streams.

Returns:

The stream connector connected through the streams.

Throws:

java.io.IOException - Thrown if the connector cannot be opened, this indicates that the streams are malfunctioning or that the receiving end of the connector did not respond.

close

public void close()

Closes the multiplexer and performs the necessary cleanup by shutting down the streams. If the multiplexer still has issued connectors that are still referenced, all calls to the connectors will be interrupted and will throw an exception.