org.cougaar.core.relay
Interface Relay

All Superinterfaces:

java.io.Serializable, UniqueObject

All Known Subinterfaces:

Relay.Source, Relay.Target

All Known Implementing Classes:

BlackboardAlertRelay, FreezeRelaySource, FreezeRelayTarget, InterAgentCondition, InterAgentOperatingMode, InterAgentOperatingModePolicy, SimpleRelaySource, SimpleRelayTarget

public interface Relay
extends UniqueObject

A Relay is a blackboard object that allows a source agent to stream content changes to multiple target agents, and for each target to stream back a response.

The Relay API is a intended to be a generic mechanism for transfering data between agents. Specific subclasses and clients may not need the full Relay features, such as multiple-targets or target-responses.

Nested Class Summary

static interface	Relay.Source The source-side Relay, which contains the content and a set of target-addresses, and also receives response updates from the Target(s).
static interface	Relay.Target The target-side Relay, which receives content updates and can send response updates back to the Source.
static interface	Relay.TargetFactory A factory for creating a Target from the Source's content.
static class	Relay.Token An object that is passed from the Source to the Target(s), which authorizes content updates.

Field Summary

static int	CONTENT_CHANGE
static int	NO_CHANGE
static int	RESPONSE_CHANGE

Method Summary

Methods inherited from interface org.cougaar.core.util.UniqueObject

getUID, setUID

Field Detail

NO_CHANGE

static final int NO_CHANGE

See Also:

Constant Field Values

CONTENT_CHANGE

static final int CONTENT_CHANGE

See Also:

Constant Field Values

RESPONSE_CHANGE

static final int RESPONSE_CHANGE

See Also:

Constant Field Values