jade.proto

Class SubscriptionResponder.Subscription

java.lang.Object

jade.proto.SubscriptionResponder.Subscription

Enclosing class:

SubscriptionResponder

public static class SubscriptionResponder.Subscription
extends java.lang.Object

Inner calss Subscription

This class represents a subscription. When a notification has to be sent to a subscribed agent the notification message should not be directly sent to the subscribed agent, but should be passed to the Subscription object representing the subscription of that agent by means of its notify() method. This automatically handles sequencing and protocol fields appropriately. Subscription objects must be created by means of the createSubscription() method.

Method Summary

Modifier and Type	Method and Description
void	close() This method removes the current Subscription object from the SubscriptionResponder internal tables.
boolean	equals(java.lang.Object obj)
ACLMessage	getMessage() Retrieve the ACL message with which this subscription object was created.
int	hashCode()
void	notify(ACLMessage notification) This method allows sending back a notification message to the subscribed agent associated to this Subscription object.

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public ACLMessage getMessage()

Retrieve the ACL message with which this subscription object was created.

Returns:

the subscription message corresponding to this Subscription

notify

public void notify(ACLMessage notification)

This method allows sending back a notification message to the subscribed agent associated to this Subscription object. The user should call this method, instead of directly using the send() method of the Agent class, as it automatically handles sequencing and protocol fields appropriately.

close

public void close()

This method removes the current Subscription object from the SubscriptionResponder internal tables.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object