ds.funnel.data.msglink.protocol3

Class MessageBase

java.lang.Object

ds.funnel.data.msglink.protocol3.MessageBase

All Implemented Interfaces:

MessageEvent, Event

Direct Known Subclasses:

MessageBaseTE, MsgFileGet, MsgFilePut, MsgInsertPeer, MsgInsertResp, MsgLinkAssociate, MsgLinkAssocResp, MsgLinkConnect, MsgLinkMethodCall, MsgLinkMethodResp, MsgLinkTestping, MsgLinkTestpong, MsgLookupPeer, MsgPeerInfo, MsgPredecessorReq, MsgSuccessorPeers

public abstract class MessageBase
extends java.lang.Object
implements MessageEvent

Message.java: Marshals and unmarshals messages. Determines the message type to return.

Author:

Ryan Stern

Method Summary

Modifier and Type	Method and Description
void	chainTo(java.util.UUID inChainToID) Mark that this event belongs to a message chain.
long	getArrivalTime()
MessageType	getContentType()
NodeDetails	getLastHop()
java.util.UUID	getMessageID()
java.util.UUID	getMsgChainID()
NodeDetails	getOrigin()
MessageLink	getReplyLink()
long	getSequence()
long	getTimestamp()
boolean	isDropSafe()
StreamBuffer	marshallToBuffer(int inLinkID, long inSeqNum) Update the header and return a new StreamBuffer view of the data for writing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

marshallToBuffer

public StreamBuffer marshallToBuffer(int inLinkID,
                                     long inSeqNum)

Update the header and return a new StreamBuffer view of the data for writing.

Parameters:

inLinkID - - The id of the virtual link.

inSeqNum - - The sequence number of the new message.

Returns:

A new StreamBuffer view of the data.

getContentType

public MessageType getContentType()

Specified by:

getContentType in interface MessageEvent

Returns:

This message's type.

getSequence

public long getSequence()

Specified by:

getSequence in interface MessageEvent

Returns:

The incrementing sequence number.

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface MessageEvent

Returns:

The time the message was created.

getArrivalTime

public long getArrivalTime()

Specified by:

getArrivalTime in interface MessageEvent

Returns:

The time the message arrived.

getOrigin

public NodeDetails getOrigin()

Specified by:

getOrigin in interface MessageEvent

Returns:

The node that created this message.

getLastHop

public NodeDetails getLastHop()

Specified by:

getLastHop in interface MessageEvent

Returns:

The node this message was received from.

getMessageID

public java.util.UUID getMessageID()

Specified by:

getMessageID in interface MessageEvent

Returns:

The unique id of this message.

getMsgChainID

public java.util.UUID getMsgChainID()

Specified by:

getMsgChainID in interface MessageEvent

Returns:

The unique id of the reply chain.

chainTo

public void chainTo(java.util.UUID inChainToID)

Description copied from interface: MessageEvent

Mark that this event belongs to a message chain.

Specified by:

chainTo in interface MessageEvent

Parameters:

inChainToID - - The UUID of the message chain.

getReplyLink

public MessageLink getReplyLink()

Specified by:

getReplyLink in interface MessageEvent

Returns:

The message link that this message was received from.

isDropSafe

public boolean isDropSafe()

Specified by:

isDropSafe in interface MessageEvent

Returns:

True if this message may be randomly dropped.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object