org.arl.fjage

Interface Messenger

All Known Implementing Classes:

Agent, Gateway, ShellAgent

public interface Messenger

Interface implemented by classes that provide basic messaging services.

Method Summary

Modifier and Type	Method and Description
Message	receive() Returns a message received by the gateway.
Message	receive(java.lang.Class<?> cls) Returns a message of a given class received by the gateway.
Message	receive(java.lang.Class<?> cls, long timeout) Returns a message of a given class received by the gateway.
Message	receive(long timeout) Returns a message received by the agent.
Message	receive(Message m) Returns a response message received by the gateway.
Message	receive(MessageFilter filter) Returns a message received by the gateway and matching the given filter.
Message	receive(MessageFilter filter, long timeout) Returns a message received by the gateway and matching the given filter.
Message	receive(Message m, long timeout) Returns a response message received by the gateway.
Message	request(Message msg) Sends a request and waits for a response.
Message	request(Message msg, long timeout) Sends a request and waits for a response.
boolean	send(Message m) Sends a message to the recipient indicated in the message.

Method Detail

send

boolean send(Message m)

Sends a message to the recipient indicated in the message. The recipient may be either an agent or a topic.

Parameters:

m - message to be sent.

Returns:

true if message accepted for delivery, false on failure.

receive

Message receive()

Returns a message received by the gateway. This method is non-blocking.

Returns:

received message, null if none available.

receive

Message receive(long timeout)

Returns a message received by the agent. This method blocks until timeout if no message available.

Parameters:

timeout - timeout in milliseconds.

Returns:

received message, null on timeout.

receive

Message receive(java.lang.Class<?> cls)

Returns a message of a given class received by the gateway. This method is non-blocking.

Parameters:

cls - the class of the message of interest.

Returns:

received message of the given class, null if none available.

receive

Message receive(java.lang.Class<?> cls,
                long timeout)

Returns a message of a given class received by the gateway. This method blocks until timeout if no message available.

Parameters:

cls - the class of the message of interest.

timeout - timeout in milliseconds.

Returns:

received message of the given class, null on timeout.

receive

Message receive(Message m)

Returns a response message received by the gateway. This method is non-blocking.

Parameters:

m - original message to which a response is expected.

Returns:

received response message, null if none available.

receive

Message receive(Message m,
                long timeout)

Returns a response message received by the gateway. This method blocks until timeout if no message available.

Parameters:

m - original message to which a response is expected.

timeout - timeout in milliseconds.

Returns:

received response message, null on timeout.

receive

Message receive(MessageFilter filter)

Returns a message received by the gateway and matching the given filter. This method is non-blocking.

Parameters:

filter - message filter.

Returns:

received message matching the filter, null on timeout.

receive

Message receive(MessageFilter filter,
                long timeout)

Returns a message received by the gateway and matching the given filter. This method blocks until timeout if no message available.

Parameters:

filter - message filter.

timeout - timeout in milliseconds.

Returns:

received message matching the filter, null on timeout.

request

Message request(Message msg,
                long timeout)

Sends a request and waits for a response. This method blocks until timeout if no response is received.

Parameters:

msg - message to send.

timeout - timeout in milliseconds.

Returns:

received response message, null on timeout.

request

Message request(Message msg)

Sends a request and waits for a response. This method blocks until a default timeout, if no response is received.

Parameters:

msg - message to send.

Returns:

received response message, null on timeout.