info.pppc.base.plugin.ip

Class MxIPProactiveRouting

java.lang.Object

info.pppc.base.plugin.common.ProactiveRouting

info.pppc.base.plugin.ip.MxIPProactiveRouting

All Implemented Interfaces:

IMultiplexPlugin, IListener, IExtension, IOperation, IDispatcher, IPlugin, IRouting, IStreamer

public class MxIPProactiveRouting
extends ProactiveRouting
implements IMultiplexPlugin

The mx ip proactive routing plug-in implements proactive routing with ip-based gateway functionality. This version of the plug-in is simplified in that it only connects through the router but does not try to connect directly to a remote device.

Author:

Mac

Field Summary

Fields

Modifier and Type	Field and Description
static long	CONNECT_RETRY The retry interval in milliseconds.
static byte[]	ROUTER_ADDRESS Default router address.
static short	ROUTER_PORT Default router port.
static long	TIMEOUT_CONNECT The maximum amount of time that the plug-in will try to open a direct connection to a remote system.
static long	TIMEOUT_RECONNECT The timeout after which the plug-in will attempt to reestablish direct connections to a client that is known to not support direct connections due to a previous attempt.

Fields inherited from class info.pppc.base.plugin.common.ProactiveRouting

MAXIMUM_HOPS, PLUGIN_ABILITY, PROPERTY_GATEWAY, PROPERTY_NEIGHBORS, PROPERTY_SYSTEM

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
MxIPProactiveRouting(boolean retransmit) Creates a new gateway that binds at any local address and that uses the default router configuration.
MxIPProactiveRouting(boolean retransmit, byte[] routerAddress, short routerPort) Creates a new gateway that uses the specified router configuration.
MxIPProactiveRouting(boolean retransmit, java.lang.String fileName) Creates a new gateway that uses the router configuration specified in a configuration file.

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptConnector(MultiplexFactory source, IStreamConnector connector) Called whenever the router is used to connect to the gateway plugin.
void	closeMultiplexer(MultiplexFactory multiplexer) Called whenever the multiplexer is closed.
void	deliverIncoming(IStreamConnector connector, ISession session) Called when a remote device connects through a local plugin.
IPluginManager	getPluginManager() Returns the plug-in manager.
IStreamConnector	openSession(ISession session) Called to open a connection using the specified session.
void	start() Called to start the plug-in.
void	stop() Called to stop the plug-in.

Methods inherited from class info.pppc.base.plugin.common.ProactiveRouting

getPluginDescription, handleEvent, perform, prepareSession, setFilter, setRoutingManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.pppc.base.system.plugin.IPlugin

getPluginDescription

Field Detail

ROUTER_ADDRESS

public static final byte[] ROUTER_ADDRESS

Default router address.

ROUTER_PORT

public static final short ROUTER_PORT

Default router port.

See Also:

Constant Field Values

CONNECT_RETRY

public static final long CONNECT_RETRY

The retry interval in milliseconds. This is the pause interval between connection attempts to the gateway server.

See Also:

Constant Field Values

TIMEOUT_CONNECT

public static final long TIMEOUT_CONNECT

The maximum amount of time that the plug-in will try to open a direct connection to a remote system. Once the timeout has passed, the system will create an indirect connection via the gateway.

See Also:

Constant Field Values

TIMEOUT_RECONNECT

public static final long TIMEOUT_RECONNECT

The timeout after which the plug-in will attempt to reestablish direct connections to a client that is known to not support direct connections due to a previous attempt.

See Also:

Constant Field Values

Constructor Detail

MxIPProactiveRouting

public MxIPProactiveRouting(boolean retransmit)

Creates a new gateway that binds at any local address and that uses the default router configuration.

Parameters:

retransmit - Determines whether packets are retransmitted over the same plug-in.

MxIPProactiveRouting

public MxIPProactiveRouting(boolean retransmit,
                    byte[] routerAddress,
                    short routerPort)

Creates a new gateway that uses the specified router configuration.

Parameters:

retransmit - Determines whether packets are retransmitted over the same plug-in.

routerAddress - The ip address of the router.

routerPort - The port number of the router.

MxIPProactiveRouting

public MxIPProactiveRouting(boolean retransmit,
                    java.lang.String fileName)

Creates a new gateway that uses the router configuration specified in a configuration file.

Parameters:

retransmit - Determines whether packets are retransmitted over the same plug-in.

fileName - Name of the configuration file.

Method Detail

openSession

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

Called to open a connection using the specified session. This method first determines whether the connection can be established locally. If not, the remote gateway server is used.

Specified by:

openSession in interface IStreamer

Overrides:

openSession in class ProactiveRouting

Parameters:

session - The session that defines the target.

Returns:

The stream connector to connect to the target.

Throws:

java.io.IOException - Thrown if the connection cannot be established.

deliverIncoming

public void deliverIncoming(IStreamConnector connector,
                   ISession session)

Called when a remote device connects through a local plugin. The method decides whether the incoming request is delivered locally, forwarded locally or transfered through the router.

Specified by:

deliverIncoming in interface IDispatcher

Overrides:

deliverIncoming in class ProactiveRouting

Parameters:

connector - The connector that is bound to the incomming communication.

session - The session object for the communication.

acceptConnector

public void acceptConnector(MultiplexFactory source,
                   IStreamConnector connector)

Called whenever the router is used to connect to the gateway plugin. This will only happen in non-server mode.

Specified by:

acceptConnector in interface IMultiplexPlugin

Parameters:

source - The source factory which is simply the factory connecting to the router.

connector - The connector created by the factory.

closeMultiplexer

public void closeMultiplexer(MultiplexFactory multiplexer)

Called whenever the multiplexer is closed.

Specified by:

closeMultiplexer in interface IMultiplexPlugin

Parameters:

multiplexer - The multiplexer that has been closed.

start

public void start()

Called to start the plug-in.

Specified by:

start in interface IPlugin

Overrides:

start in class ProactiveRouting

stop

public void stop()

Called to stop the plug-in.

Specified by:

stop in interface IPlugin

Overrides:

stop in class ProactiveRouting

getPluginManager

public IPluginManager getPluginManager()

Returns the plug-in manager.

Specified by:

getPluginManager in interface IMultiplexPlugin

Returns:

The plug-in manager.