org.iids.aos.systemservices.communicator.structs
Class AgentInfo

java.lang.Object
  org.iids.aos.systemservices.communicator.structs.AgentInfo

All Implemented Interfaces:

java.io.Serializable

public class AgentInfo
extends java.lang.Object
implements java.io.Serializable

Information structure for agents. Usually returned by createAgent, to notify the creator of which handles are assigned to the agent. Helps to not confuse owner and primary handles of the agent.

Author:

rjtimmer

See Also:

Serialized Form

Constructor Summary

AgentInfo(AgentHandle owner, AgentHandle primary)
Create a new AgentInfo with the given handles.

Method Summary

AgentHandle	getOwnerHandle() Retrieve the owner handle for this agent.
AgentHandle	getPrimaryHandle() Retrieve the primary handle for this agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentInfo

public AgentInfo(AgentHandle owner,
                 AgentHandle primary)

Create a new AgentInfo with the given handles.

Parameters:

owner -

primary -

Method Detail

getOwnerHandle

public AgentHandle getOwnerHandle()

Retrieve the owner handle for this agent. This handle is used for the application that created the agent to communicate with the agent. It can read messages from the owner handle, and send messages to the agents primary handle. The agent can send messages to its owner by addressing envelopes to this owner handle.

Returns:

The owner handle from the info struct.

getPrimaryHandle

public AgentHandle getPrimaryHandle()

Retrieve the primary handle for this agent. This handle is the only handle the agent initially receives.

Returns:

The priamry handle from the info struct.