UM .NET API  6.16.1
com.latencybusters.lbm.UMQSourceEventULBMessageInfo Class Reference

UMQ ULB Message Info class. This info object is delivered with a source event indicating that a ULB message has been assigned, consumed, discarded, etc. More...

Inheritance diagram for com.latencybusters.lbm.UMQSourceEventULBMessageInfo:
com.latencybusters.lbm.UMQSourceEventULBReceiverInfo

Public Member Functions

 UMQSourceEventULBMessageInfo (int flags, UMQMessageId msgId, UInt64 regId, uint firstSequenceNumber, uint lastSequenceNumber, uint assignId, uint appSetIdx, Object clientObject, String receiver)
 Creates a UMQSourceEventULBMessageInfo object and initializes fields to the supplied values. More...
 
virtual uint firstSequenceNumber ()
 Get the sequence number of the first fragment of the message. More...
 
virtual uint lastSequenceNumber ()
 Get the sequence number of the last fragment of the message. More...
 
virtual UMQMessageId messageId ()
 Get the message Id object identifying the message. More...
 
virtual Object clientObject ()
 Get the client-supplied callback object. More...
 
int flags ()
 Get informational flags for this info object. More...
 
UInt64 registrationId ()
 Get Registration ID for the receiver. More...
 
uint assignmentId ()
 Get Assignment ID for the receiver. More...
 
uint applicationSetIndex ()
 Get Application Set Index the receiver is in. More...
 
String receiver ()
 Get receivers immediate message target string for the receiver associated with this info object. More...
 

Detailed Description

UMQ ULB Message Info class. This info object is delivered with a source event indicating that a ULB message has been assigned, consumed, discarded, etc.

Constructor & Destructor Documentation

com.latencybusters.lbm.UMQSourceEventULBMessageInfo.UMQSourceEventULBMessageInfo ( int  flags,
UMQMessageId  msgId,
UInt64  regId,
uint  firstSequenceNumber,
uint  lastSequenceNumber,
uint  assignId,
uint  appSetIdx,
Object  clientObject,
String  receiver 
)

Creates a UMQSourceEventULBMessageInfo object and initializes fields to the supplied values.

LBMEInvalException An invalid parameter was specified.

Parameters
flagsInformational flags.
msgIdThe Message ID of the message.
regIdThe Registration ID of the receiver.
firstSequenceNumberThe sequence number of the first fragment associated with the message.
lastSequenceNumberThe sequence number of the last fragment associated with the message.
assignIdThe Assignment ID of the receiver.
appSetIdxThe Application Set Index the receiver is in.
clientObjectThe client object associated with the message.
receiverThe immediate message target string for the receiver.

Member Function Documentation

uint com.latencybusters.lbm.UMQSourceEventULBReceiverInfo.applicationSetIndex ( )
inherited

Get Application Set Index the receiver is in.

Returns
Application Set Index for the receiver associated with this info object.
uint com.latencybusters.lbm.UMQSourceEventULBReceiverInfo.assignmentId ( )
inherited

Get Assignment ID for the receiver.

Returns
Assignment ID for the receiver associated with this info object.
virtual Object com.latencybusters.lbm.UMQSourceEventULBMessageInfo.clientObject ( )
virtual

Get the client-supplied callback object.

Returns
Client-supplied object.
virtual uint com.latencybusters.lbm.UMQSourceEventULBMessageInfo.firstSequenceNumber ( )
virtual

Get the sequence number of the first fragment of the message.

Returns
Sequence number of the first fragment of the message.
int com.latencybusters.lbm.UMQSourceEventULBReceiverInfo.flags ( )
inherited

Get informational flags for this info object.

Returns
Flags.
virtual uint com.latencybusters.lbm.UMQSourceEventULBMessageInfo.lastSequenceNumber ( )
virtual

Get the sequence number of the last fragment of the message.

Returns
Sequence number of the last fragment of the message.
virtual UMQMessageId com.latencybusters.lbm.UMQSourceEventULBMessageInfo.messageId ( )
virtual

Get the message Id object identifying the message.

Returns
A UMQMessageId object identifying the message.
String com.latencybusters.lbm.UMQSourceEventULBReceiverInfo.receiver ( )
inherited

Get receivers immediate message target string for the receiver associated with this info object.

Returns
Receivers immediate message target string for the receiver associated with this info object.

References com.latencybusters.lbm.LBM.UMQ_ULB_MAX_RECEIVER_STRLEN.

UInt64 com.latencybusters.lbm.UMQSourceEventULBReceiverInfo.registrationId ( )
inherited

Get Registration ID for the receiver.

Returns
Registration ID for the receiver associated with this info object.

The documentation for this class was generated from the following file: