com.latencybusters.lbm
Class LBM

java.lang.Object
  com.latencybusters.lbm.LBM

public class LBM
extends java.lang.Object

LBM Utility class. This class can be subclassed to override the default logging callback used by LBM or a Java logger may be passed to the setLogger() methods to direct LBM logging.

Field Summary

static int	ASYNC_OP_INFO_FLAG_FIRST Asynchronous operation info flag.
static int	ASYNC_OP_INFO_FLAG_INLINE Asynchronous operation info flag.
static int	ASYNC_OP_INFO_FLAG_LAST Asynchronous operation info status flag.
static int	ASYNC_OP_INFO_FLAG_ONLY Asynchronous operation info flag.
static long	ASYNC_OP_INVALID_HANDLE Invalid asynchronous operation handle.
static int	ASYNC_OP_STATUS_CANCELED Asynchronous operation status code.
static int	ASYNC_OP_STATUS_COMPLETE Asynchronous operation status code.
static int	ASYNC_OP_STATUS_ERROR Asynchronous operation status code.
static int	ASYNC_OP_STATUS_IN_PROGRESS Asynchronous operation status code.
static int	ASYNC_OP_TYPE_CTX_UMQ_QUEUE_TOPIC_LIST Asynchronous operation type.
static int	ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_LIST Asynchronous operation type.
static int	ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_RETRIEVE Asynchronous operation type.
static int	ASYNC_OPERATION_CANCEL_FLAG_NONBLOCK Asynchronous operation cancel flag.
static int	ASYNC_OPERATION_STATUS_FLAG_NONBLOCK Asynchronous operation status flag.
static byte	CHAIN_ELEM_USER_DATA Application header type representing user data.
static int	CONTEXT_EVENT_UMQ_INSTANCE_LIST_NOTIFICATION Indicates that the queue instance list has changed.
static int	CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX Indicates context registration is complete.
static int	CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM Flag indicating that registration completed with only quorum reached.
static int	CONTEXT_EVENT_UMQ_REGISTRATION_ERROR Indicates context registration failed with an error.
static int	CONTEXT_EVENT_UMQ_REGISTRATION_SUCCESS_EX Indicates context registration with a single queue instance was successful.
static int	CTX_ATTR_OP_DAEMON Context operational mode: Daemon
static int	CTX_ATTR_OP_EMBEDDED Context operational mode: Embedded
static int	CTX_ATTR_OP_SEQUENTIAL Context operational mode: Sequential
static int	EAPPERR LBM error: Application Error .
static int	EDAEMONCONN LBM error: LBM daemon connection not connected.
static int	EINVAL LBM error: An invalid argument was passed.
static int	EMSG_SELECTOR LBM error: Error parsing message selector.
static int	ENO_QUEUE_REG LBM error: The store is not fully registered.
static int	ENO_STORE_REG LBM error: The queue is not fully registered.
static int	ENOMEM LBM error: Operation could not be completed due to memory allocation error.
static int	EOP LBM error: Operation was invalid due to error in internal processing.
static int	EOS LBM error: Operation failed due to unrecoverable OS system call error.
static int	ETIMEDOUT LBM error: Operation timed out waiting to complete.
static int	EUMENOREG LBM error: UME registration not completed.
static long	EVENT_QUEUE_BLOCK Infinite blocking time for running event queue
static int	EVENT_QUEUE_DELAY_WARNING Event queue monitor event type: Warning of excessive delay for event.
static int	EVENT_QUEUE_ENQUEUE_NOTIFICATION Event queue monitor event type: Notification of something being added to queue.
static long	EVENT_QUEUE_POLL Poll and dispatch a single event when running the event queue
static int	EVENT_QUEUE_SIZE_WARNING Event queue monitor event type: Warning of event queue size.
static int	EWOULDBLOCK LBM error: Function would block, but object is set to be nonblocking.
static int	FLIGHT_SIZE_TYPE_ULB Specify a ULB flight size
static int	FLIGHT_SIZE_TYPE_UME Specify a UME flight size
static int	FLIGHT_SIZE_TYPE_UMQ Specify a UMQ flight size
static int	LBM_BYTEMESSAGE
static java.lang.String	LBM_JMSCorrelationID
static java.lang.String	LBM_JMSDeliveryMode
static java.lang.String	LBM_JMSExpiration
static java.lang.String	LBM_JMSMessageID
static java.lang.String	LBM_JMSPriority
static java.lang.String	LBM_JMSRedelivered
static java.lang.String	LBM_JMSReplyToName
static java.lang.String	LBM_JMSReplyToType
static java.lang.String	LBM_JMSReplyToWildcard
static java.lang.String	LBM_JMSTimestamp
static java.lang.String	LBM_JMSTopicType
static java.lang.String	LBM_JMSType
static java.lang.String	LBM_LBMMessageType
static int	LBM_MAPMESSAGE
static int	LBM_MESSAGE
static int	LBM_OBJECTMESSAGE
static long	LBM_SRC_COST_FUNCTION_REJECT Source cost function return value to indicate this source should be permanently rejected.
static int	LBM_STREAMMESSAGE
static int	LBM_TEXTMESSAGE
static int	LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_EOF UME Receiver Liveness Deletion EOF
static int	LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_TMO UME Receiver Liveness Deletion TIMEOUT
static long	LBM_UMM_INFO_FLAGS_USE_SSL Use SSL for all umm connections
static long	LBM_UMM_NUM_SERVERS_MAX Max allowed number of failover UMM Daemons
static int	LOG_ALERT Logging level: Alert
static int	LOG_CRIT Logging level: Critical
static int	LOG_DEBUG Logging level: Debug
static int	LOG_EMERG Logging level: Emergency
static int	LOG_ERR Logging level: Error
static int	LOG_INFO Logging level: Informational
static int	LOG_NOTICE Logging level: Notice
static int	LOG_WARNING Logging level: Warning
static int	MSG_BOS LBM message type: Beginning of Transport Session from source.
static int	MSG_COMPLETE_BATCH Sending/receiving flag: Message is complete batch (Batch should be sent ASAP)
static int	MSG_DATA LBM message type: Data message.
static int	MSG_END_BATCH Sending/receiving flag: End batch (Batch should be sent ASAP)
static int	MSG_EOS LBM message type: End of Transport Session from source.
static int	MSG_FLAG_DELIVERY_LATENCY
static int	MSG_FLAG_END_BATCH Receiving flag: End batch
static int	MSG_FLAG_HF_32 Receiving flag: The message contains a 32 bit hot failover sequence number
static int	MSG_FLAG_HF_64 Receiving flag: The message contains a 64 bit hot failover sequence number.
static int	MSG_FLAG_HF_DUPLICATE Receiving flag: Hot failover duplicate message
static int	MSG_FLAG_HF_OPTIONAL Receiving flag: Hot Failover optional message
static int	MSG_FLAG_HF_PASS_THROUGH Receiving flag: Non-HF message
static int	MSG_FLAG_IMMEDIATE Receiving flag: Immediate message
static int	MSG_FLAG_NUMBERED_CHANNEL Channel flag: Numbered channel message
static int	MSG_FLAG_OTR Receiving flag: The message was recovered via OTR
static int	MSG_FLAG_RETRANSMIT Receiving flag: Retransmitted message
static int	MSG_FLAG_START_BATCH Receiving flag: Start batch
static int	MSG_FLAG_TOPICLESS Receiving flag; Message has no topic.
static int	MSG_FLAG_UME_RETRANSMIT Receiving flag: Retransmitted message
static int	MSG_FLAG_UMQ_REASSIGNED Receiving flag: Reassigned UMQ message
static int	MSG_FLAG_UMQ_RESUBMITTED Receiving flag; Resubmitted UMQ message
static int	MSG_FLUSH Sending flag: Flush messages.
static int	MSG_HF_RESET LBM message type: Hot failover notification that the expected sequence number has been reset via a source send reset.
static int	MSG_MAX_SOURCE_LEN Maximum source name length
static int	MSG_MAX_TOPIC_LEN Maximum topic name length
static int	MSG_NO_SOURCE_NOTIFICATION Notification that no source has been found for topic.
static int	MSG_PROPERTY_BOOLEAN Message property type: boolean
static int	MSG_PROPERTY_BYTE Message property type: byte
static int	MSG_PROPERTY_DOUBLE Message property type: double
static int	MSG_PROPERTY_FLOAT Message property type: float
static int	MSG_PROPERTY_INT Message property type: int
static int	MSG_PROPERTY_LONG Message property type: long
static int	MSG_PROPERTY_SHORT Message property type: short
static int	MSG_PROPERTY_STRING Message property type: string
static int	MSG_REQUEST LBM message type: Request message from source.
static int	MSG_RESPONSE LBM message type: Response message from requestee.
static int	MSG_START_BATCH Sending/receiving flag: Start batch
static int	MSG_UME_DEREGISTRATION_COMPLETE_EX UME receiver notification of deregistration completion.
static int	MSG_UME_DEREGISTRATION_SUCCESS_EX UME receiver deregistration successful (extended version).
static int	MSG_UME_DEREGISTRATION_SUCCESS_EX_FLAG_RPP Deregistration was flagged as coming from a RPP store
static int	MSG_UME_REGISTRATION_CHANGE UME receiver notification of source registration change.
static int	MSG_UME_REGISTRATION_COMPLETE_EX UME receiver notification of registration completion.
static int	MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM Registration completed with only quorum reached.
static int	MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_RXREQMAX Registration completed with RX REQ maximum used.
static int	MSG_UME_REGISTRATION_ERROR UME receiver registration encountered an error.
static int	MSG_UME_REGISTRATION_SUCCESS UME receiver registration successful.
static int	MSG_UME_REGISTRATION_SUCCESS_EX UME receiver registration successful (extended version).
static int	MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_NOCACHE Registration was flagged as coming from a store that is configured to not cache data.
static int	MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD Registration was flagged as an old receiver by the store.
static int	MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP Registration was flagged as coming from a store that has allowed a RPP receiver..
static int	MSG_UMQ_DEREGISTRATION_COMPLETE_EX UMQ receiver notification of deregistration completion.
static int	MSG_UMQ_DEREGISTRATION_COMPLETE_EX_FLAG_ULB Deregistration completed with ULB source.
static int	MSG_UMQ_INDEX_ASSIGNED_EX LBM message type: UMQ receiver notification of assignment of a particular index from a particular queue or ULB source.
static int	MSG_UMQ_INDEX_ASSIGNED_FLAG_ULB Index assignment was from a ULB source.
static int	MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_ERROR LBM message type: UMQ receiver index assignment eligibility start/stop encountered an error.
static int	MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX LBM message type: UMQ receiver notification of beginning of index assignment eligibility.
static int	MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX_FLAG_ULB Index assignment eligibility start completed at a ULB source.
static int	MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX LBM message type: UMQ receiver notification of end of index assignment eligibility.
static int	MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX_FLAG_ULB Index assignment eligibility stop completed at a ULB source.
static int	MSG_UMQ_INDEX_RELEASED_EX LBM message type: UMQ receiver notification of end of assignment of a particular index from a particular queue or ULB source.
static int	MSG_UMQ_INDEX_RELEASED_FLAG_ULB Index released from a ULB source.
static int	MSG_UMQ_REASSIGN_FLAG_DISCARD Instead of requesting reassignment, request the message be discarded.
static int	MSG_UMQ_REGISTRATION_COMPLETE_EX UMQ receiver notification of registration completion.
static int	MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM Registration completed with only quorum reached.
static int	MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_ULB Registration completed with ULB source.
static int	MSG_UMQ_REGISTRATION_ERROR UMQ receiver notification of registration error.
static int	MSG_UNRECOVERABLE_LOSS LBM message type: Missing message detected and not recovered in given time.
static int	MSG_UNRECOVERABLE_LOSS_BURST LBM message type: Missing burst of messages detected and not recovered.
static int	SRC_BLOCK Block the caller indefinitely until the message is sent.
static int	SRC_EVENT_CONNECT Source event: For unicast transport, means receiver has connected.
static int	SRC_EVENT_DAEMON_CONFIRM Source event: For LBM daemon usage only, means daemon has confirmed src created
static int	SRC_EVENT_DISCONNECT Source event: For unicast transport, means receiver has disconnected.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION Source event: flight size notification.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_OVER Messages in flight has exceeded the threshold.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_UNDER Messages in flight is now below the threshold.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_ULB Specifies a ULB flight size.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UME Specifies a UME flight size.
static int	SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UMQ Specifies a UMQ flight size.
static int	SRC_EVENT_SEQUENCE_NUMBER_INFO Source event: Informs the application of the sequence numbers used with a message.
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION Source event: (UME only) UME Confirmed Delivery of Message from a receiver.
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX Source event: For UME only, means UME Confirmed Delivery of Message from receiver (extended form).
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_EXACK Confirmation received with Explicit ACK (EXACK) flagged.
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_OOD Confirmation received with Out-of-Order Delivery (OOD) flagged.
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UNIQUEACKS Confirmation received for specified number of unique ACKs.
static int	SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UREGID Confirmation received with User Specified Rcv Registration ID flagged.
static int	SRC_EVENT_UME_DEREGISTRATION_COMPLETE_EX UME source notification of deregistration completion.
static int	SRC_EVENT_UME_DEREGISTRATION_SUCCESS_EX UME source deregistration successful (extended version).
static int	SRC_EVENT_UME_MESSAGE_RECLAIMED Source event: (UME only) Indicates that a message has been reclaimed.
static int	SRC_EVENT_UME_MESSAGE_RECLAIMED_EX Source event: Indicates that a message has been reclaimed (extended version).
static int	SRC_EVENT_UME_MESSAGE_RECLAIMED_EX_FLAG_FORCED Reclaim notification is the result of a forced reclaim
static int	SRC_EVENT_UME_MESSAGE_STABLE Source event: (UME only) UME ACK from store indicates message is stable.
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX Source event: For UME only, means UME ACK from store indicates message is stable (extended form).
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE Message stable for intergroup stability
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE Message stable for intragroup stability
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STABLE Message is stable according to behavior desired
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STORE Message stable information has active store information
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_USER Message stabilized via the setUMEMessageStable API
static int	SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_WHOLE_MESSAGE_STABLE Whole message (each fragment) is stable
static int	SRC_EVENT_UME_REGISTRATION_COMPLETE_EX Source event: (UME only) Registration of source complete.
static int	SRC_EVENT_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM Registration completed with only quorum reached.
static int	SRC_EVENT_UME_REGISTRATION_ERROR Source event: (UME only) Registration of source failed with an error.
static int	SRC_EVENT_UME_REGISTRATION_SUCCESS Source event: (UME only) Registration of source successful.
static int	SRC_EVENT_UME_REGISTRATION_SUCCESS_EX Source event: (UME only) Registration of source successful (extended version).
static int	SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_NOACKS Registration was flagged as coming from a store that is configured to not send ACKs for stability (no-cache store).
static int	SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD Registration was flagged as an old source by the store.
static int	SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP Registration was flagged as coming from a store that allows and has accepted RPP persistent topics
static int	SRC_EVENT_UME_STORE_UNRESPONSIVE Source event: (UME only) Store has not been active within timeout.
static int	SRC_EVENT_UMQ_MESSAGE_ID_INFO Source event: For UMQ only, informs the application of the Message ID assigned with a message.
static int	SRC_EVENT_UMQ_MESSAGE_STABLE_EX Source event: For UMQ only, means a message is stable with the a queue instance.
static int	SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE Flag indicating that a message is stable across groups according to behavior desired.
static int	SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE Flag indicating that a message is stable within a group.
static int	SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_STABLE Flag indicating that a message is stable according to behavior desired.
static int	SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_USER Message stabilized via the setUMQMessageStable API
static int	SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX Source event: For UMQ only, means registration of source complete.
static int	SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM Flag indicating that registration completed with only quorum reached.
static int	SRC_EVENT_UMQ_REGISTRATION_ERROR Source event: For UMQ only, means registration of source failed with an error.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_ASSIGNED_EX Source event: For UMQ only, means a ULB message has been assigned to a receiver.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_COMPLETE_EX Source event: For UMQ only, means a ULB message has been consumed or discarded from all application sets.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_CONSUMED_EX Source event: For UMQ only, means a ULB message has been consumed by a receiver.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_REASSIGNED_EX Source event: For UMQ only, means a ULB message has been reassigned from a receiver.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX Source event: For UMQ only, means a ULB message has been reached end-of-life.
static int	SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_DISCARD Timeout is the result of the reassign API being called with the DISCARD flag set
static int	SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_EXPLICIT Timeout is the result of the reassign API being called by a receiver
static int	SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_MAX_REASSIGNS Timeout is the result of hitting the umq_ulb_application_set_message_max_reassignments number of assignments
static int	SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_TOTAL_LIFETIME_EXPIRED Timeout is the result of the total lifetime expiring
static int	SRC_EVENT_UMQ_ULB_RECEIVER_DEREGISTRATION_EX Source event: For UMQ only, means a receiver has deregistered from the source.
static int	SRC_EVENT_UMQ_ULB_RECEIVER_READY_EX Source event: For UMQ only, means a receiver has signalled it is ready for messages to be assigned to it.
static int	SRC_EVENT_UMQ_ULB_RECEIVER_REGISTRATION_EX Source event: For UMQ only, means a receiver has registered with the source.
static int	SRC_EVENT_UMQ_ULB_RECEIVER_TIMEOUT_EX Source event: For UMQ only, means a receiver has reached end-of-life.
static int	SRC_EVENT_WAKEUP Source event: Following earlier LBMEWouldBlockException, this event means that the source is ready for more sends.
static int	SRC_EVENT_WAKEUP_FLAG_MIM Source wakeup event flag: Unblocked source is a context-level multicast immediate mode source.
static int	SRC_EVENT_WAKEUP_FLAG_NORMAL Source wakeup event flag: Unblocked source is a normal (or hot failover) source.
static int	SRC_EVENT_WAKEUP_FLAG_REQUEST Source wakeup event flag: Unblocked source is a context-level request source.
static int	SRC_EVENT_WAKEUP_FLAG_RESPONSE Source wakeup event flag: Unblocked source is a context-level response source.
static int	SRC_EVENT_WAKEUP_FLAG_UIM Source wakeup event flag: Unblocked source is a context-level unicast immediate mode source.
static int	SRC_NONBLOCK If message could not be sent immediately, throw LBMEWouldBlockException
static int	SRC_SEND_EX_FLAG_APPHDR_CHAIN Send message with included application header chain.
static int	SRC_SEND_EX_FLAG_CHANNEL Send message with included channel information.
static int	SRC_SEND_EX_FLAG_HF_32 Send message with a 64 bit hot failover sequence number.
static int	SRC_SEND_EX_FLAG_HF_64 Send message with a 32 bit hot failover sequence number.
static int	SRC_SEND_EX_FLAG_HF_OPTIONAL Send message marked as an optional message for Hot Failover
static int	SRC_SEND_EX_FLAG_PROPERTIES Send message with supplied properties
static int	SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO Inform application of the sequence numbers used for message.
static int	SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY Inform application of the sequence numbers used for message (fragmented messages only).
static int	SRC_SEND_EX_FLAG_UMQ_INDEX Send messages associating them with the supplied UMQ index
static int	SRC_SEND_EX_FLAG_UMQ_MESSAGE_ID_INFO Inform application of the UMQ Message ID used for the message.
static int	SRC_SEND_EX_FLAG_UMQ_TOTAL_LIFETIME Send message with supplied total lifetime
static int	SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_QC Quorum and Consensus store behaviour
static int	SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_RR Round Robin store behaviour
static int	TOPIC_RES_REQUEST_ADVERTISEMENT Request advertisements from quiescent sources.
static int	TOPIC_RES_REQUEST_QUERY Request queries from quiescent receivers.
static int	TOPIC_RES_REQUEST_WILDCARD_QUERY Request queries from quiescent wildcard receivers
static int	TRANSPORT_STAT_DAEMON Transport statistics type: Daemon is being used.
static int	TRANSPORT_STAT_LBTIPC Transport statistics type: LBT-IPC transport.
static int	TRANSPORT_STAT_LBTRDMA Transport statistics type: LBT-RDMA transport.
static int	TRANSPORT_STAT_LBTRM Transport statistics type: LBT-RM transport.
static int	TRANSPORT_STAT_LBTRU Transport statistics type: LBT-RU transport.
static int	TRANSPORT_STAT_TCP Transport statistics type: TCP transport.
static int	UME_MAX_STORE_STRLEN Maximum UME store length.
static int	UMQ_INDEX_FLAG_NUMERIC UMQIndexInfo flag.
static int	UMQ_MAX_APPSET_STRLEN Maximum UMQ queue appset name length.
static int	UMQ_MAX_INDEX_LEN Maximum UMQ index length.
static int	UMQ_MAX_QUEUE_STRLEN Maximum UMQ queue length.
static int	UMQ_MAX_TOPIC_STRLEN Maximum UMQ queue topic name length.
static int	UMQ_QUEUE_MSG_STATUS_ASSIGNED Queue message status; message is currently assigned to a receiver but not yet consumed.
static int	UMQ_QUEUE_MSG_STATUS_CONSUMED Queue message status; message has been fully consumed and is no longer present in the queue.
static int	UMQ_QUEUE_MSG_STATUS_REASSIGNING Queue message status; message is waiting to be re-assigned to a different receiver.
static int	UMQ_QUEUE_MSG_STATUS_UNASSIGNED Queue message status; message is currently enqueued but not yet assigned.
static int	UMQ_QUEUE_MSG_STATUS_UNKNOWN Queue message status; queue has no knowledge of the message.
static int	UMQ_ULB_MAX_RECEIVER_STRLEN Maximum UMQ ULB receiver length.
static int	WILDCARD_RCV_PATTERN_TYPE_APP_CB Wildcard receiver pattern type: callback
static int	WILDCARD_RCV_PATTERN_TYPE_PCRE Wildcard receiver pattern type: PCRE (Perl Compatible Regular Expressions)
static int	WILDCARD_RCV_PATTERN_TYPE_REGEX Wildcard receiver pattern type: POSIX regex

Constructor Summary

LBM()
Instantiate LBM utility class (initializes log)

Method Summary

static void	asyncOperationCancel(long handle) Cancel the asynchronous operation referred to by the given handle.
static void	asyncOperationCancel(long handle, int flags) Cancel the asynchronous operation referred to by the given handle.
static void	asyncOperationStatus(long handle) Query the status of the asynchronous operation referred to by the given handle.
static void	asyncOperationStatus(long handle, int flags) Query the status of the asynchronous operation referred to by the given handle.
static void	dumpDebugLog(java.lang.String filename, boolean append) Dump the in-memory LBM debug log to a specified file.
protected void	finalize()
protected void	log(int level, java.lang.String message) Logging callback.
static void	setConfiguration(java.lang.String fileName) Configure LBM attributes from a file, tftp or http URL.
static void	setConfigurationXml(java.lang.String fileName, java.lang.String applicationName) Configure LBM attributes from a file, tftp or http URL.
static void	setConfigurationXmlString(java.lang.String xmlString, java.lang.String applicationName) Configure LBM attributes from a String
static void	setDebugFilename(java.lang.String filename) Set the LBM debug filename.
static void	setDebugMask(long mask) Set the LBM debug mask, as suggested by the support team.
static void	setLicenseFile(java.lang.String licenseFile) Initialize the LBM license from the contents of a disk file.
static void	setLicenseString(java.lang.String licenseString) Initialize the LBM license from a string.
void	setLogger(LBMLogging logger) Inform LBM to use a specific logger for logging
static void	setUmmInfo(LBMUMMInfo info) Connect to and retrieve configuration from a UMM daemon.
static java.lang.String	version() Get LBM version information.

Methods inherited from class java.lang.Object

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

Field Detail

EINVAL

public static final int EINVAL

LBM error: An invalid argument was passed.

See Also:

Constant Field Values

EWOULDBLOCK

public static final int EWOULDBLOCK

LBM error: Function would block, but object is set to be nonblocking.

See Also:

Constant Field Values

ENOMEM

public static final int ENOMEM

LBM error: Operation could not be completed due to memory allocation error.

See Also:

Constant Field Values

EOP

public static final int EOP

LBM error: Operation was invalid due to error in internal processing.

See Also:

Constant Field Values

EOS

public static final int EOS

LBM error: Operation failed due to unrecoverable OS system call error.

See Also:

Constant Field Values

ETIMEDOUT

public static final int ETIMEDOUT

LBM error: Operation timed out waiting to complete.

See Also:

Constant Field Values

EDAEMONCONN

public static final int EDAEMONCONN

LBM error: LBM daemon connection not connected.

See Also:

Constant Field Values

EUMENOREG

public static final int EUMENOREG

LBM error: UME registration not completed.

See Also:

Constant Field Values

EAPPERR

public static final int EAPPERR

LBM error: Application Error .

See Also:

Constant Field Values

ENO_QUEUE_REG

public static final int ENO_QUEUE_REG

LBM error: The store is not fully registered.

See Also:

Constant Field Values

ENO_STORE_REG

public static final int ENO_STORE_REG

LBM error: The queue is not fully registered.

See Also:

Constant Field Values

EMSG_SELECTOR

public static final int EMSG_SELECTOR

LBM error: Error parsing message selector.

See Also:

Constant Field Values

MSG_DATA

public static final int MSG_DATA

LBM message type: Data message. Data is valid.

See Also:

Constant Field Values

MSG_EOS

public static final int MSG_EOS

LBM message type: End of Transport Session from source.

See Also:

Constant Field Values

MSG_REQUEST

public static final int MSG_REQUEST

LBM message type: Request message from source.

See Also:

Constant Field Values

MSG_RESPONSE

public static final int MSG_RESPONSE

LBM message type: Response message from requestee.

See Also:

Constant Field Values

MSG_UNRECOVERABLE_LOSS

public static final int MSG_UNRECOVERABLE_LOSS

LBM message type: Missing message detected and not recovered in given time.

See Also:

Constant Field Values

MSG_UNRECOVERABLE_LOSS_BURST

public static final int MSG_UNRECOVERABLE_LOSS_BURST

LBM message type: Missing burst of messages detected and not recovered.

See Also:

Constant Field Values

MSG_NO_SOURCE_NOTIFICATION

public static final int MSG_NO_SOURCE_NOTIFICATION

Notification that no source has been found for topic. Still querying for topic source.

See Also:

Constant Field Values

MSG_UME_REGISTRATION_ERROR

public static final int MSG_UME_REGISTRATION_ERROR

UME receiver registration encountered an error. Data holds error message.

See Also:

Constant Field Values

MSG_UME_REGISTRATION_SUCCESS

public static final int MSG_UME_REGISTRATION_SUCCESS

UME receiver registration successful.

See Also:

LBMMessage.sourceRegistrationId(), LBMMessage.receiverRegistrationId(), Constant Field Values

MSG_UME_REGISTRATION_CHANGE

public static final int MSG_UME_REGISTRATION_CHANGE

UME receiver notification of source registration change. Data holds info message.

See Also:

Constant Field Values

MSG_UME_REGISTRATION_SUCCESS_EX

public static final int MSG_UME_REGISTRATION_SUCCESS_EX

UME receiver registration successful (extended version). Registration info (in the form of a UMERegistrationSuccessInfo object) can be retrieved with the LBMMessage.registrationSuccessInfo() method.

Since:

UME 2.0

See Also:

UMERegistrationSuccessInfo, LBMMessage.registrationSuccessInfo(), Constant Field Values

MSG_UME_REGISTRATION_COMPLETE_EX

public static final int MSG_UME_REGISTRATION_COMPLETE_EX

UME receiver notification of registration completion. Registration completion info (in the form of a UMERegistrationCompleteInfo object) can be retrieved with the LBMMessage.registrationCompleteInfo() method.

Since:

UME 2.0

See Also:

UMERegistrationCompleteInfo, LBMMessage.registrationCompleteInfo(), Constant Field Values

MSG_UME_DEREGISTRATION_SUCCESS_EX

public static final int MSG_UME_DEREGISTRATION_SUCCESS_EX

UME receiver deregistration successful (extended version). Deregistration info (in the form of a UMEDeregistrationSuccessInfo object) can be retrieved with the LBMMessage.deregistrationSuccessInfo() method.

Since:

UME 5.3

See Also:

UMEDeregistrationSuccessInfo, LBMMessage.deregistrationSuccessInfo(), Constant Field Values

MSG_UME_DEREGISTRATION_COMPLETE_EX

public static final int MSG_UME_DEREGISTRATION_COMPLETE_EX

UME receiver notification of deregistration completion. Deregistration completion info (in the form of a UMEDeregistrationCompleteInfo object) can be retrieved with the LBMMessage.deregistrationCompleteInfo() method.

Since:

UME 5.3

See Also:

UMEDeregistrationCompleteInfo, LBMMessage.deregistrationCompleteInfo(), Constant Field Values

MSG_UMQ_REGISTRATION_ERROR

public static final int MSG_UMQ_REGISTRATION_ERROR

UMQ receiver notification of registration error. Registration error information (in the form of a string) can be retrieved with the LBMMessage.dataString() method.

Since:

UME 3.0

See Also:

LBMMessage.dataString(), Constant Field Values

MSG_UMQ_REGISTRATION_COMPLETE_EX

public static final int MSG_UMQ_REGISTRATION_COMPLETE_EX

UMQ receiver notification of registration completion. Registration completion info (in the form of a UMQRegistrationCompleteInfo object) can be retrieved with the LBMMessage.queueRegistrationCompleteInfo() method.

Since:

UME 3.0

See Also:

UMQRegistrationCompleteInfo, LBMMessage.queueRegistrationCompleteInfo(), Constant Field Values

MSG_UMQ_DEREGISTRATION_COMPLETE_EX

public static final int MSG_UMQ_DEREGISTRATION_COMPLETE_EX

UMQ receiver notification of deregistration completion. Deregistration completion info (in the form of a UMQDeregistrationCompleteInfo object) can be retrieved with the LBMMessage.queueDeregistrationCompleteInfo() method.

Since:

UME 3.0

See Also:

UMQDeregistrationCompleteInfo, LBMMessage.queueDeregistrationCompleteInfo(), Constant Field Values

MSG_BOS

public static final int MSG_BOS

LBM message type: Beginning of Transport Session from source.

See Also:

Constant Field Values

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_ERROR

public static final int MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_ERROR

LBM message type: UMQ receiver index assignment eligibility start/stop encountered an error. Data holds error message.

Since:

UMQ 1.2

See Also:

Constant Field Values

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX

public static final int MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX

LBM message type: UMQ receiver notification of beginning of index assignment eligibility. Index assignment eligibility start completion info (in the form of a UMQIndexAssignmentEligibilityStartCompleteInfo object) can be retrieved with the LBMMessage#indexAssignmentEligibilityStartCompleteInfo() method.

Since:

UMQ 1.2

See Also:

UMQIndexAssignmentEligibilityStartCompleteInfo, LBMMessage#indexAssignmentEligibilityStartCompleteInfo(), Constant Field Values

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX

public static final int MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX

LBM message type: UMQ receiver notification of end of index assignment eligibility. Index assignment eligibility stop completion info (in the form of a UMQIndexAssignmentEligibilityStopCompleteInfo object) can be retrieved with the LBMMessage#indexAssignmentEligibilityStopCompleteInfo() method.

Since:

UMQ 1.2

See Also:

UMQIndexAssignmentEligibilityStopCompleteInfo, LBMMessage#indexAssignmentEligibilityStopCompleteInfo(), Constant Field Values

MSG_UMQ_INDEX_ASSIGNED_EX

public static final int MSG_UMQ_INDEX_ASSIGNED_EX

LBM message type: UMQ receiver notification of assignment of a particular index from a particular queue or ULB source. Index assignment info (in the form of a UMQIndexAssignedInfo object) can be retrieved with the LBMMessage#indexAssignedInfo() method.

Since:

UMQ 1.2

See Also:

UMQIndexAssignedInfo, LBMMessage#indexAssignedInfo(), Constant Field Values

MSG_UMQ_INDEX_RELEASED_EX

public static final int MSG_UMQ_INDEX_RELEASED_EX

LBM message type: UMQ receiver notification of end of assignment of a particular index from a particular queue or ULB source. Index assignment info (in the form of a UMQIndexReleasedInfo object) can be retrieved with the LBMMessage#indexReleasedInfo() method.

Since:

UMQ 1.2

See Also:

UMQIndexReleasedInfo, LBMMessage#indexReleasedInfo(), Constant Field Values

MSG_HF_RESET

public static final int MSG_HF_RESET

LBM message type: Hot failover notification that the expected sequence number has been reset via a source send reset.

See Also:

LBMMessage.hfSequenceNumber(), MSG_FLAG_HF_32, MSG_FLAG_HF_64, Constant Field Values

SRC_EVENT_UME_DEREGISTRATION_SUCCESS_EX

public static final int SRC_EVENT_UME_DEREGISTRATION_SUCCESS_EX

UME source deregistration successful (extended version). Deregistration info (in the form of a UMESourceEventDeregistrationSuccessInfo object) can be retrieved with the LBMMessage#SourceEventderegistrationSuccessInfo() method.

Since:

UME 5.3

See Also:

UMESourceEventDeregistrationSuccessInfo, LBMMessage#SourceEventderegistrationSuccessInfo(), Constant Field Values

SRC_EVENT_UME_DEREGISTRATION_COMPLETE_EX

public static final int SRC_EVENT_UME_DEREGISTRATION_COMPLETE_EX

UME source notification of deregistration completion. Deregistration completion info (in the form of a UMESourceEventDeregistrationCompleteInfo object) can be retrieved with the LBMMessage#SourceEventderegistrationCompleteInfo() method.

Since:

UME 5.3

See Also:

UMESourceEventDeregistrationCompleteInfo, LBMMessage#SourceEventderegistrationCompleteInfo(), Constant Field Values

MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD

public static final int MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD

Registration was flagged as an old receiver by the store. An old receiver is one the store had cached. This flag may be set in an extended UME registration success message.

Since:

UME 2.0

See Also:

MSG_UME_REGISTRATION_SUCCESS_EX, UMERegistrationSuccessInfo.flags(), Constant Field Values

MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_NOCACHE

public static final int MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_NOCACHE

Registration was flagged as coming from a store that is configured to not cache data. This flag may be set in an extended UME registration success message.

Since:

UME 2.0

See Also:

MSG_UME_REGISTRATION_SUCCESS_EX, UMERegistrationSuccessInfo.flags(), Constant Field Values

MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP

public static final int MSG_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP

Registration was flagged as coming from a store that has allowed a RPP receiver.. Flag for UME receiver registration complete messages.

Since:

UME 5.3

See Also:

MSG_UME_REGISTRATION_COMPLETE_EX, UMERegistrationCompleteInfo.flags(), Constant Field Values

MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

public static final int MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

Registration completed with only quorum reached. Flag for UME receiver registration complete messages.

Since:

UME 2.0

See Also:

MSG_UME_REGISTRATION_COMPLETE_EX, UMERegistrationCompleteInfo.flags(), Constant Field Values

MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_RXREQMAX

public static final int MSG_UME_REGISTRATION_COMPLETE_EX_FLAG_RXREQMAX

Registration completed with RX REQ maximum used.

Since:

UME 2.0

See Also:

MSG_UME_REGISTRATION_COMPLETE_EX, UMERegistrationCompleteInfo.flags(), Constant Field Values

MSG_UME_DEREGISTRATION_SUCCESS_EX_FLAG_RPP

public static final int MSG_UME_DEREGISTRATION_SUCCESS_EX_FLAG_RPP

Deregistration was flagged as coming from a RPP store

Since:

UME 5.3

See Also:

UMEDeregistrationCompleteInfo.flags(), Constant Field Values

MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

public static final int MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

Registration completed with only quorum reached. Flag for UMQ receiver registration complete messages.

Since:

UME 3.0

See Also:

MSG_UMQ_REGISTRATION_COMPLETE_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_ULB

public static final int MSG_UMQ_REGISTRATION_COMPLETE_EX_FLAG_ULB

Registration completed with ULB source. Flag for UMQ receiver registration complete messages.

Since:

UMQ 1.1

See Also:

MSG_UMQ_REGISTRATION_COMPLETE_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_DEREGISTRATION_COMPLETE_EX_FLAG_ULB

public static final int MSG_UMQ_DEREGISTRATION_COMPLETE_EX_FLAG_ULB

Deregistration completed with ULB source. Flag for UMQ receiver registration complete messages.

Since:

UMQ 1.1

See Also:

MSG_UMQ_DEREGISTRATION_COMPLETE_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_INDEX_ASSIGNED_FLAG_ULB

public static final int MSG_UMQ_INDEX_ASSIGNED_FLAG_ULB

Index assignment was from a ULB source. Flag for UMQ receiver index assignment messages.

Since:

UMQ 1.2

See Also:

MSG_UMQ_INDEX_ASSIGNED_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_INDEX_RELEASED_FLAG_ULB

public static final int MSG_UMQ_INDEX_RELEASED_FLAG_ULB

Index released from a ULB source. Flag for UMQ receiver index released messages.

Since:

UMQ 1.2

See Also:

MSG_UMQ_INDEX_RELEASED_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX_FLAG_ULB

public static final int MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX_FLAG_ULB

Index assignment eligibility stop completed at a ULB source. Flag for UMQ receiver index assignment eligibility stop complete messages.

Since:

UMQ 1.2

See Also:

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_STOP_COMPLETE_EX, UMQQueueInfo.flags(), Constant Field Values

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX_FLAG_ULB

public static final int MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX_FLAG_ULB

Index assignment eligibility start completed at a ULB source. Flag for UMQ receiver index assignment eligibility start complete messages.

Since:

UMQ 1.2

See Also:

MSG_UMQ_INDEX_ASSIGNMENT_ELIGIBILITY_START_COMPLETE_EX, UMQQueueInfo.flags(), Constant Field Values

CHAIN_ELEM_USER_DATA

public static final byte CHAIN_ELEM_USER_DATA

Application header type representing user data.

Since:

UMQ 1.1

See Also:

Constant Field Values

MSG_START_BATCH

public static final int MSG_START_BATCH

Sending/receiving flag: Start batch

See Also:

Constant Field Values

MSG_END_BATCH

public static final int MSG_END_BATCH

Sending/receiving flag: End batch (Batch should be sent ASAP)

See Also:

Constant Field Values

MSG_COMPLETE_BATCH

public static final int MSG_COMPLETE_BATCH

Sending/receiving flag: Message is complete batch (Batch should be sent ASAP)

See Also:

Constant Field Values

MSG_FLUSH

public static final int MSG_FLUSH

Sending flag: Flush messages. Message is to be sent ASAP (not implicitly or explicitly batched). This also flushes waiting messages that were explicitly or implicitly batched

See Also:

Constant Field Values

SRC_NONBLOCK

public static final int SRC_NONBLOCK

If message could not be sent immediately, throw LBMEWouldBlockException

See Also:

LBMEWouldBlockException, Constant Field Values

SRC_BLOCK

public static final int SRC_BLOCK

Block the caller indefinitely until the message is sent.

See Also:

Constant Field Values

MSG_FLAG_START_BATCH

public static final int MSG_FLAG_START_BATCH

Receiving flag: Start batch

See Also:

Constant Field Values

MSG_FLAG_END_BATCH

public static final int MSG_FLAG_END_BATCH

Receiving flag: End batch

See Also:

Constant Field Values

MSG_FLAG_HF_PASS_THROUGH

public static final int MSG_FLAG_HF_PASS_THROUGH

Receiving flag: Non-HF message

See Also:

Constant Field Values

MSG_FLAG_UME_RETRANSMIT

public static final int MSG_FLAG_UME_RETRANSMIT

Receiving flag: Retransmitted message

See Also:

Constant Field Values

MSG_FLAG_RETRANSMIT

public static final int MSG_FLAG_RETRANSMIT

Receiving flag: Retransmitted message

See Also:

Constant Field Values

MSG_FLAG_IMMEDIATE

public static final int MSG_FLAG_IMMEDIATE

Receiving flag: Immediate message

See Also:

Constant Field Values

MSG_FLAG_HF_DUPLICATE

public static final int MSG_FLAG_HF_DUPLICATE

Receiving flag: Hot failover duplicate message

See Also:

Constant Field Values

MSG_FLAG_UMQ_REASSIGNED

public static final int MSG_FLAG_UMQ_REASSIGNED

Receiving flag: Reassigned UMQ message

See Also:

Constant Field Values

MSG_FLAG_UMQ_RESUBMITTED

public static final int MSG_FLAG_UMQ_RESUBMITTED

Receiving flag; Resubmitted UMQ message

See Also:

Constant Field Values

MSG_FLAG_TOPICLESS

public static final int MSG_FLAG_TOPICLESS

Receiving flag; Message has no topic.

See Also:

Constant Field Values

MSG_FLAG_DELIVERY_LATENCY

public static final int MSG_FLAG_DELIVERY_LATENCY

See Also:

Constant Field Values

MSG_FLAG_HF_OPTIONAL

public static final int MSG_FLAG_HF_OPTIONAL

Receiving flag: Hot Failover optional message

See Also:

Constant Field Values

MSG_FLAG_HF_32

public static final int MSG_FLAG_HF_32

Receiving flag: The message contains a 32 bit hot failover sequence number

See Also:

Constant Field Values

MSG_FLAG_HF_64

public static final int MSG_FLAG_HF_64

Receiving flag: The message contains a 64 bit hot failover sequence number.

See Also:

Constant Field Values

MSG_FLAG_OTR

public static final int MSG_FLAG_OTR

Receiving flag: The message was recovered via OTR

See Also:

Constant Field Values

MSG_FLAG_NUMBERED_CHANNEL

public static final int MSG_FLAG_NUMBERED_CHANNEL

Channel flag: Numbered channel message

See Also:

Constant Field Values

MSG_PROPERTY_BOOLEAN

public static final int MSG_PROPERTY_BOOLEAN

Message property type: boolean

See Also:

Constant Field Values

MSG_PROPERTY_BYTE

public static final int MSG_PROPERTY_BYTE

Message property type: byte

See Also:

Constant Field Values

MSG_PROPERTY_SHORT

public static final int MSG_PROPERTY_SHORT

Message property type: short

See Also:

Constant Field Values

MSG_PROPERTY_INT

public static final int MSG_PROPERTY_INT

Message property type: int

See Also:

Constant Field Values

MSG_PROPERTY_LONG

public static final int MSG_PROPERTY_LONG

Message property type: long

See Also:

Constant Field Values

MSG_PROPERTY_FLOAT

public static final int MSG_PROPERTY_FLOAT

Message property type: float

See Also:

Constant Field Values

MSG_PROPERTY_DOUBLE

public static final int MSG_PROPERTY_DOUBLE

Message property type: double

See Also:

Constant Field Values

MSG_PROPERTY_STRING

public static final int MSG_PROPERTY_STRING

Message property type: string

See Also:

Constant Field Values

SRC_EVENT_CONNECT

public static final int SRC_EVENT_CONNECT

Source event: For unicast transport, means receiver has connected.

See Also:

Constant Field Values

SRC_EVENT_DISCONNECT

public static final int SRC_EVENT_DISCONNECT

Source event: For unicast transport, means receiver has disconnected.

See Also:

Constant Field Values

SRC_EVENT_WAKEUP

public static final int SRC_EVENT_WAKEUP

Source event: Following earlier LBMEWouldBlockException, this event means that the source is ready for more sends.

See Also:

LBMEWouldBlockException, Constant Field Values

SRC_EVENT_WAKEUP_FLAG_NORMAL

public static final int SRC_EVENT_WAKEUP_FLAG_NORMAL

Source wakeup event flag: Unblocked source is a normal (or hot failover) source.

See Also:

LBMSourceEventWakeupInfo, Constant Field Values

SRC_EVENT_WAKEUP_FLAG_MIM

public static final int SRC_EVENT_WAKEUP_FLAG_MIM

Source wakeup event flag: Unblocked source is a context-level multicast immediate mode source.

See Also:

LBMSourceEventWakeupInfo, Constant Field Values

SRC_EVENT_WAKEUP_FLAG_UIM

public static final int SRC_EVENT_WAKEUP_FLAG_UIM

Source wakeup event flag: Unblocked source is a context-level unicast immediate mode source.

See Also:

LBMSourceEventWakeupInfo, Constant Field Values

SRC_EVENT_WAKEUP_FLAG_REQUEST

public static final int SRC_EVENT_WAKEUP_FLAG_REQUEST

Source wakeup event flag: Unblocked source is a context-level request source.

See Also:

LBMSourceEventWakeupInfo, Constant Field Values

SRC_EVENT_WAKEUP_FLAG_RESPONSE

public static final int SRC_EVENT_WAKEUP_FLAG_RESPONSE

Source wakeup event flag: Unblocked source is a context-level response source.

See Also:

LBMSourceEventWakeupInfo, Constant Field Values

SRC_EVENT_DAEMON_CONFIRM

public static final int SRC_EVENT_DAEMON_CONFIRM

Source event: For LBM daemon usage only, means daemon has confirmed src created

See Also:

Constant Field Values

SRC_EVENT_UME_REGISTRATION_ERROR

public static final int SRC_EVENT_UME_REGISTRATION_ERROR

Source event: (UME only) Registration of source failed with an error. Event data holds the error string.

See Also:

Constant Field Values

SRC_EVENT_UME_REGISTRATION_SUCCESS

public static final int SRC_EVENT_UME_REGISTRATION_SUCCESS

Source event: (UME only) Registration of source successful. Event data holds the registration ID

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE

public static final int SRC_EVENT_UME_MESSAGE_STABLE

Source event: (UME only) UME ACK from store indicates message is stable. Event data holds ACK information which includes the registration ID, the message sequence number, and the client object argument passed into the LBMSource.send() method.

See Also:

LBMSource.send(byte[],int,int,Object), Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION

Source event: (UME only) UME Confirmed Delivery of Message from a receiver. Event data holds ACK information which includes the registration ID, the message sequence number, and the client object argument passed into the LBMSource.send() method.

See Also:

LBMSource.send(byte[],int,int,Object), Constant Field Values

SRC_EVENT_UME_STORE_UNRESPONSIVE

public static final int SRC_EVENT_UME_STORE_UNRESPONSIVE

Source event: (UME only) Store has not been active within timeout. Event data holds an info string.

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_RECLAIMED

public static final int SRC_EVENT_UME_MESSAGE_RECLAIMED

Source event: (UME only) Indicates that a message has been reclaimed. Event data holds the message sequence number and the client object argument passed into the LBMSource.send() method.

See Also:

LBMSource.send(byte[],int,int,Object), Constant Field Values

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX

public static final int SRC_EVENT_UME_REGISTRATION_SUCCESS_EX

Source event: (UME only) Registration of source successful (extended version). Data (in the form of a UMESourceEventRegistrationSuccessInfo object) can be retrieved with the LBMSourceEvent.registrationSuccessInfo() method.

Since:

UME 2.0

See Also:

UMESourceEventRegistrationSuccessInfo, LBMSourceEvent.registrationSuccessInfo(), Constant Field Values

SRC_EVENT_UME_REGISTRATION_COMPLETE_EX

public static final int SRC_EVENT_UME_REGISTRATION_COMPLETE_EX

Source event: (UME only) Registration of source complete. Data (in the form of a UMESourceEventRegistrationCompleteInfo object) can be retrieved with the LBMSourceEvent.registrationCompleteInfo() method.

Since:

UME 2.0

See Also:

UMESourceEventRegistrationCompleteInfo, LBMSourceEvent.registrationCompleteInfo(), Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX

Source event: For UME only, means UME ACK from store indicates message is stable (extended form). Event data holds ACK information.

Since:

UME 2.0

See Also:

UMESourceEventMessageStableInfo, LBMSourceEvent#messageStableInfo(), Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX

Source event: For UME only, means UME Confirmed Delivery of Message from receiver (extended form). Event data holds ACK information.

Since:

UME 2.0

See Also:

UMESourceEventDeliveryConfirmationInfo, LBMSourceEvent#deliveryConfirmationInfo(), Constant Field Values

SRC_EVENT_SEQUENCE_NUMBER_INFO

public static final int SRC_EVENT_SEQUENCE_NUMBER_INFO

Source event: Informs the application of the sequence numbers used with a message. Event data holds sequence number data.

Since:

UME 2.0/LBM 3.3

See Also:

LBMSourceEventSequenceNumberInfo, LBMSourceEvent.sequenceNumberInfo(), Constant Field Values

SRC_EVENT_UMQ_REGISTRATION_ERROR

public static final int SRC_EVENT_UMQ_REGISTRATION_ERROR

Source event: For UMQ only, means registration of source failed with an error. The dataString() method will return the error message.

Since:

UME 3.0

See Also:

LBMSourceEvent.dataString(), Constant Field Values

SRC_EVENT_UMQ_MESSAGE_ID_INFO

public static final int SRC_EVENT_UMQ_MESSAGE_ID_INFO

Source event: For UMQ only, informs the application of the Message ID assigned with a message. The messageIdInfo() method will return an info object containing additional information.

Since:

UME 3.0

See Also:

LBMSourceEvent#messageIdInfo), Constant Field Values

SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX

public static final int SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX

Source event: For UMQ only, means registration of source complete. The queueRegistrationCompleteInfo() method will return an info object containing additional information.

Since:

UME 3.0

See Also:

LBMSourceEvent.queueRegistrationCompleteInfo(), Constant Field Values

SRC_EVENT_UMQ_MESSAGE_STABLE_EX

public static final int SRC_EVENT_UMQ_MESSAGE_STABLE_EX

Source event: For UMQ only, means a message is stable with the a queue instance. The queueAckInfo() method will return an info object containing additional information.

Since:

UME 3.0

See Also:

LBMSourceEvent.queueAckInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_ASSIGNED_EX

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_ASSIGNED_EX

Source event: For UMQ only, means a ULB message has been assigned to a receiver. The ulbMessageInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbMessageInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_REASSIGNED_EX

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_REASSIGNED_EX

Source event: For UMQ only, means a ULB message has been reassigned from a receiver. The ulbMessageInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbMessageInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX

Source event: For UMQ only, means a ULB message has been reached end-of-life. The ulbMessageInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbMessageInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_COMPLETE_EX

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_COMPLETE_EX

Source event: For UMQ only, means a ULB message has been consumed or discarded from all application sets. The ulbMessageInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbMessageInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_CONSUMED_EX

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_CONSUMED_EX

Source event: For UMQ only, means a ULB message has been consumed by a receiver. The ulbMessageInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbMessageInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_RECEIVER_REGISTRATION_EX

public static final int SRC_EVENT_UMQ_ULB_RECEIVER_REGISTRATION_EX

Source event: For UMQ only, means a receiver has registered with the source. The ulbReceiverInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbReceiverInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_RECEIVER_DEREGISTRATION_EX

public static final int SRC_EVENT_UMQ_ULB_RECEIVER_DEREGISTRATION_EX

Source event: For UMQ only, means a receiver has deregistered from the source. The ulbReceiverInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbReceiverInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_RECEIVER_READY_EX

public static final int SRC_EVENT_UMQ_ULB_RECEIVER_READY_EX

Source event: For UMQ only, means a receiver has signalled it is ready for messages to be assigned to it. The ulbReceiverInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbReceiverInfo(), Constant Field Values

SRC_EVENT_UMQ_ULB_RECEIVER_TIMEOUT_EX

public static final int SRC_EVENT_UMQ_ULB_RECEIVER_TIMEOUT_EX

Source event: For UMQ only, means a receiver has reached end-of-life. The ulbReceiverInfo() method will return an info object containing additional information.

Since:

UMQ 1.1

See Also:

LBMSourceEvent.ulbReceiverInfo(), Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION

Source event: flight size notification. The flightSizeNotification() method will return an info object containing additional information.

Since:

UME 3.1

See Also:

LBMSourceEvent.flightSizeNotification(), Constant Field Values

SRC_EVENT_UME_MESSAGE_RECLAIMED_EX

public static final int SRC_EVENT_UME_MESSAGE_RECLAIMED_EX

Source event: Indicates that a message has been reclaimed (extended version). Event data holds ACK information.

See Also:

LBMSource.send(byte[],int,int,Object), Constant Field Values

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD

public static final int SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_OLD

Registration was flagged as an old source by the store. An old source is one the store had cached.

Since:

UME 2.0

See Also:

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX, UMESourceEventRegistrationSuccessInfo.flags(), Constant Field Values

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_NOACKS

public static final int SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_NOACKS

Registration was flagged as coming from a store that is configured to not send ACKs for stability (no-cache store).

Since:

UME 2.0

See Also:

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX, UMESourceEventRegistrationSuccessInfo.flags(), Constant Field Values

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP

public static final int SRC_EVENT_UME_REGISTRATION_SUCCESS_EX_FLAG_RPP

Registration was flagged as coming from a store that allows and has accepted RPP persistent topics

Since:

UME 5.3

See Also:

SRC_EVENT_UME_REGISTRATION_SUCCESS_EX, UMESourceEventRegistrationSuccessInfo.flags(), Constant Field Values

SRC_EVENT_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

public static final int SRC_EVENT_UME_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

Registration completed with only quorum reached.

Since:

UME 2.0

See Also:

SRC_EVENT_UME_REGISTRATION_COMPLETE_EX, UMESourceEventRegistrationCompleteInfo.flags(), Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UNIQUEACKS

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UNIQUEACKS

Confirmation received for specified number of unique ACKs.

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UREGID

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_UREGID

Confirmation received with User Specified Rcv Registration ID flagged.

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_OOD

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_OOD

Confirmation received with Out-of-Order Delivery (OOD) flagged.

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_EXACK

public static final int SRC_EVENT_UME_DELIVERY_CONFIRMATION_EX_FLAG_EXACK

Confirmation received with Explicit ACK (EXACK) flagged.

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE

Message stable for intragroup stability

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE

Message stable for intergroup stability

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STABLE

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STABLE

Message is stable according to behavior desired

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STORE

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_STORE

Message stable information has active store information

Since:

UME 2.0

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_WHOLE_MESSAGE_STABLE

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_WHOLE_MESSAGE_STABLE

Whole message (each fragment) is stable

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_USER

public static final int SRC_EVENT_UME_MESSAGE_STABLE_EX_FLAG_USER

Message stabilized via the setUMEMessageStable API

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_UME_MESSAGE_RECLAIMED_EX_FLAG_FORCED

public static final int SRC_EVENT_UME_MESSAGE_RECLAIMED_EX_FLAG_FORCED

Reclaim notification is the result of a forced reclaim

Since:

UME 3.2

See Also:

Constant Field Values

SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

public static final int SRC_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

Flag indicating that registration completed with only quorum reached.

Since:

UME 3.0

See Also:

Constant Field Values

SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE

public static final int SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTRAGROUP_STABLE

Flag indicating that a message is stable within a group.

Since:

UME 3.0

See Also:

Constant Field Values

SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE

public static final int SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_INTERGROUP_STABLE

Flag indicating that a message is stable across groups according to behavior desired.

Since:

UME 3.0

See Also:

Constant Field Values

SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_STABLE

public static final int SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_STABLE

Flag indicating that a message is stable according to behavior desired.

Since:

UME 3.0

See Also:

Constant Field Values

SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_USER

public static final int SRC_EVENT_UMQ_MESSAGE_STABLE_EX_FLAG_USER

Message stabilized via the setUMQMessageStable API

Since:

UMQ 1.1

See Also:

Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UME

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UME

Specifies a UME flight size.

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_ULB

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_ULB

Specifies a ULB flight size.

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UMQ

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_TYPE_UMQ

Specifies a UMQ flight size.

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_OVER

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_OVER

Messages in flight has exceeded the threshold.

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_UNDER

public static final int SRC_EVENT_FLIGHT_SIZE_NOTIFICATION_STATE_UNDER

Messages in flight is now below the threshold.

Since:

UME 3.1

See Also:

Constant Field Values

FLIGHT_SIZE_TYPE_UME

public static final int FLIGHT_SIZE_TYPE_UME

Specify a UME flight size

Since:

UME 3.1

See Also:

Constant Field Values

FLIGHT_SIZE_TYPE_ULB

public static final int FLIGHT_SIZE_TYPE_ULB

Specify a ULB flight size

Since:

UME 3.1

See Also:

Constant Field Values

FLIGHT_SIZE_TYPE_UMQ

public static final int FLIGHT_SIZE_TYPE_UMQ

Specify a UMQ flight size

Since:

UME 3.1

See Also:

Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_TOTAL_LIFETIME_EXPIRED

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_TOTAL_LIFETIME_EXPIRED

Timeout is the result of the total lifetime expiring

Since:

UMQ 2.2

See Also:

Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_EXPLICIT

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_EXPLICIT

Timeout is the result of the reassign API being called by a receiver

Since:

UMQ 2.2

See Also:

Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_DISCARD

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_DISCARD

Timeout is the result of the reassign API being called with the DISCARD flag set

Since:

UMQ 2.2

See Also:

Constant Field Values

SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_MAX_REASSIGNS

public static final int SRC_EVENT_UMQ_ULB_MESSAGE_TIMEOUT_EX_FLAG_MAX_REASSIGNS

Timeout is the result of hitting the umq_ulb_application_set_message_max_reassignments number of assignments

Since:

UMQ 2.2

See Also:

Constant Field Values

CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX

public static final int CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX

Indicates context registration is complete.

Since:

UME 3.0

See Also:

Constant Field Values

CONTEXT_EVENT_UMQ_REGISTRATION_SUCCESS_EX

public static final int CONTEXT_EVENT_UMQ_REGISTRATION_SUCCESS_EX

Indicates context registration with a single queue instance was successful.

Since:

UME 3.0

See Also:

Constant Field Values

CONTEXT_EVENT_UMQ_REGISTRATION_ERROR

public static final int CONTEXT_EVENT_UMQ_REGISTRATION_ERROR

Indicates context registration failed with an error.

Since:

UME 3.0

See Also:

Constant Field Values

CONTEXT_EVENT_UMQ_INSTANCE_LIST_NOTIFICATION

public static final int CONTEXT_EVENT_UMQ_INSTANCE_LIST_NOTIFICATION

Indicates that the queue instance list has changed.

Since:

UME 3.0

See Also:

Constant Field Values

CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

public static final int CONTEXT_EVENT_UMQ_REGISTRATION_COMPLETE_EX_FLAG_QUORUM

Flag indicating that registration completed with only quorum reached.

Since:

UME 3.0

See Also:

Constant Field Values

SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO

public static final int SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO

Inform application of the sequence numbers used for message.

Since:

UME 2.0

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY

public static final int SRC_SEND_EX_FLAG_SEQUENCE_NUMBER_INFO_FRAGONLY

Inform application of the sequence numbers used for message (fragmented messages only).

Since:

UME 2.0

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_APPHDR_CHAIN

public static final int SRC_SEND_EX_FLAG_APPHDR_CHAIN

Send message with included application header chain.

Since:

UMQ 1.1

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_UMQ_MESSAGE_ID_INFO

public static final int SRC_SEND_EX_FLAG_UMQ_MESSAGE_ID_INFO

Inform application of the UMQ Message ID used for the message.

Since:

UME 3.0

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_CHANNEL

public static final int SRC_SEND_EX_FLAG_CHANNEL

Send message with included channel information.

Since:

LBM 3.6

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_UMQ_INDEX

public static final int SRC_SEND_EX_FLAG_UMQ_INDEX

Send messages associating them with the supplied UMQ index

Since:

UMQ 1.2

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_UMQ_TOTAL_LIFETIME

public static final int SRC_SEND_EX_FLAG_UMQ_TOTAL_LIFETIME

Send message with supplied total lifetime

Since:

UMQ 2.2

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_HF_OPTIONAL

public static final int SRC_SEND_EX_FLAG_HF_OPTIONAL

Send message marked as an optional message for Hot Failover

Since:

UMS 4.2

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_PROPERTIES

public static final int SRC_SEND_EX_FLAG_PROPERTIES

Send message with supplied properties

Since:

UMS 5.1

See Also:

LBMSource.send(byte[], int, int, LBMSourceSendExInfo), Constant Field Values

SRC_SEND_EX_FLAG_HF_32

public static final int SRC_SEND_EX_FLAG_HF_32

Send message with a 64 bit hot failover sequence number.

Since:

UMS 5.2.1

See Also:

Constant Field Values

SRC_SEND_EX_FLAG_HF_64

public static final int SRC_SEND_EX_FLAG_HF_64

Send message with a 32 bit hot failover sequence number.

Since:

UMS 5.2.1

See Also:

Constant Field Values

UMQ_INDEX_FLAG_NUMERIC

public static final int UMQ_INDEX_FLAG_NUMERIC

UMQIndexInfo flag. Index is a 64-bit integer.

Since:

UMQ 1.2

See Also:

UMQIndexInfo, UMQIndexInfo.flags(), UMQIndexInfo#setFlags(int flags), Constant Field Values

SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_RR

public static final int SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_RR

Round Robin store behaviour

Since:

UME 2.0

See Also:

Constant Field Values

SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_QC

public static final int SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_QC

Quorum and Consensus store behaviour

Since:

UME 2.0

See Also:

Constant Field Values

MSG_UMQ_REASSIGN_FLAG_DISCARD

public static final int MSG_UMQ_REASSIGN_FLAG_DISCARD

Instead of requesting reassignment, request the message be discarded.

Since:

UMQ 2.2

See Also:

LBMMessage#reassign(), Constant Field Values

CTX_ATTR_OP_EMBEDDED

public static final int CTX_ATTR_OP_EMBEDDED

Context operational mode: Embedded

See Also:

Constant Field Values

CTX_ATTR_OP_DAEMON

public static final int CTX_ATTR_OP_DAEMON

Context operational mode: Daemon

See Also:

Constant Field Values

CTX_ATTR_OP_SEQUENTIAL

public static final int CTX_ATTR_OP_SEQUENTIAL

Context operational mode: Sequential

See Also:

Constant Field Values

MSG_MAX_SOURCE_LEN

public static final int MSG_MAX_SOURCE_LEN

Maximum source name length

See Also:

Constant Field Values

MSG_MAX_TOPIC_LEN

public static final int MSG_MAX_TOPIC_LEN

Maximum topic name length

See Also:

Constant Field Values

UMQ_MAX_INDEX_LEN

public static final int UMQ_MAX_INDEX_LEN

Maximum UMQ index length.

See Also:

Constant Field Values

UME_MAX_STORE_STRLEN

public static final int UME_MAX_STORE_STRLEN

Maximum UME store length.

See Also:

Constant Field Values

UMQ_MAX_QUEUE_STRLEN

public static final int UMQ_MAX_QUEUE_STRLEN

Maximum UMQ queue length.

See Also:

Constant Field Values

UMQ_ULB_MAX_RECEIVER_STRLEN

public static final int UMQ_ULB_MAX_RECEIVER_STRLEN

Maximum UMQ ULB receiver length.

See Also:

Constant Field Values

UMQ_MAX_TOPIC_STRLEN

public static final int UMQ_MAX_TOPIC_STRLEN

Maximum UMQ queue topic name length.

See Also:

Constant Field Values

UMQ_MAX_APPSET_STRLEN

public static final int UMQ_MAX_APPSET_STRLEN

Maximum UMQ queue appset name length.

See Also:

Constant Field Values

EVENT_QUEUE_BLOCK

public static final long EVENT_QUEUE_BLOCK

Infinite blocking time for running event queue

See Also:

Constant Field Values

EVENT_QUEUE_POLL

public static final long EVENT_QUEUE_POLL

Poll and dispatch a single event when running the event queue

See Also:

Constant Field Values

EVENT_QUEUE_SIZE_WARNING

public static final int EVENT_QUEUE_SIZE_WARNING

Event queue monitor event type: Warning of event queue size.

See Also:

Constant Field Values

EVENT_QUEUE_DELAY_WARNING

public static final int EVENT_QUEUE_DELAY_WARNING

Event queue monitor event type: Warning of excessive delay for event.

See Also:

Constant Field Values

EVENT_QUEUE_ENQUEUE_NOTIFICATION

public static final int EVENT_QUEUE_ENQUEUE_NOTIFICATION

Event queue monitor event type: Notification of something being added to queue.

See Also:

Constant Field Values

LOG_EMERG

public static final int LOG_EMERG

Logging level: Emergency

See Also:

Constant Field Values

LOG_ALERT

public static final int LOG_ALERT

Logging level: Alert

See Also:

Constant Field Values

LOG_CRIT

public static final int LOG_CRIT

Logging level: Critical

See Also:

Constant Field Values

LOG_ERR

public static final int LOG_ERR

Logging level: Error

See Also:

Constant Field Values

LOG_WARNING

public static final int LOG_WARNING

Logging level: Warning

See Also:

Constant Field Values

LOG_NOTICE

public static final int LOG_NOTICE

Logging level: Notice

See Also:

Constant Field Values

LOG_INFO

public static final int LOG_INFO

Logging level: Informational

See Also:

Constant Field Values

LOG_DEBUG

public static final int LOG_DEBUG

Logging level: Debug

See Also:

Constant Field Values

TRANSPORT_STAT_TCP

public static final int TRANSPORT_STAT_TCP

Transport statistics type: TCP transport.

See Also:

Constant Field Values

TRANSPORT_STAT_LBTRM

public static final int TRANSPORT_STAT_LBTRM

Transport statistics type: LBT-RM transport.

See Also:

Constant Field Values

TRANSPORT_STAT_LBTRU

public static final int TRANSPORT_STAT_LBTRU

Transport statistics type: LBT-RU transport.

See Also:

Constant Field Values

TRANSPORT_STAT_LBTIPC

public static final int TRANSPORT_STAT_LBTIPC

Transport statistics type: LBT-IPC transport.

See Also:

Constant Field Values

TRANSPORT_STAT_LBTRDMA

public static final int TRANSPORT_STAT_LBTRDMA

Transport statistics type: LBT-RDMA transport.

See Also:

Constant Field Values

TRANSPORT_STAT_DAEMON

public static final int TRANSPORT_STAT_DAEMON

Transport statistics type: Daemon is being used.

See Also:

Constant Field Values

WILDCARD_RCV_PATTERN_TYPE_PCRE

public static final int WILDCARD_RCV_PATTERN_TYPE_PCRE

Wildcard receiver pattern type: PCRE (Perl Compatible Regular Expressions)

See Also:

Constant Field Values

WILDCARD_RCV_PATTERN_TYPE_REGEX

public static final int WILDCARD_RCV_PATTERN_TYPE_REGEX

Wildcard receiver pattern type: POSIX regex

See Also:

Constant Field Values

WILDCARD_RCV_PATTERN_TYPE_APP_CB

public static final int WILDCARD_RCV_PATTERN_TYPE_APP_CB

Wildcard receiver pattern type: callback

See Also:

Constant Field Values

TOPIC_RES_REQUEST_ADVERTISEMENT

public static final int TOPIC_RES_REQUEST_ADVERTISEMENT

Request advertisements from quiescent sources.

See Also:

Constant Field Values

TOPIC_RES_REQUEST_QUERY

public static final int TOPIC_RES_REQUEST_QUERY

Request queries from quiescent receivers.

See Also:

Constant Field Values

TOPIC_RES_REQUEST_WILDCARD_QUERY

public static final int TOPIC_RES_REQUEST_WILDCARD_QUERY

Request queries from quiescent wildcard receivers

See Also:

Constant Field Values

LBM_SRC_COST_FUNCTION_REJECT

public static final long LBM_SRC_COST_FUNCTION_REJECT

Source cost function return value to indicate this source should be permanently rejected.

See Also:

Constant Field Values

LBM_UMM_INFO_FLAGS_USE_SSL

public static final long LBM_UMM_INFO_FLAGS_USE_SSL

Use SSL for all umm connections

Since:

UMS 5.2

See Also:

LBMUMMInfo.LBMUMMInfo(String, String, String, String[]), Constant Field Values

LBM_UMM_NUM_SERVERS_MAX

public static final long LBM_UMM_NUM_SERVERS_MAX

Max allowed number of failover UMM Daemons

Since:

UMS 5.2

See Also:

Constant Field Values

LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_TMO

public static final int LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_TMO

UME Receiver Liveness Deletion TIMEOUT

See Also:

Constant Field Values

LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_EOF

public static final int LBM_UME_LIVENESS_RECEIVER_UNRESPONSIVE_FLAG_EOF

UME Receiver Liveness Deletion EOF

See Also:

Constant Field Values

ASYNC_OP_TYPE_CTX_UMQ_QUEUE_TOPIC_LIST

public static final int ASYNC_OP_TYPE_CTX_UMQ_QUEUE_TOPIC_LIST

Asynchronous operation type. UMQ queue topic list.

See Also:

Constant Field Values

ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_LIST

public static final int ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_LIST

Asynchronous operation type. UMQ queue message list.

See Also:

Constant Field Values

ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_RETRIEVE

public static final int ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_RETRIEVE

Asynchronous operation type. UMQ queue message retrieve.

See Also:

Constant Field Values

ASYNC_OP_STATUS_IN_PROGRESS

public static final int ASYNC_OP_STATUS_IN_PROGRESS

Asynchronous operation status code. Overall operation is still in progress.

See Also:

Constant Field Values

ASYNC_OP_STATUS_COMPLETE

public static final int ASYNC_OP_STATUS_COMPLETE

Asynchronous operation status code. Overall operation has completed successfully. This is a terminal status code.

See Also:

Constant Field Values

ASYNC_OP_STATUS_ERROR

public static final int ASYNC_OP_STATUS_ERROR

Asynchronous operation status code. Overall operation has failed. This is a terminal status code.

See Also:

Constant Field Values

ASYNC_OP_STATUS_CANCELED

public static final int ASYNC_OP_STATUS_CANCELED

Asynchronous operation status code. Overall operation has been successfully canceled. This is a terminal status code.

See Also:

Constant Field Values

ASYNC_OP_INVALID_HANDLE

public static final long ASYNC_OP_INVALID_HANDLE

Invalid asynchronous operation handle.

See Also:

Constant Field Values

ASYNC_OPERATION_CANCEL_FLAG_NONBLOCK

public static final int ASYNC_OPERATION_CANCEL_FLAG_NONBLOCK

Asynchronous operation cancel flag. Do not block if the operation cannot be immediately canceled.

See Also:

Constant Field Values

ASYNC_OPERATION_STATUS_FLAG_NONBLOCK

public static final int ASYNC_OPERATION_STATUS_FLAG_NONBLOCK

Asynchronous operation status flag. Do not block if the operation's status cannot be retrieved immediately.

See Also:

Constant Field Values

ASYNC_OP_INFO_FLAG_INLINE

public static final int ASYNC_OP_INFO_FLAG_INLINE

Asynchronous operation info flag. Asynchronous operation callback is being called directly inline from within an API call.

See Also:

Constant Field Values

ASYNC_OP_INFO_FLAG_FIRST

public static final int ASYNC_OP_INFO_FLAG_FIRST

Asynchronous operation info flag. This is the very first notification for this particular asynchronous operation.

See Also:

Constant Field Values

ASYNC_OP_INFO_FLAG_LAST

public static final int ASYNC_OP_INFO_FLAG_LAST

Asynchronous operation info status flag. This is the very last notification for this particular asynchronous operation.

See Also:

Constant Field Values

ASYNC_OP_INFO_FLAG_ONLY

public static final int ASYNC_OP_INFO_FLAG_ONLY

Asynchronous operation info flag. This is the only notification that will be delivered for this particular asynchronous operation.

See Also:

Constant Field Values

UMQ_QUEUE_MSG_STATUS_UNKNOWN

public static final int UMQ_QUEUE_MSG_STATUS_UNKNOWN

Queue message status; queue has no knowledge of the message.

See Also:

Constant Field Values

UMQ_QUEUE_MSG_STATUS_UNASSIGNED

public static final int UMQ_QUEUE_MSG_STATUS_UNASSIGNED

Queue message status; message is currently enqueued but not yet assigned.

See Also:

Constant Field Values

UMQ_QUEUE_MSG_STATUS_ASSIGNED

public static final int UMQ_QUEUE_MSG_STATUS_ASSIGNED

Queue message status; message is currently assigned to a receiver but not yet consumed.

See Also:

Constant Field Values

UMQ_QUEUE_MSG_STATUS_REASSIGNING

public static final int UMQ_QUEUE_MSG_STATUS_REASSIGNING

Queue message status; message is waiting to be re-assigned to a different receiver.

See Also:

Constant Field Values

UMQ_QUEUE_MSG_STATUS_CONSUMED

public static final int UMQ_QUEUE_MSG_STATUS_CONSUMED

Queue message status; message has been fully consumed and is no longer present in the queue.

See Also:

Constant Field Values

LBM_TEXTMESSAGE

public static final int LBM_TEXTMESSAGE

See Also:

Constant Field Values

LBM_BYTEMESSAGE

public static final int LBM_BYTEMESSAGE

See Also:

Constant Field Values

LBM_MAPMESSAGE

public static final int LBM_MAPMESSAGE

See Also:

Constant Field Values

LBM_MESSAGE

public static final int LBM_MESSAGE

See Also:

Constant Field Values

LBM_OBJECTMESSAGE

public static final int LBM_OBJECTMESSAGE

See Also:

Constant Field Values

LBM_STREAMMESSAGE

public static final int LBM_STREAMMESSAGE

See Also:

Constant Field Values

LBM_JMSDeliveryMode

public static final java.lang.String LBM_JMSDeliveryMode

See Also:

Constant Field Values

LBM_JMSExpiration

public static final java.lang.String LBM_JMSExpiration

See Also:

Constant Field Values

LBM_JMSPriority

public static final java.lang.String LBM_JMSPriority

See Also:

Constant Field Values

LBM_JMSMessageID

public static final java.lang.String LBM_JMSMessageID

See Also:

Constant Field Values

LBM_JMSTimestamp

public static final java.lang.String LBM_JMSTimestamp

See Also:

Constant Field Values

LBM_JMSCorrelationID

public static final java.lang.String LBM_JMSCorrelationID

See Also:

Constant Field Values

LBM_JMSType

public static final java.lang.String LBM_JMSType

See Also:

Constant Field Values

LBM_JMSRedelivered

public static final java.lang.String LBM_JMSRedelivered

See Also:

Constant Field Values

LBM_LBMMessageType

public static final java.lang.String LBM_LBMMessageType

See Also:

Constant Field Values

LBM_JMSTopicType

public static final java.lang.String LBM_JMSTopicType

See Also:

Constant Field Values

LBM_JMSReplyToName

public static final java.lang.String LBM_JMSReplyToName

See Also:

Constant Field Values

LBM_JMSReplyToWildcard

public static final java.lang.String LBM_JMSReplyToWildcard

See Also:

Constant Field Values

LBM_JMSReplyToType

public static final java.lang.String LBM_JMSReplyToType

See Also:

Constant Field Values

Constructor Detail

LBM

public LBM()
    throws LBMException

Instantiate LBM utility class (initializes log)

Throws:

LBMException - if any initialization error occurs.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

setLicenseFile

public static void setLicenseFile(java.lang.String licenseFile)
                           throws LBMException

Initialize the LBM license from the contents of a disk file. This method will only be effective if it is called before any other LBM API method.

Parameters:

licenseFile - String containing the name of a file that contains the LBM license. This string is the same as that which would otherwise be specified as the value of the LBM_LICENSE_FILENAME environmental variable.

Throws:

LBMException - if licenseFile doesn't contain a valid filename, doesn't exist, or contains an invalid LBM license.

setLicenseString

public static void setLicenseString(java.lang.String licenseString)
                             throws LBMException

Initialize the LBM license from a string. This method will only be effective if it is called before any other LBM API method.

Parameters:

licenseString - String containing LBM license. This string is the same as that which would otherwise be specified as the value of the LBM_LICENSE_INFO environmental variable.

Throws:

LBMException - if licenseString doesn't contain a valid LBM license.

setConfiguration

public static void setConfiguration(java.lang.String fileName)
                             throws LBMException

Configure LBM attributes from a file, tftp or http URL.

Parameters:

fileName - String containing a file name or URL (tftp or http). File names ending with a ".xml" extension will be processed by the setConfigurationXml API with a null applicationName.

Throws:

LBMException - if fileName contains an invalid filename, doesn't exist, or doesn't contain a valid LBM configuration file.

setConfigurationXml

public static void setConfigurationXml(java.lang.String fileName,
                                       java.lang.String applicationName)
                                throws LBMException

Configure LBM attributes from a file, tftp or http URL.

Parameters:

fileName - String containing the path or URL (tftp or http) to the XML configuraton file.

applicationName - String containing the name of this applicaiton which must match an application tag in the XML configuration file. This parameter may be null, in which case the application tag with no name is matched.

Throws:

LBMException - if fileName contains an invalid filename, doesn't exist, doesn't contain a valid LBM XML configuration file, or LBM XML configuration has already been loaded.

setConfigurationXmlString

public static void setConfigurationXmlString(java.lang.String xmlString,
                                             java.lang.String applicationName)
                                      throws LBMException

Configure LBM attributes from a String

Parameters:

xmlString - String containing LBM XML configuration data.

applicationName - String containing the name of this applicaiton which must match an application tag in the XML configuration string. This parameter may be null, in which case the application tag with no name is matched.

Throws:

LBMException - if xmlString is empty, doesn't exist, doesn't contain valid LBM XML configuration data, or LBM XML configuration has already been loaded.

setUmmInfo

public static void setUmmInfo(LBMUMMInfo info)
                       throws LBMException

Connect to and retrieve configuration from a UMM daemon. This method will only be effective if it is called before any other LBM API method.

Parameters:

info - UMM daemon connection options

Throws:

LBMException - if UMM info has already been loaded, or if some other error was encountered.

version

public static java.lang.String version()

Get LBM version information.

Returns:

LBM version

log

protected void log(int level,
                   java.lang.String message)
            throws LBMException

Logging callback. This method may be overridden by a subclass or the logging maybe handled by a specify logging interface.

Parameters:

level - Log level of message

message - Log message

Throws:

LBMException - When an error occurs while calling the log callback

See Also:

setLogger(LBMLogging)

setLogger

public void setLogger(LBMLogging logger)

Inform LBM to use a specific logger for logging

Parameters:

logger - Logging object implementing the LBMLogging interface

setDebugFilename

public static void setDebugFilename(java.lang.String filename)
                             throws LBMException

Set the LBM debug filename.

Parameters:

filename - The name of the file to be written with debug data.

Throws:

LBMException - if out of memory.

setDebugMask

public static void setDebugMask(long mask)

Set the LBM debug mask, as suggested by the support team.

Parameters:

mask - The mask used for debugging purposes.

dumpDebugLog

public static void dumpDebugLog(java.lang.String filename,
                                boolean append)
                         throws LBMException

Dump the in-memory LBM debug log to a specified file.

Parameters:

filename - Name of the file to dump debug log events to.

append - Set to true to append the debug log to the file; otherwise, the file is overwritten.

Throws:

LBMException

asyncOperationCancel

public static void asyncOperationCancel(long handle)
                                 throws LBMException

Cancel the asynchronous operation referred to by the given handle. Calling this function will cause the associated aynchronous operation's async operation callback function to be called with a canceled status. If the operation could not be canceled (either it has already completed, an exception is thrown. Otherwise, the operation was found and guaranteed to have been truly canceled. It is generally not safe to call this function from within an asynchronous operation callback for the same handle that is being canceled. There is one exception: it is safe to call cancel on a handle from within the initial LBM_ASYNC_OP_STATUS_IN_PROGRESS that delivers the handle; this is in fact a reasonable way to simulate a non-blocking synchronous call.

Parameters:

handle - The handle to the asynchronous operation.

Throws:

LBMException - if the operation could not be canceled.

asyncOperationCancel

public static void asyncOperationCancel(long handle,
                                        int flags)
                                 throws LBMEWouldBlockException,
                                        LBMException

Cancel the asynchronous operation referred to by the given handle. Calling this function will cause the associated aynchronous operation's async operation callback function to be called with a canceled status. If the operation could not be canceled (either it has already completed, an exception is thrown. Otherwise, the operation was found and guaranteed to have been truly canceled. It is generally not safe to call this function from within an asynchronous operation callback for the same handle that is being canceled. There is one exception: it is safe to call cancel on a handle from within the initial LBM_ASYNC_OP_STATUS_IN_PROGRESS that delivers the handle; this is in fact a reasonable way to simulate a non-blocking synchronous call.

Parameters:

handle - The handle to the asynchronous operation.

flags - Flags affecting the behavior of the cancel call; pass 0 if no flags desired.

Throws:

LBMEWouldBlockException - if the non-block flag was passed and the operation would block.

LBMException - if the operation could not be canceled.

See Also:

ASYNC_OPERATION_CANCEL_FLAG_NONBLOCK

asyncOperationStatus

public static void asyncOperationStatus(long handle)
                                 throws LBMException

Query the status of the asynchronous operation referred to by the given handle. Calling this function will cause the associated aynchronous operation's async operation callback function to be called with current status information. This is a merely a polling mechanism, and the information returned is guaranteed to be correct only for the duration of the async operation callback function. It may change immediately afterwards. It is not safe to (nor should it be necessary to) call this function from within an asynchronous operation callback for the same handle that status is being requested for.

Parameters:

handle - The handle to the asynchronous operation.

Throws:

LBMException - if the operation could not be found.

asyncOperationStatus

public static void asyncOperationStatus(long handle,
                                        int flags)
                                 throws LBMEWouldBlockException,
                                        LBMException

Query the status of the asynchronous operation referred to by the given handle. Calling this function will cause the associated aynchronous operation's async operation callback function to be called with current status information. This is a merely a polling mechanism, and the information returned is guaranteed to be correct only for the duration of the async operation callback function. It may change immediately afterwards. It is not safe to (nor should it be necessary to) call this function from within an asynchronous operation callback for the same handle that status is being requested for.

Parameters:

handle - The handle to the asynchronous operation.

flags - Flags affecting the behavior of the status call; pass 0 if no flags desired.

Throws:

LBMEWouldBlockException - if the non-block flag was passed and the operation would block.

LBMException - if the operation could not be found.

See Also:

ASYNC_OPERATION_STATUS_FLAG_NONBLOCK