gov.nist.antd.merlin.protocol.signaling
Class DynRecoveryHeader

java.lang.Object
  |
  +--SSF.OS.ProtocolMessage
        |
        +--gov.nist.antd.merlin.protocol.signaling.DynRecoveryHeader

public class DynRecoveryHeader

extends ProtocolMessage

This class represents the header for the DynRecovery protocol.

 This class was developed at the National Institute of Standards and
 Technology by employees of the Federal Government in the course of
 their official duties. Pursuant to title 17 Section 105 of the United
 States Code this software is not subject to copyright protection and
 is in the public domain.
 NIST assumes no responsibility whatsoever for its use by other parties,
 and makes no guarantees, expressed or implied, about its quality,
 reliability, or any other characteristic.
 

 We would appreciate acknowledgement if the software is used.
 

 NIST ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
 DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
 FROM THE USE OF THIS SOFTWARE.
 

Author:

borchert

, rouil

Field Summary

private int	channelID channel on which the filure occured
private int	currentSegInd segment on which this DynRecovery was received
static byte	LOL_ADV Message type : Loss of Light Advertisement.
static byte	OXC_DONE Message type : OXC_DONE
private int	oxcDoneID ID of the oxc who is sending
private int	routeID route on which the failure occured
private int	segmentIndex segment on which the filure occured
static byte	SET_PATH Message type : SET_PATH
static byte	SET_PATH_ACK Message type : SET_PATH_ACK
static byte	SET_PATH_DONE Message type : SET_PATH_DONE
private byte	type type of the message

Fields inherited from class SSF.OS.ProtocolMessage

Constructor Summary

DynRecoveryHeader(int routeId, int channelId, byte type, int segmentIndex, int currentSegInd, int oxcDoneID)
Default constructor.

Method Summary

int	bytecount() Returns the total number of bytes in this packet (21 bytes).
int	getChannelID() get the channel ID.
int	getCurrentSegInd() get the currentSegInd.
int	getOxcDoneID() get the oxcDoneID.
int	getRouteID() get the route ID.
int	getSegmentIndex() get the segment index.
byte	getType() get the massage type.
java.lang.String	printType() printType
void	setChannelID(int id) set the channel ID.
void	setCurrentSegInd(int id) set the currentSegInd.
void	setOxcDoneID(int id) set the oxcDoneID
void	setRouteID(int id) set the route ID.
void	setSegmentIndex(int id) set the segment index.
void	setType(byte type) set the type.
java.lang.String	toString() Return a String that represent the message.

Methods inherited from class SSF.OS.ProtocolMessage

carryPayload, copy, dropHeader, dropPayload, frombytes, fromVersion, header_bytecount, payload, previous, size, tobytes, version

Methods inherited from class java.lang.Object

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

Field Detail

LOL_ADV

public static final byte LOL_ADV

Message type : Loss of Light Advertisement.

See Also:

Constant Field Values

SET_PATH

public static final byte SET_PATH

Message type : SET_PATH

See Also:

Constant Field Values

OXC_DONE

public static final byte OXC_DONE

Message type : OXC_DONE

See Also:

Constant Field Values

SET_PATH_DONE

public static final byte SET_PATH_DONE

Message type : SET_PATH_DONE

See Also:

Constant Field Values

SET_PATH_ACK

public static final byte SET_PATH_ACK

Message type : SET_PATH_ACK

See Also:

Constant Field Values

type

private byte type

type of the message

routeID

private int routeID

route on which the failure occured

channelID

private int channelID

channel on which the filure occured

segmentIndex

private int segmentIndex

segment on which the filure occured

currentSegInd

private int currentSegInd

segment on which this DynRecovery was received

oxcDoneID

private int oxcDoneID

ID of the oxc who is sending

Constructor Detail

DynRecoveryHeader

public DynRecoveryHeader(int routeId,
                         int channelId,
                         byte type,
                         int segmentIndex,
                         int currentSegInd,
                         int oxcDoneID)

Default constructor.

Parameters:

routeId - type The route on which the failure occured.

channelId - type The channel on which the failure occured.

type - The message type.

oxcDoneID - The id of the sender.

Method Detail

toString

public java.lang.String toString()

Return a String that represent the message.

Overrides:

toString in class java.lang.Object

Returns:

a String that represent the message.

bytecount

public int bytecount()

Returns the total number of bytes in this packet (21 bytes).

Overrides:

bytecount in class ProtocolMessage

Returns:

the szie of the packet.

setRouteID

public void setRouteID(int id)

set the route ID.

Parameters:

id - The route id

getRouteID

public int getRouteID()

get the route ID.

Returns:

the route ID.

setChannelID

public void setChannelID(int id)

set the channel ID.

Parameters:

id - The channel id

getChannelID

public int getChannelID()

get the channel ID.

Returns:

the channel ID.

setType

public void setType(byte type)

set the type.

Parameters:

type - The type

getType

public byte getType()

get the massage type.

Returns:

the message type

setSegmentIndex

public void setSegmentIndex(int id)

set the segment index.

Parameters:

id - The segment index

getSegmentIndex

public int getSegmentIndex()

get the segment index.

Returns:

the segment index.

setCurrentSegInd

public void setCurrentSegInd(int id)

set the currentSegInd.

Parameters:

id - The currentSegInd

getCurrentSegInd

public int getCurrentSegInd()

get the currentSegInd.

Returns:

the currentSegInd.

setOxcDoneID

public void setOxcDoneID(int id)

set the oxcDoneID

Parameters:

id - The oxcDoneID

getOxcDoneID

public int getOxcDoneID()

get the oxcDoneID.

Returns:

the oxcDoneID.

printType

public java.lang.String printType()

printType

Returns:

the String representing the message type.