Package jade.core

Class TemplateBasedMessageQueue

java.lang.Object

jade.core.ExtendedMessageQueue

jade.core.TemplateBasedMessageQueue

All Implemented Interfaces:

MessageQueue

public class TemplateBasedMessageQueue
extends ExtendedMessageQueue

Enhanced version of the agent MessageQueue that supports creating dedicated queues of messages to explicitly registered MessageTemplates.

Author:

Caire

See Also:

registerTemplate(), Agent.createMessageQueue()

Field Summary

Fields inherited from class jade.core.ExtendedMessageQueue

list, maxSize, myAgent, myLogger, warningDiscardTemplate, warningLimit

Constructor Summary

Constructors

Constructor	Description
TemplateBasedMessageQueue()
TemplateBasedMessageQueue(int maxSize, int warningLimit, MessageTemplate warningDiscardTemplate, Agent a)

Method Summary

Modifier and Type	Method	Description
void	copyTo(List messages)	Copy all messages to a given list.
String	dump(int limit)
ACLMessage	receive(MessageTemplate pattern)	Return and remove the first message that matches the specified message template.
List<ACLMessage>	receive(MessageTemplate pattern, int max)	Return and remove the first n messages that match the specified message template.
void	registerTemplate(MessageTemplate tpl)	Register a specific MessageTemplate to this MessageQueue.

Methods inherited from class jade.core.ExtendedMessageQueue

addFirst, addLast, getMaxSize, handleDiscarded, isEmpty, setMaxSize, size

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateBasedMessageQueue

public TemplateBasedMessageQueue(int maxSize,
                                 int warningLimit,
                                 MessageTemplate warningDiscardTemplate,
                                 Agent a)

TemplateBasedMessageQueue

public TemplateBasedMessageQueue()

Method Detail

registerTemplate

public void registerTemplate(MessageTemplate tpl)

Register a specific MessageTemplate to this MessageQueue. All incoming messages matching this template will be inserted into a dedicated queue and calls to receive() with the registered template as parameter will extract messages from the dedicated queue only. In situations with heavy load of messages (several messages in the agent queue), this can speed-up performances of the receive() method a lot. If an incoming message matches more than one registered template it is inserted in the queue associated to the first matching template.

Parameters:

tpl - The MessageTemplate to be registered

receive

public ACLMessage receive(MessageTemplate pattern)

Description copied from interface: MessageQueue

Return and remove the first message that matches the specified message template.

Specified by:

receive in interface MessageQueue

Overrides:

receive in class ExtendedMessageQueue

receive

public List<ACLMessage> receive(MessageTemplate pattern,
                                int max)

Description copied from interface: MessageQueue

Return and remove the first n messages that match the specified message template.

Specified by:

receive in interface MessageQueue

Overrides:

receive in class ExtendedMessageQueue

copyTo

public void copyTo(List messages)

Description copied from interface: MessageQueue

Copy all messages to a given list.

Specified by:

copyTo in interface MessageQueue

Overrides:

copyTo in class ExtendedMessageQueue

dump

public String dump(int limit)

Overrides:

dump in class ExtendedMessageQueue