com.aimpulse.spectrum.core.mts

Class AgentMessagingClient

java.lang.Object

com.aimpulse.spectrum.core.mts.AgentMessagingClient

All Implemented Interfaces:

MessagingClient

public class AgentMessagingClient
extends Object
implements MessagingClient

AgentMessagingClient enables message handling (send, receive) for agents. The class is not thread-safe.

Since:

1.0.0

Author:

Aimpulse

Constructor Summary

Constructors

Constructor and Description
AgentMessagingClient(CommunicativeAgent agent, Inbox inbox, MessageTransportService mts)

Method Summary

Methods

Modifier and Type	Method and Description
UniqueIdentifier	generateUniqueIdentifier() Generates an identifier that is globally unique throughout the whole multiagent system.
AgentIdentifier	getAddress() Returns the identifier of the agent itself.
boolean	hasMessages() Checks whether messages are available.
boolean	hasMessages(MessagePattern pattern) Checks whether messages matching a given pattern are available.
Message	receive() Receives a message if one is available.
Message	receive(MessagePattern pattern) Returns a message matching a given pattern if one is available.
Message	send(Message message) Sets the sender of the message and passes the message to the message transport system.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentMessagingClient

public AgentMessagingClient(CommunicativeAgent agent,
                    Inbox inbox,
                    MessageTransportService mts)

Method Detail

getAddress

public AgentIdentifier getAddress()

Description copied from interface: MessagingClient

Returns the identifier of the agent itself.

Specified by:

getAddress in interface MessagingClient

Returns:

the identifier of the agent itself

send

public Message send(Message message)

Description copied from interface: MessagingClient

Sets the sender of the message and passes the message to the message transport system. The return value of the message is an unmodifiable version of the message with the sender set.

Specified by:

send in interface MessagingClient

Parameters:

message - the message to be sent

Returns:

the unmodifiable sent message with the sender set

hasMessages

public boolean hasMessages()

Description copied from interface: MessagingClient

Checks whether messages are available.

Specified by:

hasMessages in interface MessagingClient

Returns:

true if messages are available, false otherwise

hasMessages

public boolean hasMessages(MessagePattern pattern)

Description copied from interface: MessagingClient

Checks whether messages matching a given pattern are available.

Specified by:

hasMessages in interface MessagingClient

Parameters:

pattern - the pattern the messages should match

Returns:

true if messages match the given pattern, false otherwise

receive

public Message receive()
                throws NoSuchMessageException

Description copied from interface: MessagingClient

Receives a message if one is available. The returned message is removed from the client's message queue.

Specified by:

receive in interface MessagingClient

Returns:

the next message

Throws:

NoSuchMessageException - if no message is available

receive

public Message receive(MessagePattern pattern)
                throws NoSuchMessageException

Description copied from interface: MessagingClient

Returns a message matching a given pattern if one is available. The returned message is removed from the client's message queue.

Specified by:

receive in interface MessagingClient

Parameters:

pattern - the pattern the message should match

Returns:

the next message matching the given pattern

Throws:

NoSuchMessageException - if no matching message is available

generateUniqueIdentifier

public UniqueIdentifier generateUniqueIdentifier()

Description copied from interface: MessagingClient

Generates an identifier that is globally unique throughout the whole multiagent system. Such unique identifiers can be employed in order to identify messages in terms of the current conversation and the original message they reply to.

Without coordination with other agents, globally unique message identifiers can be created based on the agent identifier which is guaranteed to be unique.

Specified by:

generateUniqueIdentifier in interface MessagingClient

Returns:

the generated unique identifier