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
 void close()
          This method should be called after a Subscription object has been deregistered (typically from within the deregister() method of the SubscriptionManager) and allows the SubscriptionResponder to release the resources allocated for this subscription.
 ACLMessage getMessage()
          Retrieve the ACL message with which this subscription object was created.
 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, equals, finalize, getClass, hashCode, 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 should be called after a Subscription object has been deregistered (typically from within the deregister() method of the SubscriptionManager) and allows the SubscriptionResponder to release the resources allocated for this subscription. Not calling this method may have unexpected and undesirable side effects.



JADE