org.arl.fjage.remote

Class Tunnel

java.lang.Object

org.arl.fjage.Agent

org.arl.fjage.remote.Tunnel

All Implemented Interfaces:

java.lang.Runnable, ConnectionListener, MessageListener, Messenger, TimestampProvider

public class Tunnel
extends Agent
implements ConnectionListener, MessageListener

An agent that serves as a tunnel for messages between two fjage platforms.

A tunnel can be configured as a server or a client. A server tunnel listens on a specified TCP port for incoming connections from client tunnels. A client tunnel connects to a server tunnel at a specified IP address and TCP port.

Once a connection is established, the tunnel agent forwards selected messages between the two platforms. The agents parameter specifies the list of remote agents or topics forwarded through the tunnel.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	__doc__
protected java.util.List<AgentID>	agents
protected java.util.List<Connector>	connectors
protected int	connID Monotonically increasing connection id counter.
protected java.util.Map<java.lang.Integer,Connector>	connIDs Map of connection id to Connector.
protected java.lang.String	ip
protected static long	MONITOR_PERIOD
protected int	port
protected java.util.concurrent.ExecutorService	readExecutor
protected TcpServer	server
protected java.util.concurrent.ExecutorService	writeExecutor

Fields inherited from class org.arl.fjage.Agent

ALL, BLOCKING, FINE, FINER, FINEST, ignoreExceptions, INFO, log, NON_BLOCKING, OFF, SEVERE, thread, tid, WARNING

Constructor Summary

Constructors

Constructor and Description
Tunnel(int port)
Tunnel(java.lang.String ip, int port)

Method Summary

Modifier and Type	Method and Description
protected void	connect()
void	connected(Connector connector)
java.util.List<AgentID>	getAgents() Get the list of remote agents or topics visible through the tunnel.
java.util.Map<java.lang.Integer,java.lang.String>	getConnIDs() Get the list of currently connected connection IDs.
java.lang.String	getDescription() Get description of the tunnel agent.
java.lang.String	getIp() Get IP address for the tunnel.
int	getPort() Get TCP port number for the tunnel.
java.lang.String	getTitle() Get title of the tunnel agent.
void	init() Called by the container when the agent is started.
protected void	monitor(int id, Connector c)
boolean	onReceive(Message msg) This method is called for each message to be conveyed to the listener.
protected void	removeConnector(Connector c)
protected void	sendToRemote(Connector c, byte[] data)
void	setAgents(java.util.List<AgentID> agents) Set the list of remote agents or topics visible through the tunnel.
void	shutdown() Called by the container when the agent is terminated.

Methods inherited from class org.arl.fjage.Agent

add, agent, agentForService, agentForService, agentsForService, agentsForService, block, block, clone, currentTimeMillis, delay, deregister, deregister, die, getAgentID, getContainer, getName, getPlatform, getState, getStore, getType, getYieldDuringReceive, nanoTime, platformSend, prepareRequest, println, receive, receive, receive, receive, receive, receive, receive, receive, register, register, request, request, run, send, setLogLevel, setQueueSize, setYieldDuringReceive, stop, subscribe, topic, topic, topic, topic, topic, topic, toString, unsubscribe, wake

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MONITOR_PERIOD

protected static final long MONITOR_PERIOD

See Also:

Constant Field Values

ip

protected java.lang.String ip

port

protected int port

server

protected TcpServer server

agents

protected final java.util.List<AgentID> agents

connectors

protected final java.util.List<Connector> connectors

writeExecutor

protected java.util.concurrent.ExecutorService writeExecutor

readExecutor

protected java.util.concurrent.ExecutorService readExecutor

connID

protected int connID

Monotonically increasing connection id counter.

connIDs

protected java.util.Map<java.lang.Integer,Connector> connIDs

Map of connection id to Connector. connIDs parameter exposes the keys of this map as a read-only snapshot.

__doc__

public static final java.lang.String __doc__

See Also:

Constant Field Values

Constructor Detail

Tunnel

public Tunnel(int port)

Tunnel

public Tunnel(java.lang.String ip,
              int port)

Method Detail

init

public void init()

Description copied from class: Agent

Called by the container when the agent is started. This method is usually overridden by a class implementing an agent to initialize the agent and its behaviors.

Overrides:

init in class Agent

shutdown

public void shutdown()

Description copied from class: Agent

Called by the container when the agent is terminated. This method may optionally be overridden to provide a clean up before termination.

Overrides:

shutdown in class Agent

connected

public void connected(Connector connector)

Specified by:

connected in interface ConnectionListener

connect

protected void connect()

onReceive

public boolean onReceive(Message msg)

Description copied from interface: MessageListener

This method is called for each message to be conveyed to the listener.

If this method returns true, the message is assumed to be consumed and is immediately discarded.

Specified by:

onReceive in interface MessageListener

Parameters:

msg - received message.

Returns:

true if the message is consumed, false otherwise.

monitor

protected void monitor(int id,
                       Connector c)

sendToRemote

protected void sendToRemote(Connector c,
                            byte[] data)

removeConnector

protected void removeConnector(Connector c)

getConnIDs

public java.util.Map<java.lang.Integer,java.lang.String> getConnIDs()

Get the list of currently connected connection IDs.

Returns:

Map of connectionID to a string which is the IP:port of the remote end of the connection.

getIp

public java.lang.String getIp()

Get IP address for the tunnel. In case of a client tunnel, this is the IP address of the server to connect to. In case of a server tunnel, this is set to null.

Returns:

IP address for the tunnel, or null if this is a server tunnel.

getPort

public int getPort()

Get TCP port number for the tunnel. In case of a client tunnel, this is the TCP port number of the server to connect to. In case of a server tunnel, this is the TCP port number to listen on for incoming client connections.

Returns:

TCP port number for the tunnel.

getAgents

public java.util.List<AgentID> getAgents()

Get the list of remote agents or topics visible through the tunnel.

Returns:

List of remote agents/topics visible through the tunnel.

setAgents

public void setAgents(java.util.List<AgentID> agents)

Set the list of remote agents or topics visible through the tunnel.

Parameters:

agents - List of remote agents/topics visible through the tunnel.

getTitle

public java.lang.String getTitle()

Get title of the tunnel agent.

Returns:

title.

getDescription

public java.lang.String getDescription()

Get description of the tunnel agent.

Returns:

description.