com.latencybusters.lbm
Class LBMSourceEvent

java.lang.Object
  com.latencybusters.lbm.LBMSourceEvent

Direct Known Subclasses:

LBMContextSourceEvent

public class LBMSourceEvent
extends java.lang.Object

Encapsulates LBM Source Events.

Constructor Summary

LBMSourceEvent()

Method Summary

UMESourceEventAckInfo	ackInfo() Gets extended ACK info.
java.lang.Object	clientObject() Client callback object.
java.lang.String	dataString() String data associated with this event.
UMESourceEventDeregistrationCompleteInfo	deregistrationCompleteInfo() Registration complete info.
UMESourceEventDeregistrationSuccessInfo	deregistrationSuccessInfo() Registration success info object.
void	dispose() This method should be called before the source event callback returns to indicate that the application is finished with the source event allowing it to be reused when processing a future source event
LBMSourceEventFlightSizeNotification	flightSizeNotification() Flight Size Notificaiton.
UMQSourceEventMessageIdInfo	messageIdInfo() Gets an object describing the message ID assigned to a message.
LBMSourceEvent	promote() This method should be called if the application wishes to continue processing the source event on another thread, or after the source event callback returns.
UMQSourceEventAckInfo	queueAckInfo() Gets an object containing extended information about a message that has been acknowledged as stable.
UMQSourceEventRegistrationCompleteInfo	queueRegistrationCompleteInfo() Queue registration complete info.
UMESourceEventRegistrationCompleteInfo	registrationCompleteInfo() Registration complete info.
long	registrationId() Registration ID associated with this event.
UMESourceEventRegistrationSuccessInfo	registrationSuccessInfo() Registration success info object.
long	sequenceNumber() Sequence number associated with this event.
LBMSourceEventSequenceNumberInfo	sequenceNumberInfo() Gets extended sequence number info.
void	setDeregistrationCompleteInfo(UMESourceEventDeregistrationCompleteInfo dregc) Registration complete info.
void	setDeregistrationSuccessInfo(UMESourceEventDeregistrationSuccessInfo dereg) Registration success info object.
LBMSourceEventWakeupInfo	sourceWakeupInfo() Gets extended information about a source wakeup event.
int	type() LBM Source Event type.
UMQSourceEventULBMessageInfo	ulbMessageInfo() ULB Message info.
UMQSourceEventULBReceiverInfo	ulbReceiverInfo() ULB Receiver info.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMSourceEvent

public LBMSourceEvent()

Method Detail

type

public int type()

LBM Source Event type.

Returns:

LBM Source Event type

See Also:

LBM

registrationId

public long registrationId()

Registration ID associated with this event. This value may not be valid for all event types.

Returns:

Registration ID.

See Also:

LBM

sequenceNumber

public long sequenceNumber()

Sequence number associated with this event. This value may not be valid for all event types.

Returns:

Sequence number.

See Also:

LBM

dataString

public java.lang.String dataString()

String data associated with this event. This value may not be valid for all event types.

Returns:

Event string data

clientObject

public java.lang.Object clientObject()

Client callback object. This object is specified by the application using another API method.

Returns:

Client callback object

See Also:

LBMSource.send(byte [],int,int,Object)

registrationSuccessInfo

public UMESourceEventRegistrationSuccessInfo registrationSuccessInfo()

Registration success info object. Contains extended registration information.

Returns:

Extended registration success info object.

Since:

UME 2.0

See Also:

UMESourceEventRegistrationSuccessInfo

registrationCompleteInfo

public UMESourceEventRegistrationCompleteInfo registrationCompleteInfo()

Registration complete info. Contains extended registration complete information.

Returns:

Registration complete info.

Since:

UME 2.0

See Also:

UMESourceEventRegistrationCompleteInfo

setDeregistrationSuccessInfo

public void setDeregistrationSuccessInfo(UMESourceEventDeregistrationSuccessInfo dereg)

Registration success info object. Contains extended Deregistration information.

Since:

UME 5.3

See Also:

UMESourceEventDeregistrationSuccessInfo

setDeregistrationCompleteInfo

public void setDeregistrationCompleteInfo(UMESourceEventDeregistrationCompleteInfo dregc)

Registration complete info. Contains extended registration complete information.

Since:

UME 5.3

See Also:

UMESourceEventderegistrationCompleteInfo

deregistrationSuccessInfo

public UMESourceEventDeregistrationSuccessInfo deregistrationSuccessInfo()

Registration success info object. Contains extended Deregistration information.

Returns:

Extended deregistration success info object.

Since:

UME 5.3

See Also:

UMESourceEventDeregistrationSuccessInfo

deregistrationCompleteInfo

public UMESourceEventDeregistrationCompleteInfo deregistrationCompleteInfo()

Registration complete info. Contains extended registration complete information.

Returns:

Registration complete info.

Since:

UME 5.3

See Also:

UMESourceEventderegistrationCompleteInfo

sequenceNumberInfo

public LBMSourceEventSequenceNumberInfo sequenceNumberInfo()

Gets extended sequence number info.

Returns:

Sequence number info.

Since:

UME 2.0

See Also:

LBMSourceEventSequenceNumberInfo

ackInfo

public UMESourceEventAckInfo ackInfo()

Gets extended ACK info.

Returns:

Ack info.

Since:

UME 2.0

See Also:

UMESourceEventAckInfo

sourceWakeupInfo

public LBMSourceEventWakeupInfo sourceWakeupInfo()

Gets extended information about a source wakeup event.

Returns:

Source wakeup info.

Since:

LBM 3.4

See Also:

LBMSourceEventWakeupInfo

messageIdInfo

public UMQSourceEventMessageIdInfo messageIdInfo()

Gets an object describing the message ID assigned to a message.

Returns:

A UMQSourceEventMessageIdInfo object containing message ID information.

Since:

UME 3.0

See Also:

UMQSourceEventMessageIdInfo

queueAckInfo

public UMQSourceEventAckInfo queueAckInfo()

Gets an object containing extended information about a message that has been acknowledged as stable.

Returns:

A UMQSourceEventAckInfo object with acknowledgement information.

Since:

UME 3.0

See Also:

UMQSourceEventAckInfo

queueRegistrationCompleteInfo

public UMQSourceEventRegistrationCompleteInfo queueRegistrationCompleteInfo()

Queue registration complete info. Contains extended queue registration complete information.

Returns:

Registration complete info.

Since:

UME 3.0

See Also:

UMQSourceEventRegistrationCompleteInfo

ulbReceiverInfo

public UMQSourceEventULBReceiverInfo ulbReceiverInfo()

ULB Receiver info. Contains extended ULB receiver information.

Returns:

ULB Receiver info.

Since:

UMQ 1.1

See Also:

UMQSourceEventULBReceiverInfo

ulbMessageInfo

public UMQSourceEventULBMessageInfo ulbMessageInfo()

ULB Message info. Contains extended ULB message information.

Returns:

ULB Message info.

Since:

UMQ 1.1

See Also:

UMQSourceEventULBMessageInfo

flightSizeNotification

public LBMSourceEventFlightSizeNotification flightSizeNotification()

Flight Size Notificaiton.

Returns:

Flight Size Notification

Since:

UME 3.1

See Also:

LBMSourceEventFlightSizeNotification

promote

public LBMSourceEvent promote()

This method should be called if the application wishes to continue processing the source event on another thread, or after the source event callback returns.

Returns:

the promoted LBMSourceEvent

dispose

public void dispose()

This method should be called before the source event callback returns to indicate that the application is finished with the source event allowing it to be reused when processing a future source event