com.latencybusters.lbm
Class LBMApplicationHeaderChainElement

java.lang.Object
  com.latencybusters.lbm.LBMApplicationHeaderChainElement

public class LBMApplicationHeaderChainElement
extends java.lang.Object

Constructor Summary

LBMApplicationHeaderChainElement()
Create a new LBMApplicationHeaderChainElement object that can be added to a LBMApplicationHeaderChain.

Method Summary

byte[]	getData() Get the data associated with this application header element.
short	getSubtype() Get the user-settable subtype of the application header element.
byte	getType() Returns the application header element's type.
void	setData(byte[] data) Set the data byte array to be sent with this application header element.
void	setSubtype(short subtype) Sets the subtype of the application header element.
void	setType(byte type) Sets this application header element's type.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMApplicationHeaderChainElement

public LBMApplicationHeaderChainElement()

Create a new LBMApplicationHeaderChainElement object that can be added to a LBMApplicationHeaderChain.

Since:

UMQ 1.1

Method Detail

getType

public byte getType()

Returns the application header element's type. The only currently supported type is LBM.CHAIN_ELEM_USER_DATA.

Returns:

A byte representing the type of application header element.

Since:

UMQ 1.1

setType

public void setType(byte type)
             throws LBMEInvalException

Sets this application header element's type. The only currently supported type is LBM.CHAIN_ELEM_USER_DATA. Setting this to any other type will cause an exception to be thrown.

Parameters:

type - The type of the application header element. This should always be set to LBM.CHAIN_ELEM_USER_DATA.

Throws:

LBMEInvalException - if the type is not supported.

Since:

UMQ 1.1

getSubtype

public short getSubtype()

Get the user-settable subtype of the application header element.

Returns:

A short representing the user-settable subtype of the application header element.

Since:

UMQ 1.1

setSubtype

public void setSubtype(short subtype)

Sets the subtype of the application header element. Subtypes can be any positive number representable by a short. It's up to the user application to assign meaning to and interpret the subtype field.

Parameters:

subtype - The subtype to set this application header element to.

Since:

UMQ 1.1

getData

public byte[] getData()

Get the data associated with this application header element.

Returns:

Application header element data. The length of the data array is always a multiple of four. For example, if [57,57] is sent, the received byte array is [57,57,0,0].

Since:

UMQ 1.1

setData

public void setData(byte[] data)

Set the data byte array to be sent with this application header element.

NOTE: Application header element data payloads are currently limited in length to 196 bytes or less.

Parameters:

data - The data byte array to send with this application header element.

Since:

UMQ 1.1