org.lsst.ccs.messaging

Interface AgentPresenceListener

All Known Implementing Classes:

AgentLockService, AgentStatusAggregatorService, ConfigurationService, StateBundleAggregator

public interface AgentPresenceListener

Agents that implement this interface are notified when an agent is connecting or has disconnected on the status bus

Author:

emarin

Method Summary

Modifier and Type	Method and Description
default void	connected(AgentInfo... agents) Indicates that the list of agents represented by agents is present on the buses.
default void	connecting(AgentInfo... agents) Indicates that the list of agents represented by agents is present on the buses.
default void	connecting(AgentInfo agent) Deprecated. user connecting(AgentInfo...) instead.
default void	disconnecting(AgentInfo agent) Indicates that the agent represented by agent has left the buses.

Method Detail

connecting

@Deprecated
default void connecting(AgentInfo agent)

Deprecated. user connecting(AgentInfo...) instead.

Indicates that the agent represented by agent is present on the buses. This method is called when the first messages for a given agent is received. In the case of an agent starting up the fist messages is sent when the agent is in PhaseState::INITIALIZING state. At this point not all services are guaranteed to have completely started. This method should be used only to receive a notification that an agent is connecting. For a guarantee that an agent information is fully present, please use the #connected methods. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Parameters:

agent -

connecting

default void connecting(AgentInfo... agents)

Indicates that the list of agents represented by agents is present on the buses. This method is invoked when the listener is added with all the agents that are already connected. At this point not all services on the connecting agents are guaranteed to have completely started. This method should be used only to receive a notification that an agent is connecting. For a guarantee that an agent information is fully present, please use the #connected methods. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Parameters:

agents -

disconnecting

default void disconnecting(AgentInfo agent)

Indicates that the agent represented by agent has left the buses. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Parameters:

agent -

connected

default void connected(AgentInfo... agents)

Indicates that the list of agents represented by agents is present on the buses. This method is invoked when the listener is added with all the agents that are already connected. When this method is invoked the agent is in PhaseState::OPERATIONAL state and all its services are guaranteed to have been properly initialized. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

Parameters:

agents -