UnetAgent (UnetStack 3.4.0 API)

org.arl.unet.UnetAgent

Underwater networking stack framework API agent. This class provides an agent superclass for all agents in UnetStack.

Field Summary

Fields
Modifiers	Name	Description
`protected long`	`timeout`	Timeout used in request messages.

Inherited fields
Fields inherited from class	Fields
`class Agent`	`NON_BLOCKING, BLOCKING`

Properties Summary

Properties
Type	Name and description
`Level`	`logLevel`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addCapability(Capability cap)` Adds capability the agent is capable of.
	`protected List<Parameter>`	`allOf(Class... paramEnumClasses)` Generate a list of parameters from a parameter enumeration.
	`boolean`	`deregister(String service)`
	`boolean`	`deregister(Enum<?> service)`
	`protected void`	`die(Throwable ex)`
	`protected Object`	`get(AgentID aid, Parameter param)` Requests value of parameter from another agent.
	`protected Object`	`get(AgentID aid, int index, Parameter param)` Requests value of indexed parameter from another agent.
	`protected String`	`getBuildInfo()` Gets the build string for a given class.
	`Level`	`getLogLevel()` Gets the current log level for the agent.
	`protected Object`	`getParam(Parameter p, int ndx)` Agents providing dynamic parameters may override this method to provide a value for a given parameter.
	`List<Class<Parameter>>`	`getParameterClasses()` Gets a list of parameter classes supported by this agent.
	`List<Class<Parameter>>`	`getParameterClasses(int index)` Gets a list of indexed parameter classes supported by this agent.
	`protected List<Parameter>`	`getParameterList()` An agent supporting parameters should return a list of parameters by overriding this method.
	`protected List<Parameter>`	`getParameterList(int index)` An agent supporting indexed parameters should return a list of indexed parameters by overriding this method.
	`String[]`	`getServices()` Gets a list of services provided by the agent.
	`String`	`getTitle()` Gets a descriptive name for the agent.
	`String`	`getVersion()` Gets a version string for the agent.
	`protected void`	`init()` Initialize the unet agent and its behaviors.
	`protected Boolean`	`isReadOnly(Parameter p, int ndx)` Agents providing dynamic parameters may override this method to specify whether a parameter is read-only or read-write.
	`protected Long`	`longValue(Object v)` Returns the value of any given object as a Long. null objects have a null value.
	`protected void`	`processMessage(Message msg)` An agent wishing to process all messages other than requests and queries may override this method to handle incoming messages.
	`protected Message`	`processQuery(Message msg)` An agent supporting queries should override this method to handle incoming queries.
	`protected Message`	`processRequest(Message msg)` An agent supporting requests should override this method to handle incoming requests.
	`boolean`	`register(String service)`
	`boolean`	`register(Enum<?> service)`
	`protected Object`	`set(AgentID aid, Parameter param, Object value)` Requests value of parameter to be changed in another agent.
	`protected Object`	`set(AgentID aid, int index, Parameter param, Object value)` Requests value of indexed parameter to be changed in another agent.
	`void`	`setLogLevel(Level lvl)` Sets the current log level for the agent.
	`protected Object`	`setParam(Parameter p, int ndx, Object v)` Agents providing dynamic parameters may override this method to set a value for a given parameter.
	`protected void`	`setup()` Called by UnetAgent when the agent is being initialized.
	`protected void`	`shutdown()`
	`protected void`	`startup()` Called by UnetAgent after all agents are fully initialized.
	`protected void`	`subscribeForService(String service)` Subscribe to all agents providing a specified service.
	`protected void`	`subscribeForService(Enum<?> service)` Subscribe to all agents providing a specified service.
	`protected Message`	`trace(Message msg)` Log event trace.
	`protected Message`	`trace(Message stimulus, Message response)` Log event trace.
	`protected Message`	`trace(Message stimulus, Message response, Object info)` Log event trace.
	`protected void`	`unsubscribeForService(String service)` Unsubscribe from all agents providing a specified service.
	`protected void`	`unsubscribeForService(Enum<?> service)` Unsubscribe from all agents providing a specified service.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Agent`	send, receive, receive, receive, receive, receive, receive, receive, receive, setLogLevel, getPlatform, request, request, getStore, subscribe, deregister, deregister, getContainer, println, run, add, toString, register, register, clone, currentTimeMillis, nanoTime, getName, stop, getState, getAgentID, prepareRequest, platformSend, setQueueSize, unsubscribe, agentForService, agentForService, agentsForService, agentsForService, topic, topic, topic, topic, topic, topic, agent, wake, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - protected long timeout
    
    Timeout used in request messages.
- Property Detail
  - Level logLevel
- Method Detail
  - protected void addCapability(Capability cap)
    
    Adds capability the agent is capable of.
    Parameters:
    cap - capability
  - @SuppressWarnings({ "unchecked", "rawtypes" }) protected List<Parameter> allOf(Class... paramEnumClasses)
    
    Generate a list of parameters from a parameter enumeration. This method is designed for agents to use in the getParameterList() method.
    Parameters:
    paramEnumClasses - enums representing the parameters.
    Returns:
    list of parameters.
  - @Override public boolean deregister(String service)
  - @Override public boolean deregister(Enum<?> service)
  - @Override protected void die(Throwable ex)
  - protected Object get(AgentID aid, Parameter param)
    
    Requests value of parameter from another agent.
    Parameters:
    aid - agent to request parameter from
    param - parameter to request
    Returns:
    value of parameter, null on error
  - protected Object get(AgentID aid, int index, Parameter param)
    
    Requests value of indexed parameter from another agent.
    Parameters:
    aid - agent to request parameter from
    index - index of parameter set
    param - parameter to request
    Returns:
    value of parameter, null on error
  - protected String getBuildInfo()
    
    Gets the build string for a given class. The build information is extracted from the jar is available.
    Returns:
    build information string if available, null otherwise.
  - public Level getLogLevel()
    
    Gets the current log level for the agent.
    Returns:
    log level.
  - protected Object getParam(Parameter p, int ndx)
    
    Agents providing dynamic parameters may override this method to provide a value for a given parameter.
    Parameters:
    p - parameter to get value.
    ndx - index for indexed parameters, -1 if non-indexed.
    Returns:
    value of the parameter.
  - @SuppressWarnings("unchecked") public List<Class<Parameter>> getParameterClasses()
    
    Gets a list of parameter classes supported by this agent.
    Returns:
    list of parameter classes, null if none supported.
  - @SuppressWarnings("unchecked") public List<Class<Parameter>> getParameterClasses(int index)
    
    Gets a list of indexed parameter classes supported by this agent.
    Parameters:
    index - index to list parameter classes.
    Returns:
    list of parameter classes, null if none supported.
  - protected List<Parameter> getParameterList()
    
    An agent supporting parameters should return a list of parameters by overriding this method.
    Returns:
    list of supported parameters, null if none supported.
  - protected List<Parameter> getParameterList(int index)
    
    An agent supporting indexed parameters should return a list of indexed parameters by overriding this method.
    Parameters:
    index - index to list parameters.
    Returns:
    list of supported indexed parameters, null if none supported.
  - public String[] getServices()
    
    Gets a list of services provided by the agent.
    Returns:
    list of services
  - public String getTitle()
    
    Gets a descriptive name for the agent.
    Returns:
    descriptive name
  - public String getVersion()
    
    Gets a version string for the agent.
    Returns:
    version information
  - @Override protected void init()
    
    Initialize the unet agent and its behaviors.
  - protected Boolean isReadOnly(Parameter p, int ndx)
    
    Agents providing dynamic parameters may override this method to specify whether a parameter is read-only or read-write.
    Parameters:
    p - parameter to get value.
    ndx - index for indexed parameters, -1 if non-indexed.
    Returns:
    true if parameter is read-only, false if read-write, null if not a dynamic parameter.
  - protected Long longValue(Object v)
    
    Returns the value of any given object as a Long. null objects have a null value. Numeric values are converted to the closest Long value. String values are parsed into Long. Booleans have a value of 1 if true, and 0 if false. Any other type of input value results in a null.
    Parameters:
    v - object to convert to Long.
    Returns:
    Long value.
  - protected void processMessage(Message msg)
    
    An agent wishing to process all messages other than requests and queries may override this method to handle incoming messages.
    Parameters:
    msg - incoming message.
  - protected Message processQuery(Message msg)
    
    An agent supporting queries should override this method to handle incoming queries.
    Parameters:
    msg - incoming query.
    Returns:
    response message to send back.
  - protected Message processRequest(Message msg)
    
    An agent supporting requests should override this method to handle incoming requests.
    Parameters:
    msg - incoming request.
    Returns:
    response message to send back.
  - @Override public boolean register(String service)
  - @Override public boolean register(Enum<?> service)
  - protected Object set(AgentID aid, Parameter param, Object value)
    
    Requests value of parameter to be changed in another agent.
    Parameters:
    aid - agent to request parameter change
    param - parameter to request to be changed
    value - new value of parameter
    Returns:
    newly set value of parameter, null on error
  - protected Object set(AgentID aid, int index, Parameter param, Object value)
    
    Requests value of indexed parameter to be changed in another agent.
    Parameters:
    aid - agent to request parameter change
    index - index of parameter set
    param - parameter to request to be changed
    value - new value of parameter
    Returns:
    newly set value of parameter, null on error
  - public void setLogLevel(Level lvl)
    
    Sets the current log level for the agent.
    Parameters:
    lvl - log level
  - protected Object setParam(Parameter p, int ndx, Object v)
    
    Agents providing dynamic parameters may override this method to set a value for a given parameter.
    Parameters:
    p - parameter to set value.
    ndx - index for indexed parameters, -1 if non-indexed.
    v - value of the parameter.
    Returns:
    new value of the parameter.
  - protected void setup()
    
    Called by UnetAgent when the agent is being initialized.
  - @Override protected void shutdown()
  - protected void startup()
    
    Called by UnetAgent after all agents are fully initialized.
  - protected void subscribeForService(String service)
    
    Subscribe to all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected void subscribeForService(Enum<?> service)
    
    Subscribe to all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected Message trace(Message msg)
    
    Log event trace.
    Parameters:
    msg - unsolicited message or a message with an inReplyTo field.
    Returns:
    message
  - protected Message trace(Message stimulus, Message response)
    
    Log event trace.
    Parameters:
    stimulus - message that resulted in this event.
    response - message that was generated as part of this event.
    Returns:
    response message
  - protected Message trace(Message stimulus, Message response, Object info)
    
    Log event trace.
    Parameters:
    stimulus - message that resulted in this event.
    response - message that was generated as part of this event.
    info - event-specific information.
    Returns:
    response message
  - protected void unsubscribeForService(String service)
    
    Unsubscribe from all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected void unsubscribeForService(Enum<?> service)
    
    Unsubscribe from all agents providing a specified service.
    Parameters:
    service - name of the service

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Java] Class UnetAgent

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected long timeout

Property Detail

Level logLevel

Method Detail

protected void addCapability(Capability cap)

@SuppressWarnings({ "unchecked", "rawtypes" }) protected List<Parameter> allOf(Class... paramEnumClasses)

@Override public boolean deregister(String service)

@Override public boolean deregister(Enum<?> service)

@Override protected void die(Throwable ex)

protected Object get(AgentID aid, Parameter param)

protected Object get(AgentID aid, int index, Parameter param)

protected String getBuildInfo()

public Level getLogLevel()

protected Object getParam(Parameter p, int ndx)

@SuppressWarnings("unchecked") public List<Class<Parameter>> getParameterClasses()

@SuppressWarnings("unchecked") public List<Class<Parameter>> getParameterClasses(int index)

protected List<Parameter> getParameterList()

protected List<Parameter> getParameterList(int index)

public String[] getServices()

public String getTitle()

public String getVersion()

@Override protected void init()

protected Boolean isReadOnly(Parameter p, int ndx)

protected Long longValue(Object v)

protected void processMessage(Message msg)

protected Message processQuery(Message msg)

protected Message processRequest(Message msg)

@Override public boolean register(String service)

@Override public boolean register(Enum<?> service)

protected Object set(AgentID aid, Parameter param, Object value)

protected Object set(AgentID aid, int index, Parameter param, Object value)

public void setLogLevel(Level lvl)

protected Object setParam(Parameter p, int ndx, Object v)

protected void setup()

@Override protected void shutdown()

protected void startup()

protected void subscribeForService(String service)

protected void subscribeForService(Enum<?> service)

protected Message trace(Message msg)

protected Message trace(Message stimulus, Message response)

protected Message trace(Message stimulus, Message response, Object info)

protected void unsubscribeForService(String service)

protected void unsubscribeForService(Enum<?> service)