jgroup.relacs.mss
Class MsgRouting

java.lang.Object
  jgroup.relacs.mss.MsgRouting

All Implemented Interfaces:

Msg, MssConstants, MssTag

public final class MsgRouting
extends java.lang.Object
implements Msg, MssConstants, MssTag

The MsgRouting class

Since:

Jgroup 1.2

Author:

Hein Meling

Field Summary

Fields inherited from interface jgroup.relacs.mss.MssConstants

ALL, EHANDLER_PRIORITY, HEADER_SIZE, MINIMUM_ALIVE_VALUE, MSS_HEADER_SIZE, MSSUSER_PRIORITY, NACKSUPPRESSION, NI_PRIORITY, OVERHEAD_SIZE, ROUTING_ENABLED, TRAILER_SIZE, UNDEF, UNREACHABLE

Fields inherited from interface jgroup.relacs.mss.MssTag

ASYN, CONGESTION, EXTERNFC, FWDROUTING, IAMALIVE, JG, LOCALFC, NACK, NOTLASTFRAGMENT, PING_OBJECT, QSYN, REMOTENACK, ROUTING, SENT, SENTNACK, SYN, TAGTYPE, TOPOLOGY

Constructor Summary

MsgRouting()

Method Summary

static int	getMaxSize(int numOfHosts, int numOfClusters) Return the largest possible size that a MsgRouting message may consume, for the given distributed system size.
int	getMid() Returns the message identifier for this message; all routing messages have UNDEF as their message identifier.
jgroup.relacs.mss.MsgFlowSndrSide	getMsgFlow() Returns the message flow controller for the sender side.
OutMessage	getOutMessage() Returns the OutMessage associated with this message.
MssHost	getSender() Returns the sender of this message.
byte	getTag() Returns the tag associated to this message.
jgroup.relacs.mss.TopologyEntry[]	getTopologyTable() Returns the topology table associated with the routing table attached with this message.
boolean	hasToBeRouted() Returns false always, since routing messages should never be routed.
FragmentIterator	iterator(jgroup.relacs.mss.MsgCntrl msgCntrl) Returns a FragmentIterator for this MsgRouting object.
java.lang.String	toString() Returns a string representation of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

MsgRouting

public MsgRouting()

Method Detail

getMaxSize

public static int getMaxSize(int numOfHosts,
                             int numOfClusters)

Return the largest possible size that a MsgRouting message may consume, for the given distributed system size.

getTopologyTable

public jgroup.relacs.mss.TopologyEntry[] getTopologyTable()

Returns the topology table associated with the routing table attached with this message.

iterator

public FragmentIterator iterator(jgroup.relacs.mss.MsgCntrl msgCntrl)

Returns a FragmentIterator for this MsgRouting object. This iterator allows to send the entire message as multiple fragments of specified size (payload). At the same time, it marks each fragment with a tag and message identifier provided through the next() method of the iterator.

Specified by:

iterator in interface Msg

getTag

public byte getTag()

Returns the tag associated to this message.

Specified by:

getTag in interface Msg

getMid

public int getMid()

Returns the message identifier for this message; all routing messages have UNDEF as their message identifier.

Specified by:

getMid in interface Msg

getSender

public MssHost getSender()

Returns the sender of this message.

Specified by:

getSender in interface Msg

hasToBeRouted

public boolean hasToBeRouted()

Returns false always, since routing messages should never be routed.

Specified by:

hasToBeRouted in interface Msg

getMsgFlow

public jgroup.relacs.mss.MsgFlowSndrSide getMsgFlow()

Returns the message flow controller for the sender side.

Specified by:

getMsgFlow in interface Msg

getOutMessage

public OutMessage getOutMessage()

Returns the OutMessage associated with this message.

Specified by:

getOutMessage in interface Msg

toString

public java.lang.String toString()

Returns a string representation of this object

Overrides:

toString in class java.lang.Object