Rice Pastry API

rice.p2p.scribe.messaging
Class ScribeMessage

java.lang.Object
  extended by rice.p2p.scribe.messaging.ScribeMessage
All Implemented Interfaces:
java.io.Serializable, Message, RawMessage, RawSerializable
Direct Known Subclasses:
AnycastFailureMessage, AnycastMessage, DropMessage, PublishMessage, PublishRequestMessage

public abstract class ScribeMessage
extends java.lang.Object
implements RawMessage

Version:
$Id: ScribeMessage.java 3613 2007-02-15 14:45:14Z jstewart $
Author:
Alan Mislove
See Also:
Serialized Form

Field Summary
protected  NodeHandle source
           
protected  Topic topic
           
 
Fields inherited from interface rice.p2p.commonapi.Message
DEFAULT_PRIORITY, HIGH_PRIORITY, LOW_PRIORITY, LOWEST_PRIORITY, MAX_PRIORITY, MEDIUM_HIGH_PRIORITY, MEDIUM_LOW_PRIORITY, MEDIUM_PRIORITY
 
Constructor Summary
protected ScribeMessage(InputBuffer buf, Endpoint endpoint)
          Protected because it should only be called from an extending class, to get version numbers correct.
protected ScribeMessage(NodeHandle source, Topic topic)
          Constructor which takes a unique integer Id
 
Method Summary
 int getPriority()
          Method which should return the priority level of this message.
 NodeHandle getSource()
          Method which returns this messages' source address
 Topic getTopic()
          Method which returns this messages' topic
 void serialize(OutputBuffer buf)
           
 void setSource(NodeHandle source)
          Method which set this messages' source address
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface rice.p2p.commonapi.rawserialization.RawMessage
getType
 

Field Detail

source

protected NodeHandle source

topic

protected Topic topic
Constructor Detail

ScribeMessage

protected ScribeMessage(NodeHandle source,
                        Topic topic)
Constructor which takes a unique integer Id

Parameters:
source - The source address
topic - The topic

ScribeMessage

protected ScribeMessage(InputBuffer buf,
                        Endpoint endpoint)
                 throws java.io.IOException
Protected because it should only be called from an extending class, to get version numbers correct.

Throws:
java.io.IOException
Method Detail

getPriority

public int getPriority()
Method which should return the priority level of this message. The messages can range in priority from 0 (highest priority) to Integer.MAX_VALUE (lowest) - when sending messages across the wire, the queue is sorted by message priority. If the queue reaches its limit, the lowest priority messages are discarded. Thus, applications which are very verbose should have LOW_PRIORITY or lower, and applications which are somewhat quiet are allowed to have MEDIUM_PRIORITY or possibly even HIGH_PRIORITY.

Specified by:
getPriority in interface Message
Returns:
This message's priority

getSource

public NodeHandle getSource()
Method which returns this messages' source address

Returns:
The source of this message

setSource

public void setSource(NodeHandle source)
Method which set this messages' source address

Parameters:
source - The source of this message

getTopic

public Topic getTopic()
Method which returns this messages' topic

Returns:
The topic of this message

serialize

public void serialize(OutputBuffer buf)
               throws java.io.IOException
Specified by:
serialize in interface RawSerializable
Throws:
java.io.IOException

Rice Pastry API

Copyright © 2001-2005 - Rice Pastry.


Imprint-Dataprotection