rice.p2p.replication.messaging
Class ReplicationMessage

java.lang.Object
  rice.p2p.replication.messaging.ReplicationMessage

All Implemented Interfaces:

Message, RawMessage, java.io.Serializable

Direct Known Subclasses:

ReminderMessage, RequestMessage, ResponseMessage

public abstract class ReplicationMessage

extends java.lang.Object

implements RawMessage

Version:

$Id: ReplicationMessage.java 3274 2006-05-15 16:17:47Z jeffh $

Author:

Alan Mislove

See Also:

Serialized Form

Field Summary

protected NodeHandle

source DESCRIBE THE FIELD

Fields inherited from interface rice.p2p.commonapi.Message

HIGH_PRIORITY, LOW_PRIORITY, MAX_PRIORITY, MEDIUM_HIGH_PRIORITY, MEDIUM_LOW_PRIORITY, MEDIUM_PRIORITY

Constructor Summary

	ReplicationMessage(InputBuffer buf, Endpoint endpoint) Constructor for ReplicationMessage.
protected	ReplicationMessage(NodeHandle source) Constructor which takes a unique integer Id

Method Summary

byte	getPriority() Method which should return the priority level of this message.
NodeHandle	getSource() Method which returns this messages' source address
void	serialize(OutputBuffer buf) DESCRIBE THE METHOD

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

DESCRIBE THE FIELD

Constructor Detail

ReplicationMessage

protected ReplicationMessage(NodeHandle source)

Constructor which takes a unique integer Id

Parameters:

source - The source address

ReplicationMessage

public ReplicationMessage(InputBuffer buf,
                          Endpoint endpoint)
                   throws java.io.IOException

Constructor for ReplicationMessage.

Parameters:

buf - DESCRIBE THE PARAMETER

endpoint - DESCRIBE THE PARAMETER

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION

Method Detail

getPriority

public byte 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

serialize

public void serialize(OutputBuffer buf)
               throws java.io.IOException

DESCRIBE THE METHOD

Specified by:

serialize in interface RawMessage

Parameters:

buf - DESCRIBE THE PARAMETER

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION