org.arl.fjage.remote

Class SlaveContainer

java.lang.Object

org.arl.fjage.Container

org.arl.fjage.remote.SlaveContainer

public class SlaveContainer
extends Container

Slave container attached to a master container. Agents in linked master and slave containers function as if they were in the same container, i.e., are able to communicate with each other through messaging, topics and directory services.

Field Summary

Fields inherited from class org.arl.fjage.Container

agents, agentsToAdd, autoclone, cloner, doClone, FAST_CLONER, idle, inited, initing, listeners, log, name, platform, running, SERIAL_CLONER, services, topics

Constructor Summary

Constructors

Constructor and Description
SlaveContainer(Platform platform, java.lang.String hostname, int port) Creates a slave container connecting over a TCP socket.
SlaveContainer(Platform platform, java.lang.String devname, int baud, java.lang.String settings) Creates a slave container connecting over a RS232 port.
SlaveContainer(Platform platform, java.lang.String name, java.lang.String hostname, int port) Creates a named slave container connecting over a TCP socket.
SlaveContainer(Platform platform, java.lang.String name, java.lang.String devname, int baud, java.lang.String settings) Creates a named slave container connecting over a RS232 port.

Method Summary

Modifier and Type	Method and Description
AgentID	add(java.lang.String name, Agent agent) Adds an agent to the container.
AgentID	agentForService(java.lang.String service) Finds an agent providing a named service.
AgentID[]	agentsForService(java.lang.String service) Finds all agents providing a named service.
boolean	authenticate(java.lang.String creds) Authenticate to master container.
void	checkAuthFailure(java.lang.String id) Checks for authentication failure on send.
void	connectionClosed(ConnectionHandler handler) Callback for closure of connection to remote container.
AgentID[]	getAgents() Gets all agent ids in the container.
java.lang.String[]	getServices() Gets a list of all services that agents in this container provide.
java.lang.String	getState() Gets human readble state information for container.
protected void	initComplete() Called when the container is initialized.
protected boolean	isDuplicate(AgentID aid) Checks if an agent id already exists in the container.
boolean	kill(AgentID aid) Terminates an agent.
boolean	send(Message m) Sends a message.
boolean	send(Message m, boolean relay) Sends a message.
void	shutdown() Terminates the container and all agents in it.
protected void	start() Starts the container and all agents in it.
boolean	subscribe(AgentID aid, AgentID topic) Subscribes an agent to messages sent to a topic.
java.lang.String	toString() Gets a string representation of the container.
void	unsubscribe(AgentID aid) Unsubscribes an agent from all topics.
boolean	unsubscribe(AgentID aid, AgentID topic) Unsubscribes an agent from a topic.

Methods inherited from class org.arl.fjage.Container

add, addListener, canLocateAgent, clone, containsAgent, deregister, deregister, getAgent, getAutoClone, getName, getPlatform, isIdle, isRunning, kill, register, removeListener, setAutoClone, setCloner, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SlaveContainer

public SlaveContainer(Platform platform,
                      java.lang.String hostname,
                      int port)

Creates a slave container connecting over a TCP socket.

Parameters:

platform - platform on which the container runs.

hostname - hostname of the master container.

port - port on which the master container's TCP server runs.

SlaveContainer

public SlaveContainer(Platform platform,
                      java.lang.String name,
                      java.lang.String hostname,
                      int port)

Creates a named slave container connecting over a TCP socket.

Parameters:

platform - platform on which the container runs.

name - name of the container.

hostname - hostname of the master container.

port - port on which the master container's TCP server runs.

SlaveContainer

public SlaveContainer(Platform platform,
                      java.lang.String devname,
                      int baud,
                      java.lang.String settings)

Creates a slave container connecting over a RS232 port.

Parameters:

platform - platform on which the container runs.

devname - device name of the RS232 port.

baud - baud rate for the RS232 port.

settings - RS232 settings (null for defaults, or "N81" for no parity, 8 bits, 1 stop bit).

SlaveContainer

public SlaveContainer(Platform platform,
                      java.lang.String name,
                      java.lang.String devname,
                      int baud,
                      java.lang.String settings)

Creates a named slave container connecting over a RS232 port. The RS232 port is assumed to be working with 8 data bits, 1 stop bit and no parity.

Parameters:

platform - platform on which the container runs.

name - name of the container.

devname - device name of the RS232 port.

baud - baud rate for the RS232 port.

settings - RS232 settings (null for defaults, or "N81" for no parity, 8 bits, 1 stop bit).

Method Detail

authenticate

public boolean authenticate(java.lang.String creds)

Authenticate to master container.

Parameters:

creds - credentials to authenticate with.

Returns:

true if authenticated, false otherwise.

checkAuthFailure

public void checkAuthFailure(java.lang.String id)

Checks for authentication failure on send.

INTERNAL USE ONLY.

isDuplicate

protected boolean isDuplicate(AgentID aid)

Description copied from class: Container

Checks if an agent id already exists in the container.

Overrides:

isDuplicate in class Container

Parameters:

aid - the agent id to check.

Returns:

true if it exists, false otherwise.

send

public boolean send(Message m)

Description copied from class: Container

Sends a message. The message is sent to the recipient specified in the message. In case of associated remote containers, the message is only delivered to agents in this container.

Overrides:

send in class Container

Parameters:

m - message to deliver

Returns:

true if delivered, false otherwise.

send

public boolean send(Message m,
                    boolean relay)

Description copied from class: Container

Sends a message. The message is sent to the recipient specified in the message.

Overrides:

send in class Container

Parameters:

m - message to deliver

relay - enable relaying to associated remote containers.

Returns:

true if delivered, false otherwise.

getAgents

public AgentID[] getAgents()

Description copied from class: Container

Gets all agent ids in the container.

Overrides:

getAgents in class Container

Returns:

an array of agent ids.

getServices

public java.lang.String[] getServices()

Description copied from class: Container

Gets a list of all services that agents in this container provide.

Overrides:

getServices in class Container

Returns:

an array of service names.

agentForService

public AgentID agentForService(java.lang.String service)

Description copied from class: Container

Finds an agent providing a named service.

Overrides:

agentForService in class Container

Parameters:

service - name of the service.

Returns:

agent id for service provider, null if none found.

agentsForService

public AgentID[] agentsForService(java.lang.String service)

Description copied from class: Container

Finds all agents providing a named service.

Overrides:

agentsForService in class Container

Parameters:

service - name of the service.

Returns:

an array of agent ids for service providers, null if none found.

initComplete

protected void initComplete()

Description copied from class: Container

Called when the container is initialized. This is called after all agents have been initialized.

Overrides:

initComplete in class Container

shutdown

public void shutdown()

Description copied from class: Container

Terminates the container and all agents in it.

Overrides:

shutdown in class Container

getState

public java.lang.String getState()

Description copied from class: Container

Gets human readble state information for container.

Overrides:

getState in class Container

Returns:

state string.

toString

public java.lang.String toString()

Description copied from class: Container

Gets a string representation of the container.

Overrides:

toString in class Container

Returns:

string representation of the container.

See Also:

Object.toString()

connectionClosed

public void connectionClosed(ConnectionHandler handler)

Callback for closure of connection to remote container.

Parameters:

handler - indicates the connection that is closed.

add

public AgentID add(java.lang.String name,
                   Agent agent)

Description copied from class: Container

Adds an agent to the container.

Agent names should only contain alphanumeric characters and underscores. The first character should not be a digit. Names with special characters such as '-', '.', '@', etc are considered reserved and should be avoided.

While agent names inconsistent with this guideline may not be rejected today, they may not work well on all platforms. In future, we may enforce this guideline more strictly.

Overrides:

add in class Container

Parameters:

name - name of the agent.

agent - the agent object.

Returns:

an agent id if successful, null on failure.

start

protected void start()

Description copied from class: Container

Starts the container and all agents in it. This should be called after init().

Overrides:

start in class Container

kill

public boolean kill(AgentID aid)

Description copied from class: Container

Terminates an agent.

Overrides:

kill in class Container

Parameters:

aid - id of agent to terminate.

Returns:

true if successful, false on failure.

subscribe

public boolean subscribe(AgentID aid,
                         AgentID topic)

Description copied from class: Container

Subscribes an agent to messages sent to a topic.

Overrides:

subscribe in class Container

Parameters:

aid - id of agent to subscribe.

topic - topic to subscribe to.

Returns:

true on success, false on failure.

unsubscribe

public boolean unsubscribe(AgentID aid,
                           AgentID topic)

Description copied from class: Container

Unsubscribes an agent from a topic.

Overrides:

unsubscribe in class Container

Parameters:

aid - id of agent to unsubscribe.

topic - topic to unsubscribe from.

Returns:

true on success, false on failure.

unsubscribe

public void unsubscribe(AgentID aid)

Description copied from class: Container

Unsubscribes an agent from all topics.

Overrides:

unsubscribe in class Container

Parameters:

aid - id of agent to unsubscribe.