rice.scribe.messaging
Class MessagePublish

java.lang.Object
  rice.pastry.messaging.Message
      rice.scribe.messaging.ScribeMessage
          rice.scribe.messaging.MessagePublish

All Implemented Interfaces:

java.io.Serializable

public class MessagePublish

extends ScribeMessage

implements java.io.Serializable

MessagePublish is used whenever a Scribe nodes wishes to send events to a particular topic. The PublishMessage takes care of forwarding itself to all the nodes in the topic's multicast tree.

See Also:

Serialized Form

Field Summary

Fields inherited from class rice.scribe.messaging.ScribeMessage

m_source, m_topicId

Constructor Summary

MessagePublish(Address addr, NodeHandle source, NodeId topicId, Credentials c)
Constructor

Method Summary

void	handleDeliverMessage(Scribe scribe, Topic topic) This method is called whenever the scribe node receives a message for itself and wants to process it.
boolean	handleForwardMessage(Scribe scribe, Topic topic) This method is called whenever the scribe node forwards a message in the scribe network.
java.lang.String	toString()

Methods inherited from class rice.scribe.messaging.ScribeMessage

getData, getSource, getTopicId, setData

Methods inherited from class rice.pastry.messaging.Message

getCredentials, getDate, getDestination, getSenderId, getStream, hasPriority, setPriority, setSenderId, stamp

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagePublish

public MessagePublish(Address addr,
                      NodeHandle source,
                      NodeId topicId,
                      Credentials c)

Constructor

Parameters:

addr - the address of the scribe receiver.

source - the node generating the message.

topicId - the topic to which this message refers to.

c - the credentials associated with the mesasge.

Method Detail

handleDeliverMessage

public void handleDeliverMessage(Scribe scribe,
                                 Topic topic)

This method is called whenever the scribe node receives a message for itself and wants to process it. The processing is delegated by scribe to the message.

Specified by:

handleDeliverMessage in class ScribeMessage

Parameters:

scribe - the scribe application.

topic - the topic within the scribe application.

handleForwardMessage

public boolean handleForwardMessage(Scribe scribe,
                                    Topic topic)

This method is called whenever the scribe node forwards a message in the scribe network. The processing is delegated by scribe to the message.

Specified by:

handleForwardMessage in class ScribeMessage

Parameters:

scribe - the scribe application.

topic - the topic within the scribe application.

Returns:

true if the message should be routed further, false otherwise.

toString

public java.lang.String toString()

Specified by:

toString in class ScribeMessage