rice.p2p.scribe.messaging
Class SubscribeMessage

java.lang.Object
  rice.p2p.scribe.messaging.ScribeMessage
      rice.p2p.scribe.messaging.AnycastMessage
          rice.p2p.scribe.messaging.SubscribeMessage

All Implemented Interfaces:

Message, RawMessage, java.io.Serializable

public class SubscribeMessage

extends AnycastMessage

Version:

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

Author:

Alan Mislove

See Also:

Serialized Form

Field Summary

protected int	id The id of this message
protected Id	previousParent The previous parent
protected NodeHandle	subscriber The original subscriber
static short	TYPE DESCRIBE THE FIELD

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

content, toVisit, visited

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

SubscribeMessage(NodeHandle source, Topic topic, Id previousParent, int id, RawScribeContent content)
Constructor which takes a unique integer Id

SubscribeMessage(NodeHandle source, Topic topic, int id, RawScribeContent content)
Constructor which takes a unique integer Id

Method Summary

static SubscribeMessage	buildSM(InputBuffer buf, Endpoint endpoint, ScribeContentDeserializer scd) DESCRIBE THE METHOD
int	getId() Returns this subscribe lost message's id
Id	getPreviousParent() Returns the node who is trying to subscribe
NodeHandle	getSubscriber() Returns the node who is trying to subscribe
short	getType() Raw Serialization **************************************
void	serialize(OutputBuffer buf) DESCRIBE THE METHOD
java.lang.String	toString() Returns a String represneting this message

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

addFirst, addLast, addVisited, build, getContent, getNext, peekNext, remove, serializeHelper, setContent, setContent

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

subscriber

protected NodeHandle subscriber

The original subscriber

previousParent

protected Id previousParent

The previous parent

id

protected int id

The id of this message

TYPE

public static final short TYPE

DESCRIBE THE FIELD

See Also:

Constant Field Values

Constructor Detail

SubscribeMessage

public SubscribeMessage(NodeHandle source,
                        Topic topic,
                        int id,
                        RawScribeContent content)

Constructor which takes a unique integer Id

Parameters:

source - The source address

topic - The topic

id - The UID for this message

content - The content

SubscribeMessage

public SubscribeMessage(NodeHandle source,
                        Topic topic,
                        Id previousParent,
                        int id,
                        RawScribeContent content)

Constructor which takes a unique integer Id

Parameters:

source - The source address

topic - The topic

id - The UID for this message

content - The content

previousParent - The parent on this topic who died

Method Detail

getSubscriber

public NodeHandle getSubscriber()

Returns the node who is trying to subscribe

Returns:

The node who is attempting to subscribe

getPreviousParent

public Id getPreviousParent()

Returns the node who is trying to subscribe

Returns:

The node who is attempting to subscribe

getId

public int getId()

Returns this subscribe lost message's id

Returns:

The id of this subscribe message

getType

public short getType()

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

Specified by:

getType in interface RawMessage

Overrides:

getType in class AnycastMessage

Returns:

The Type value

toString

public java.lang.String toString()

Returns a String represneting this message

Returns:

A String of this message

serialize

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

DESCRIBE THE METHOD

Specified by:

serialize in interface RawMessage

Overrides:

serialize in class AnycastMessage

Parameters:

buf - DESCRIBE THE PARAMETER

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION

buildSM

public static SubscribeMessage buildSM(InputBuffer buf,
                                       Endpoint endpoint,
                                       ScribeContentDeserializer scd)
                                throws java.io.IOException

DESCRIBE THE METHOD

Parameters:

buf - DESCRIBE THE PARAMETER

endpoint - DESCRIBE THE PARAMETER

scd - DESCRIBE THE PARAMETER

Returns:

DESCRIBE THE RETURN VALUE

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION