Encapsulates all LBM messages.
Call dispose() to utilize Zero Object Delivery (ZOD), or promote() to retain message object after callback. You must call either one or the other.
When using ZOD (Zero Object Delivery), access message data via dataPointer() and length(). (For more information on ZOD, see Zero Object Delivery (ZOD) and Java API Overview.)
For object-based delivery (non-ZOD), access message data with data(), which creates a byte array object that contains the message data.

C# |
public class LBMMessage : IDisposable

All Members | Constructors | Methods | |||
Icon | Member | Description |
---|---|---|
![]() | LBMMessage()()() | Initializes a new instance of the LBMMessage class |
![]() | canSendExplicitAck()()() |
Determine whether an explicit ACK can be used on this message (UME).
|
![]() | channelInfo()()() |
Holds information about any channel information included with the message.
|
![]() | data()()() |
Message data. Calling this method causes the data to be copied to a
new byte array. For better performance, use the dataPointer() method
to access the data directly.
|
![]() | dataPointer()()() |
Pointer to the beginning of the unmanaged data buffer for this message. For ZOD, use in conjunction with
length() to determine how many bytes in the buffer are actually valid.
|
![]() | dataPointerSafe()()() |
Return an IntPtr to the beginning of the unmanaged data buffer for this message. For ZOD, use in conjunction with
length() to determine how many bytes in the buffer are actually valid.
|
![]() | dataString()()() |
Message string data. Calling this method converts the data to a string and
returns that string.
|
![]() | deregistrationCompleteInfo()()() |
Get an extended deregistration complete info object from the message
(only for LBM.MSG_UME_DEREGISTRATION_COMPLETE_EX messages).
|
![]() | deregistrationSuccessInfo()()() |
Get an extended deregistration success info object from the message (only for
LBM.MSG_UME_DEREGISTRATION_SUCCESS_EX messages).
|
![]() | dispose()()() |
Dispose of this message immediately (same as Dispose())
|
![]() | Dispose()()() |
Dispose of this message immediately
|
![]() | extractUMEAck()()() |
Retrieves the ack structure from a UME message.
|
![]() | Finalize()()() |
LBMMessage finalization
(Overrides Object.Finalize()()().) |
![]() | firstFragmentSequenceNumber()()() |
LBM sequence number of the first fragment of the current message
|
![]() | flags()()() |
LBM message flags
|
![]() | fragmentOffset()()() |
Byte offset of the current fragment within the associated message
|
![]() | hfSequenceNumber32()()() |
Get the 32 bit hot failover sequence number.
|
![]() | hfSequenceNumber64()()() |
Get the 64 bit hot failover sequence number.
|
![]() | isFragment()()() |
Returns true if the current object is actually a message fragment
|
![]() | isFromGateway()()() | Obsolete.
Whether or not the message arrived via a gateway.
|
![]() | length()()() |
Message data length. For ZOD, use this in conjunction with dataPointer().
|
![]() | originalSequenceNumber()()() | Obsolete.
Original sequence number (if the message arrived via a gateway).
|
![]() | originalSource()()() | Obsolete.
Original message source (if the message arrived via a gateway).
|
![]() | originalSourceAsCharArray()()() | Obsolete.
Original message source (if the message arrived via a gateway)
as character array
|
![]() | osqn()()() |
Get the original message sequence number set by the UM library.
|
![]() | promote()()() |
Use to continue processing the message on another thread, or after the callback returns. (Note: If the
application does not call promote or dispose, UM promotes the object by default. However, for valid
coding, you must call one or the other.)
|
![]() | properties()()() |
Retrieve the properties associated with this message.
|
![]() | queueDeregistrationCompleteInfo()()() |
Get an extended queue deregistration complete info object from the message
(only for LBM.MSG_UMQ_DEREGISTRATION_COMPLETE_EX messages).
|
![]() | queueIndexAssignedInfo()()() | Get a queue index assigned info object from the message
only for LBM.MSG_UMQ_INDEX_ASSIGNED_EX messages). |
![]() | queueIndexAssignmentEligibilityStartCompleteInfo()()() | Get a queue index assignment eligibility start complete info object from the message
(only for LBM.MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX messages). |
![]() | queueIndexAssignmentEligibilityStopCompleteInfo()()() | Get a queue index assignment eligibility stop complete info object from the message
(only for LBM.MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX messages). |
![]() | queueIndexInfo()()() | Retrieve index information from the message. |
![]() | queueIndexReleasedInfo()()() | Get a queue index released info object from the message
only for LBM.MSG_UMQ_INDEX_RELEASED_EX messages). |
![]() | queueMessageId()()() |
The message ID assigned by the queue (UMQ only)
|
![]() | queueRegistrationCompleteInfo()()() |
Get an extended queue registration complete info object from the message
(only for LBM.MSG_UMQ_REGISTRATION_COMPLETE_EX messages).
|
![]() | reassign(Int32) |
Do not acknowledge the given message and instead request that the message be reassigned.
|
![]() | receiverRegistrationId()()() |
The registration ID for the receiver (UME only).
|
![]() | registrationCompleteInfo()()() |
Get an extended registration complete info object from the message
(only for LBM.MSG_UME_REGISTRATION_COMPLETE_EX messages).
|
![]() | registrationSuccessInfo()()() |
Get an extended registration success info object from the message (only for
LBM.MSG_UME_REGISTRATION_SUCCESS_EX messages).
|
![]() | respond(array<Byte>[]()[], Int32, Int32) |
Send a response for this request message.
|
![]() | sendExplicitAck()()() |
Send an explicit ACK for this message (UME only).
|
![]() | sequenceNumber()()() |
LBM message (or message fragment) sequence number
|
![]() | source()()() |
Message source
|
![]() | sourceAsCharArray()()() |
Message source
|
![]() | sourceClientObject()()() |
Get the source client object for this message's source, as set by an LBMSourceCreationCallback callback delegate.
|
![]() | sourceRegistrationId()()() |
The registration ID for the source (UME only).
|
![]() | timestampMicroseconds()()() |
Microsecondseconds portion of the timestamp indicating when the message was received.
|
![]() | timestampSeconds()()() |
Seconds portion of the timestamp indicating when the message was received.
|
![]() | topicName()()() |
Topic on which the current message has been delivered.
|
![]() | topicNameAsCharArray()()() |
Topic on which the current message has been delivered.
|
![]() | totalMessageLength()()() |
Total message size.
|
![]() | type()()() |
LBM message type
|

Exception | Condition |
---|---|
Invalid argument or unexpected operational behavior has been encountered by unmanaged LBM C layer function. |

Object | |
![]() | LBMMessage |