info.pppc.base.plugin.ip

Class IPMulticastTransceiver

java.lang.Object

info.pppc.base.plugin.ip.IPMulticastTransceiver

All Implemented Interfaces:

IIPPlugin, IExtension, IOperation, IPlugin, IStreamer, ITransceiver

Direct Known Subclasses:

MxIPMulticastTransceiver

public class IPMulticastTransceiver
extends java.lang.Object
implements IIPPlugin, ITransceiver, IOperation

The ip multicast transceiver plug-in delivers a transport end point based on ip. Broadcast channels are implemented with multicast sockets and unicast channels rely on tcp. The implementation of this plug-in is intended for all J2ME configurations starting from CDC with foundation profile.

Author:

Marcus Handte

Field Summary

Fields inherited from interface info.pppc.base.system.plugin.ITransceiver

EVENT_TRANCEIVER_DISABLED, EVENT_TRANCEIVER_ENABLED

Fields inherited from interface info.pppc.base.system.IExtension

EXTENSION_COMPRESSION, EXTENSION_DISCOVERY, EXTENSION_ENCRYPTION, EXTENSION_ROUTING, EXTENSION_SEMANTIC, EXTENSION_SERIALIZATION, EXTENSION_TRANSCEIVER

Constructor Summary

Constructors

Constructor and Description
IPMulticastTransceiver() Creates a new instance of the plug-in that binds to any ip address and port number that is available on the local system.
IPMulticastTransceiver(boolean nodelay) Creates a new instance of the plug-in that binds to any ip address and port number that is available on the local system.
IPMulticastTransceiver(byte[] address) Creates a new instance of the plug-in that binds only to the specified ip address.
IPMulticastTransceiver(byte[] address, boolean nodelay) Creates a new instance of the plug-in that binds only to the specified ip address.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTransceiverListener(int type, IListener listener) Adds a listener to the bundle of registered end point listeners.
byte[]	getAddress() Returns the address of the server socket.
PluginDescription	getPluginDescription() Returns the description of the plug-in.
int	getPort() Returns the port of the server socket.
boolean	isEnabled() Determines whether the end point provided by the plug-in is enabled.
IPacketConnector	openGroup() Opens a connector that connects to the group.
IStreamConnector	openSession(ISession session) Opens a connection to the specified system.
void	perform(IMonitor monitor) Called when the operation is started.
boolean	prepareSession(PluginDescription description, NFCollection collection, ISession session) Called in order to prepare a session.
void	release(IPPacketConnector connector) Releases the specified connector by removing it from the list of open connectors.
void	release(IPStreamConnector connector) Releases the specified connector by removing it from the list of open connectors.
boolean	removeTransceiverListener(int type, IListener listener) Removes a potentially previously registered end point listener for a certain type of event.
void	setAddress(byte[] address) Sets the address of the server socket.
void	setEnabled(boolean enabled) Enables or disables the end point provided by the plug-in and notifies all listeners if the state has changed.
void	setTransceiverManager(ITransceiverManager manager) Called by the plug-in manager during initialization of the plug-in.
void	start() Called by the plug-in manager to start the stopped plug-in.
void	stop() Called by the plug-in manager to stop the started plug-in.

Methods inherited from class java.lang.Object

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

Constructor Detail

IPMulticastTransceiver

public IPMulticastTransceiver()

Creates a new instance of the plug-in that binds to any ip address and port number that is available on the local system. This instance will use the tcp no delay socket option.

IPMulticastTransceiver

public IPMulticastTransceiver(boolean nodelay)

Creates a new instance of the plug-in that binds to any ip address and port number that is available on the local system.

Parameters:

nodelay - A flag that indicates whether the tcp no delay socket option will be set.

IPMulticastTransceiver

public IPMulticastTransceiver(byte[] address)

Creates a new instance of the plug-in that binds only to the specified ip address. Note that the bytes are interpreted in 2 complement. The first byte is the most significant.

Parameters:

address - The ip address to bind to or null to bind to any address.

Throws:

java.lang.IllegalArgumentException - Thrown if the address does not indicate a valid ip address or if the address is part of the filter list.

IPMulticastTransceiver

public IPMulticastTransceiver(byte[] address,
                      boolean nodelay)

Creates a new instance of the plug-in that binds only to the specified ip address. Note that the bytes are interpreted in 2 complement. The first byte is the most significant.

Parameters:

address - The ip address to bind to or null to bind to any address.

nodelay - A flag that indicates whether the tcp no delay socket option will be set.

Throws:

java.lang.IllegalArgumentException - Thrown if the address does not indicate a valid ip address or if the address is part of the filter list.

Method Detail

setTransceiverManager

public void setTransceiverManager(ITransceiverManager manager)

Called by the plug-in manager during initialization of the plug-in. A call to this method will overwrite the currently stored reference to a potentially already initialized manager. This should not be a problem except if the same plug-in instance is installed twice.

Specified by:

setTransceiverManager in interface ITransceiver

Parameters:

manager - The manager of the plug-in used to interface with other plug-ins and to retrieve connection parameters.

perform

public void perform(IMonitor monitor)
             throws java.lang.Exception

Called when the operation is started. The operation opens a server socket on an interface and continuously listens to it for incoming connections. If a connection is created, it dispatches it is dispatched current plug-in manager. The monitor is checked every TIMEOUT_PERIOD milliseconds. If the monitor is canceled, the operation is finished.

Specified by:

perform in interface IOperation

Parameters:

monitor - The monitor that is used to signal changes.

Throws:

java.lang.Exception - Should never happen.

prepareSession

public boolean prepareSession(PluginDescription description,
                     NFCollection collection,
                     ISession session)

Called in order to prepare a session. Updates the session with local attributes regarding the address and port of the remote system.

Specified by:

prepareSession in interface IStreamer

Parameters:

description - The description of the remote system.

collection - The requirements regarding the communication.

session - The session that holds the attributes.

Returns:

True if the session can be established, false if the port or the address are not set.

openSession

public IStreamConnector openSession(ISession session)
                             throws java.io.IOException

Opens a connection to the specified system. A call to this method will first determine whether it is possible to open a connection. If it is not possible due to the state of the plug-in (e.g., if it is disabled) an exception will be thrown.

Specified by:

openSession in interface IStreamer

Parameters:

session - The session data that has been prepared by the prepare method.

Returns:

The connector for the session.

Throws:

java.io.IOException - Thrown if the connector cannot be opened.

openGroup

public IPacketConnector openGroup()
                           throws java.io.IOException

Opens a connector that connects to the group. A call to this method will first determine whether it is possible to open a connection. If it is not possible due to the state of the plug-in (e.g., if it is disabled) an exception will be thrown.

Specified by:

openGroup in interface ITransceiver

Returns:

The connector for the group.

Throws:

java.io.IOException - Thrown if the connector cannot be opened.

start

public void start()

Called by the plug-in manager to start the stopped plug-in. A call to this method will enable the end point in such a way that it will enable incoming and outgoing connections.

Specified by:

start in interface IPlugin

stop

public void stop()

Called by the plug-in manager to stop the started plug-in. A call to this method will automatically close all incoming and outgoing connections and it will disable the end point.

Specified by:

stop in interface IPlugin

getPluginDescription

public PluginDescription getPluginDescription()

Returns the description of the plug-in.

Specified by:

getPluginDescription in interface IPlugin

Returns:

The plugin's description.

addTransceiverListener

public void addTransceiverListener(int type,
                          IListener listener)
                            throws java.lang.NullPointerException

Adds a listener to the bundle of registered end point listeners. The properly registered listeners will be informed if the state of the end point changes.

Specified by:

addTransceiverListener in interface ITransceiver

Parameters:

type - The type of event to register for.

listener - The listener to register.

Throws:

java.lang.NullPointerException - Thrown if the listener is null.

removeTransceiverListener

public boolean removeTransceiverListener(int type,
                                IListener listener)
                                  throws java.lang.NullPointerException

Removes a potentially previously registered end point listener for a certain type of event.

Specified by:

removeTransceiverListener in interface ITransceiver

Parameters:

type - The type to unregister from.

listener - The listener to unregister.

Returns:

True if the listener is no longer registered, false if the listener has not been registered.

Throws:

java.lang.NullPointerException - Thrown if the listener is null.

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the end point provided by the plug-in and notifies all listeners if the state has changed.

Specified by:

setEnabled in interface ITransceiver

Parameters:

enabled - Set true to enable and false to disable.

isEnabled

public boolean isEnabled()

Determines whether the end point provided by the plug-in is enabled.

Specified by:

isEnabled in interface ITransceiver

Returns:

True if the end point provided by the plug-in is enabled, false otherwise.

getAddress

public byte[] getAddress()

Returns the address of the server socket.

Returns:

The address of the server socket.

setAddress

public void setAddress(byte[] address)

Sets the address of the server socket. This method must not be called while the plug-in is enabled.

Parameters:

address - The new address.

getPort

public int getPort()

Returns the port of the server socket.

Returns:

The port of the server socket.

release

public void release(IPStreamConnector connector)

Releases the specified connector by removing it from the list of open connectors.

Specified by:

release in interface IIPPlugin

Parameters:

connector - The connector to remove from the list of connectors.

release

public void release(IPPacketConnector connector)

Releases the specified connector by removing it from the list of open connectors.

Specified by:

release in interface IIPPlugin

Parameters:

connector - The connector to remove from the list of connectors.