org.lsst.ccs.messaging

Class AgentPresenceManager

java.lang.Object

org.lsst.ccs.messaging.AgentPresenceManager

All Implemented Interfaces:

MessageListener, StatusMessageListener

public class AgentPresenceManager
extends Object
implements StatusMessageListener

Tracks agent connection and disconnection on the buses.

Author:

emarin

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.lsst.ccs.utilities.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
AgentPresenceManager()

Method Summary

Modifier and Type	Method and Description
void	addAgentPresenceListener(AgentPresenceListener l)
boolean	agentExists(String agentName)
List<AgentInfo>	listConnectedAgents()
void	onStatusMessage(StatusMessage s) Called when a status message is received.
void	removeAgentPresenceListener(AgentPresenceListener l)
boolean	waitForAgent(String name, long timeout, TimeUnit unit) Wait for an Agent to be available on the buses.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.lsst.ccs.utilities.logging.Logger log

Constructor Detail

AgentPresenceManager

public AgentPresenceManager()

Method Detail

onStatusMessage

public void onStatusMessage(StatusMessage s)

Description copied from interface: StatusMessageListener

Called when a status message is received. The implementation should be thread-safe: the framework makes no guarantees on what thread this method will be called on, and it can be called concurrently for several messages. The implementation should also return immediately : any blocking operations should be scheduled on a separate thread.

Specified by:

onStatusMessage in interface StatusMessageListener

Parameters:

s - Status bus message to be processed.

listConnectedAgents

public List<AgentInfo> listConnectedAgents()

Returns:

The list with the currently connected Agents

addAgentPresenceListener

public void addAgentPresenceListener(AgentPresenceListener l)

removeAgentPresenceListener

public void removeAgentPresenceListener(AgentPresenceListener l)

agentExists

public boolean agentExists(String agentName)

waitForAgent

public final boolean waitForAgent(String name,
                                  long timeout,
                                  TimeUnit unit)
                           throws InterruptedException

Wait for an Agent to be available on the buses.

Parameters:

name - The name of the Agent

timeout - The time to wait for the agent to become available.

unit - The TimeUnit for the timeout.

Returns:

True if the Agent is available within the provided timeout, false otherwise.

Throws:

InterruptedException