com.latencybusters.lbm
Class LBMAsyncOperationInfo

java.lang.Object
  com.latencybusters.lbm.LBMAsyncOperationInfo

public class LBMAsyncOperationInfo
extends java.lang.Object

Class containing generic (status, operation handle, etc.) and possibly specific (operation results) information about a particular asynchronous operation.

Method Summary

UMQContextQueueTopicListInfo	contextQueueTopicListInfo() Gets the results of an LBMContext#queueTopicList asynchronous operation.
void	dispose()
int	flags() Gets informational flags about this particular asynchronous operation update.
long	handle() Gets the asynchronous operation's opaque handle (a long value), which can be used to query the operation's status or to cancel it.
LBMAsyncOperationInfo	promote()
UMQReceiverQueueMessageListInfo	receiverQueueMessageListInfo() Gets the results of an LBMReceiverBase#queueMessageList asynchronous operation.
UMQReceiverQueueMessageRetrieveInfo	receiverQueueMessageRetrieveInfo() Gets the results of an LBMReceiverBase#queueMessageRetrieve asynchronous operation.
int	status() Gets the status of the asynchronous operation.
int	type() Gets the type of the asynchronous operation.

Methods inherited from class java.lang.Object

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

Method Detail

type

public int type()

Gets the type of the asynchronous operation.

Returns:

the operation type.

See Also:

LBM.ASYNC_OP_TYPE_CTX_UMQ_QUEUE_TOPIC_LIST, LBM.ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_LIST, LBM.ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_RETRIEVE

status

public int status()

Gets the status of the asynchronous operation.

Returns:

the operation's current status.

See Also:

LBM.ASYNC_OP_STATUS_IN_PROGRESS, LBM.ASYNC_OP_STATUS_COMPLETE, LBM.ASYNC_OP_STATUS_ERROR, LBM.ASYNC_OP_STATUS_CANCELED

flags

public int flags()

Gets informational flags about this particular asynchronous operation update.

Returns:

the flags.

See Also:

LBM.ASYNC_OP_INFO_FLAG_INLINE, LBM.ASYNC_OP_INFO_FLAG_FIRST, LBM.ASYNC_OP_INFO_FLAG_LAST, LBM.ASYNC_OP_INFO_FLAG_ONLY

handle

public long handle()

Gets the asynchronous operation's opaque handle (a long value), which can be used to query the operation's status or to cancel it. The handle will only be valid if the asynchronous operation was able to be started; otherwise it will be set to LBM#ASYNC_OP_INVALID_HANDLE .

Returns:

The operation's handle.

See Also:

LBM.ASYNC_OP_INVALID_HANDLE

contextQueueTopicListInfo

public UMQContextQueueTopicListInfo contextQueueTopicListInfo()
                                                       throws LBMEInvalException

Gets the results of an LBMContext#queueTopicList asynchronous operation.

Returns:

the results.

Throws:

LBMEInvalException - if the async operation information was for an operation type other than LBM#ASYNC_OP_TYPE_CTX_UMQ_QUEUE_TOPIC_LIST.

receiverQueueMessageListInfo

public UMQReceiverQueueMessageListInfo receiverQueueMessageListInfo()
                                                             throws LBMEInvalException

Gets the results of an LBMReceiverBase#queueMessageList asynchronous operation.

Returns:

the results.

Throws:

LBMEInvalException - if the async operation information was for an operation type other than LBM#ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_LIST.

receiverQueueMessageRetrieveInfo

public UMQReceiverQueueMessageRetrieveInfo receiverQueueMessageRetrieveInfo()
                                                                     throws LBMEInvalException

Gets the results of an LBMReceiverBase#queueMessageRetrieve asynchronous operation.

Returns:

the results.

Throws:

LBMEInvalException - if the async operation information was for an operation type other than LBM#ASYNC_OP_TYPE_RCV_UMQ_QUEUE_MSG_RETRIEVE.

promote

public LBMAsyncOperationInfo promote()

dispose

public void dispose()