rice.p2p.scribe.messaging
Class SubscribeAckMessage

java.lang.Object
  rice.p2p.scribe.messaging.ScribeMessage
      rice.p2p.scribe.messaging.AbstractSubscribeMessage
          rice.p2p.scribe.messaging.SubscribeAckMessage

All Implemented Interfaces:

Message, RawMessage, java.io.Serializable

public class SubscribeAckMessage

extends AbstractSubscribeMessage

Version:

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

Author:

Alan Mislove

See Also:

Serialized Form

Field Summary

protected Id[]	pathToRoot The contained path to the root
static short	TYPE DESCRIBE THE FIELD

Fields inherited from class rice.p2p.scribe.messaging.AbstractSubscribeMessage

id

Fields inherited from class rice.p2p.scribe.messaging.ScribeMessage

source, topic

Fields inherited from interface rice.p2p.commonapi.Message

HIGH_PRIORITY, LOW_PRIORITY, MAX_PRIORITY, MEDIUM_HIGH_PRIORITY, MEDIUM_LOW_PRIORITY, MEDIUM_PRIORITY

Constructor Summary

SubscribeAckMessage(NodeHandle source, Topic topic, Id[] pathToRoot, int id)
Constructor which takes a unique integer Id

Method Summary

static SubscribeAckMessage	build(InputBuffer buf, Endpoint endpoint) DESCRIBE THE METHOD
Id[]	getPathToRoot() Returns the path to the root for the node receiving this message
short	getType() Raw Serialization **************************************
void	serialize(OutputBuffer buf) DESCRIBE THE METHOD
java.lang.String	toString() Returns a String representation of this ack

Methods inherited from class rice.p2p.scribe.messaging.AbstractSubscribeMessage

getId

Methods inherited from class rice.p2p.scribe.messaging.ScribeMessage

getPriority, getSource, getTopic, setSource

Methods inherited from class java.lang.Object

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

Field Detail

pathToRoot

protected Id[] pathToRoot

The contained path to the root

TYPE

public static final short TYPE

DESCRIBE THE FIELD

See Also:

Constant Field Values

Constructor Detail

SubscribeAckMessage

public SubscribeAckMessage(NodeHandle source,
                           Topic topic,
                           Id[] pathToRoot,
                           int id)

Constructor which takes a unique integer Id

Parameters:

id - The unique id

source - The source address

topic - DESCRIBE THE PARAMETER

pathToRoot - DESCRIBE THE PARAMETER

Method Detail

getPathToRoot

public Id[] getPathToRoot()

Returns the path to the root for the node receiving this message

Returns:

The new path to the root for the node receiving this message

getType

public short getType()

Raw Serialization **************************************

Returns:

The Type value

toString

public java.lang.String toString()

Returns a String representation of this ack

Returns:

A String

serialize

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

DESCRIBE THE METHOD

Specified by:

serialize in interface RawMessage

Overrides:

serialize in class AbstractSubscribeMessage

Parameters:

buf - DESCRIBE THE PARAMETER

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION

build

public static SubscribeAckMessage build(InputBuffer buf,
                                        Endpoint endpoint)
                                 throws java.io.IOException

DESCRIBE THE METHOD

Parameters:

buf - DESCRIBE THE PARAMETER

endpoint - DESCRIBE THE PARAMETER

Returns:

DESCRIBE THE RETURN VALUE

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION