com.latencybusters.lbm
Class LBMSourceSendExInfo

java.lang.Object
  com.latencybusters.lbm.LBMSourceSendExInfo

public class LBMSourceSendExInfo
extends java.lang.Object

LBM Source Send Extended Info class. Holds a user-supplied callback argument and user-supplied flags to change callback behavior for extended LBMSource.send(byte[], int, int, LBMSourceSendExInfo) calls.

Since:

UME 2.0

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY

Constructor Summary

LBMSourceSendExInfo()
Create an empty LBMSourceSendExInfo object.

LBMSourceSendExInfo(int flags, java.lang.Object cbArg)
Create an LBMSourceSendExInfo object with flags and callback object set.

LBMSourceSendExInfo(int flags, java.lang.Object cbArg, LBMSourceChannelInfo channelInfo)
Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

LBMSourceSendExInfo(int flags, java.lang.Object cbArg, LBMSourceChannelInfo channelInfo, LBMApplicationHeaderChain appHeaderChain)
Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

LBMSourceSendExInfo(int flags, java.lang.Object cbArg, LBMSourceChannelInfo channelInfo, LBMApplicationHeaderChain appHeaderChain, UMQIndexInfo indexInfo)
Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

LBMSourceSendExInfo(int flags, java.lang.Object cbArg, LBMSourceChannelInfo channelInfo, LBMApplicationHeaderChain appHeaderChain, UMQIndexInfo indexInfo, UMQMessageTotalLifetimeInfo lifetimeInfo)
Create an LBMSourceSendExInfo object with flags and callback object set

Method Summary

LBMSourceChannelInfo	channelInfo() Returns the currently set channel info.
java.lang.Object	clientObject() Returns the client-supplied callback object.
int	flags() Returns currently set flags.
LBMApplicationHeaderChain	getApplicationHeaderChain() Get the LBMApplicationHeaderChain currently attached to this LBMSourceSendExInfo object, if any.
long	getHfSequenceNumber() Get the currently set hot failover sequence number as a long value.
java.math.BigInteger	getHfSequenceNumberBigInt() Get the currently set hot failover sequence number as a BigInteger.
UMQIndexInfo	indexInfo() Returns the currently set index info.
void	setApplicationHeaderChain(LBMApplicationHeaderChain appHeaderChain) Attaches a LBMApplicationHeaderChain object to this LBMSourceSendExInfo object, or removes an existing LBMApplicationHeaderChain object if null is passed.
void	setChannelInfo(LBMSourceChannelInfo channelInfo) Sets channel info to be included with messages.
void	setClientObject(java.lang.Object cbArg) Set the user-supplied callback object.
void	setFlags(int flags) Sets flags that control callback behavior.
void	setHfSequenceNumber(long hfsqn) Set the hot failover sequence number to send.
void	setHfSequenceNumberBigInt(java.math.BigInteger hfsqn) Set the hot failover sequence number to send.
void	setIndexInfo(UMQIndexInfo indexInfo) Sets index info to be included with messages.
void	setMessageProperties(LBMMessageProperties properties) Sets message properties to be included with messages.
void	setTotalLifetimeInfo(UMQMessageTotalLifetimeInfo lifetimeInfo) Sets total lifetime info to be included with messages.
UMQMessageTotalLifetimeInfo	totalLifetimeInfo() Returns the currently set total lifetime info.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMSourceSendExInfo

public LBMSourceSendExInfo()

Create an empty LBMSourceSendExInfo object.

Since:

UME 2.0

LBMSourceSendExInfo

public LBMSourceSendExInfo(int flags,
                           java.lang.Object cbArg)

Create an LBMSourceSendExInfo object with flags and callback object set.

Parameters:

flags - Flags to control callback behavior.

cbArg - User-supplied object passed back with any callbacks.

Since:

UME 2.0

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY

LBMSourceSendExInfo

public LBMSourceSendExInfo(int flags,
                           java.lang.Object cbArg,
                           LBMSourceChannelInfo channelInfo)

Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

Parameters:

flags - Flags to control callback behavior.

cbArg - User-supplied object passed back with any callbacks.

channelInfo - Channel information to be included with messages.

Since:

LBM 3.6

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL

LBMSourceSendExInfo

public LBMSourceSendExInfo(int flags,
                           java.lang.Object cbArg,
                           LBMSourceChannelInfo channelInfo,
                           LBMApplicationHeaderChain appHeaderChain)

Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

Parameters:

flags - Flags to control callback behavior.

cbArg - User-supplied object passed back with any callbacks.

channelInfo - Channel information to be included with messages.

appHeaderChain - Application header chain to be sent with messages.

Since:

LBM 3.6

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL, LBM.SRC_SEND_EX_FLAG_APPHDR_CHAIN

LBMSourceSendExInfo

public LBMSourceSendExInfo(int flags,
                           java.lang.Object cbArg,
                           LBMSourceChannelInfo channelInfo,
                           LBMApplicationHeaderChain appHeaderChain,
                           UMQIndexInfo indexInfo)

Create an LBMSourceSendExInfo object with flags and callback object set as well as channel information included.

Parameters:

flags - Flags to control callback behavior.

cbArg - User-supplied object passed back with any callbacks.

channelInfo - Channel information to be included with messages.

appHeaderChain - Application header chain to be sent with messages.

indexInfo - UMQ index info to send with messages.

Since:

UMQ 1.2

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL, LBM.SRC_SEND_EX_FLAG_APPHDR_CHAIN, LBM.SRC_SEND_EX_FLAG_UMQ_INDEX

LBMSourceSendExInfo

public LBMSourceSendExInfo(int flags,
                           java.lang.Object cbArg,
                           LBMSourceChannelInfo channelInfo,
                           LBMApplicationHeaderChain appHeaderChain,
                           UMQIndexInfo indexInfo,
                           UMQMessageTotalLifetimeInfo lifetimeInfo)

Create an LBMSourceSendExInfo object with flags and callback object set

Parameters:

flags - Flags to control callback behavior.

cbArg - User-supplied object passed back with any callbacks.

channelInfo - Channel information to be included with messages.

appHeaderChain - Application header chain to be sent with messages.

indexInfo - UMQ index info to send with messages.

lifetimeInfo - UMQ total lifetime info to send with messages.

Since:

UMQ 1.2

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL, LBM.SRC_SEND_EX_FLAG_APPHDR_CHAIN, LBM.SRC_SEND_EX_FLAG_UMQ_INDEX

Method Detail

setClientObject

public void setClientObject(java.lang.Object cbArg)

Set the user-supplied callback object.

Parameters:

cbArg - User-supplied object passed back with any callbacks.

Since:

UME 2.0

setFlags

public void setFlags(int flags)

Sets flags that control callback behavior.

Parameters:

flags - An integer representing an OR'd value of flags to set.

Since:

UME 2.0

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL, LBM.SRC_SEND_EX_FLAG_APPHDR_CHAIN, LBM.SRC_SEND_EX_FLAG_HF_32, LBM.SRC_SEND_EX_FLAG_HF_64

setChannelInfo

public void setChannelInfo(LBMSourceChannelInfo channelInfo)

Sets channel info to be included with messages.

Parameters:

channelInfo - A channel info object

Since:

LBM 3.6

See Also:

LBMSource#createChannel(int)

setIndexInfo

public void setIndexInfo(UMQIndexInfo indexInfo)

Sets index info to be included with messages.

Parameters:

indexInfo - An index info object

Since:

UMQ 1.2

setTotalLifetimeInfo

public void setTotalLifetimeInfo(UMQMessageTotalLifetimeInfo lifetimeInfo)

Sets total lifetime info to be included with messages.

Parameters:

lifetimeInfo - A total lifetime info object

Since:

UMQ 2.2

setMessageProperties

public void setMessageProperties(LBMMessageProperties properties)

Sets message properties to be included with messages.

Parameters:

properties - A properties object

Since:

UMS 5.1

flags

public int flags()

Returns currently set flags.

Returns:

An int representing an OR'd set of currently set flags.

Since:

UME 2.0

See Also:

LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO, LBM.SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY, LBM.SRC_SEND_EX_FLAG_CHANNEL, LBM.SRC_SEND_EX_FLAG_APPHDR_CHAIN, LBM.SRC_SEND_EX_FLAG_PROPERTIES, LBM.SRC_SEND_EX_FLAG_HF_32, LBM.SRC_SEND_EX_FLAG_HF_64

getApplicationHeaderChain

public LBMApplicationHeaderChain getApplicationHeaderChain()

Get the LBMApplicationHeaderChain currently attached to this LBMSourceSendExInfo object, if any.

Returns:

The LBMApplicationHeaderChain object attached to this LBMSourceSendExInfo object, or null if it has no LBMApplicationHeaderChain attached.

Since:

UMQ 1.1

setApplicationHeaderChain

public void setApplicationHeaderChain(LBMApplicationHeaderChain appHeaderChain)

Attaches a LBMApplicationHeaderChain object to this LBMSourceSendExInfo object, or removes an existing LBMApplicationHeaderChain object if null is passed.

Parameters:

appHeaderChain - LBMApplicationHeaderChain to attach, or null to remove an existing LBMApplicationHeaderChain.

Since:

UMQ 1.1

clientObject

public java.lang.Object clientObject()

Returns the client-supplied callback object.

Returns:

The current client-supplied callback object.

Since:

UME 2.0

channelInfo

public LBMSourceChannelInfo channelInfo()

Returns the currently set channel info.

Returns:

The current channel info.

Since:

LBM 3.6

indexInfo

public UMQIndexInfo indexInfo()

Returns the currently set index info.

Returns:

The current index info.

Since:

UMQ 1.2

totalLifetimeInfo

public UMQMessageTotalLifetimeInfo totalLifetimeInfo()

Returns the currently set total lifetime info.

Returns:

The current total lifetime info.

Since:

UMQ 2.2

setHfSequenceNumber

public void setHfSequenceNumber(long hfsqn)

Set the hot failover sequence number to send. Though java does not support unsigned integers, UMS hot failover values are considered unsigned. This method is used to set either the 32 or 64 bit sequence number to send. The ExInfo flags determine which bit value will be used, and must be set accordingly.

Parameters:

hfsqn - Hot failover sequence number to send.

Since:

UMS 5.1.1

See Also:

LBM.SRC_SEND_EX_FLAG_HF_32, LBM.SRC_SEND_EX_FLAG_HF_64, setHfSequenceNumberBigInt(BigInteger)

setHfSequenceNumberBigInt

public void setHfSequenceNumberBigInt(java.math.BigInteger hfsqn)

Set the hot failover sequence number to send. This method is provided for convenience when using 64 bit numbers. UMS will only use 64 bits of the BigInteger and is stored internally as a long.

Parameters:

hfsqn - Hot failover sequence number to send

Since:

UMS 5.1.1

See Also:

LBM.SRC_SEND_EX_FLAG_HF_32, LBM.SRC_SEND_EX_FLAG_HF_64, setHfSequenceNumber(long)

getHfSequenceNumber

public long getHfSequenceNumber()

Get the currently set hot failover sequence number as a long value.

Returns:

Hot failover sequence number

See Also:

getHfSequenceNumberBigInt(BigInteger)

getHfSequenceNumberBigInt

public java.math.BigInteger getHfSequenceNumberBigInt()

Get the currently set hot failover sequence number as a BigInteger. This is provided as a convenience method to ensure 64 bit numbers are returned as unsigned values.

Returns:

Hot failover sequence number

See Also:

#getHfSequenceNumber(long)