UM .NET API 6.17.1

- Main Page
- Related Pages
- Packages
- Classes

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
com.latencybusters.lbm.LBMContextSourceEvent Class Reference

Encapsulates an LBM context-level source event. More...

Inheritance diagram for com.latencybusters.lbm.LBMContextSourceEvent:

## Public Member Functions
int | type ()
| LBM Source Event type. More...
long | registrationId ()
| Registration ID associated with this event. More...
long | sequenceNumber ()
| Sequence number associated with this event. More...
string | dataString ()
| String data associated with this event. More...
object | clientObject ()
| Client callback object. More...
LBMSourceEventWakeupInfo | sourceWakeupInfo ()
| Source wakeup info object. More...
UMESourceEventRegistrationSuccessInfo | registrationSuccessInfo ()
| Registration success info object. More...
UMESourceEventRegistrationCompleteInfo | registrationCompleteInfo ()
| Registration complete info. More...
UMESourceEventAckInfo | ackInfo ()
| Gets extended ACK info. More...
UMESourceEventDeregistrationSuccessInfo | deregistrationSuccessInfo ()
| Gets deregistration success info. More...
UMESourceEventDeregistrationCompleteInfo | deregistrationCompleteInfo ()
| Gets deregistration complete info. More...
LBMSourceEventSequenceNumberInfo | sequenceNumberInfo ()
| Gets extended sequence number info. More...
UMQSourceEventMessageIdInfo | messageIdInfo ()
| Gets an object describing teh message ID assigned to a message (UMQ only) More...
UMQSourceEventAckInfo | queueAckInfo ()
| Gets an object containing extended information about a stability acknowledgement event. (UMQ only) More...
UMQSourceEventRegistrationCompleteInfo | queueRegistrationCompleteInfo ()
| Queue registration complete info. (UMQ only) More...
UMQSourceEventULBReceiverInfo | ulbReceiverInfo ()
| Gets an object containing extended information about a ULB receiver event. (UMQ only) More...
UMQSourceEventULBMessageInfo | ulbMessageInfo ()
| Gets an object containing extended information about a ULB message event. (UMQ only) More...
LBMSourceEventFlightSizeNotification | flightSizeNotification ()
| Gets an object containing flight size information. More...
LBMSourceEventTimestampInfo | timestampInfo ()
| Gets an object containing timestamp information. More...
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. More...
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.

## Detailed Description

Encapsulates an LBM context-level source event.

## Member Function Documentation

UMESourceEventAckInfo com.latencybusters.lbm.LBMSourceEvent.ackInfo | ( |  | ) |
| inherited

Gets extended ACK info.

Returns
  Ack info.

object com.latencybusters.lbm.LBMSourceEvent.clientObject | ( |  | ) |
| inherited

Client callback object.

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

See also
  LBMSource.send(byte[],int,int,object)

Returns
  Client callback object

string com.latencybusters.lbm.LBMSourceEvent.dataString | ( |  | ) |
| inherited

String data associated with this event.

This value may not be valid for all event types.

Returns
  Event string data

UMESourceEventDeregistrationCompleteInfo com.latencybusters.lbm.LBMSourceEvent.deregistrationCompleteInfo | ( |  | ) |
| inherited

Gets deregistration complete info.

Returns
  UMESourceDeregistrationComplete Info

UMESourceEventDeregistrationSuccessInfo com.latencybusters.lbm.LBMSourceEvent.deregistrationSuccessInfo | ( |  | ) |
| inherited

Gets deregistration success info.

Returns
  UMESourceDeregistrationSuccess Info

LBMSourceEventFlightSizeNotification com.latencybusters.lbm.LBMSourceEvent.flightSizeNotification | ( |  | ) |
| inherited

Gets an object containing flight size information.

Returns
  An LBMSourceEventFlightSizeNotification object with information about the current inflight.

UMQSourceEventMessageIdInfo com.latencybusters.lbm.LBMSourceEvent.messageIdInfo | ( |  | ) |
| inherited

Gets an object describing teh message ID assigned to a message (UMQ only)

Returns
  A UMQSourceEventMessageIdInfo object containing message ID information

LBMSourceEvent com.latencybusters.lbm.LBMSourceEvent.promote | ( |  | ) |
| inherited

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

UMQSourceEventAckInfo com.latencybusters.lbm.LBMSourceEvent.queueAckInfo | ( |  | ) |
| inherited

Gets an object containing extended information about a stability acknowledgement event. (UMQ only)

Returns
  A UMQSourceEventAckInfo object with additional information about a stability ack event.

UMQSourceEventRegistrationCompleteInfo com.latencybusters.lbm.LBMSourceEvent.queueRegistrationCompleteInfo | ( |  | ) |
| inherited

Queue registration complete info. (UMQ only)

Contains extended queue registration complete information.

Returns
  A UMQSourceVentRegistrationCompleteInfo object containing registration complete info.

UMESourceEventRegistrationCompleteInfo com.latencybusters.lbm.LBMSourceEvent.registrationCompleteInfo | ( |  | ) |
| inherited

Registration complete info.

Contains extended registration complete information.

Returns
  Registration complete info.

long com.latencybusters.lbm.LBMSourceEvent.registrationId | ( |  | ) |
| inherited

Registration ID associated with this event.

This value may not be valid for all event types.

Returns
  Registration ID.

UMESourceEventRegistrationSuccessInfo com.latencybusters.lbm.LBMSourceEvent.registrationSuccessInfo | ( |  | ) |
| inherited

Registration success info object.

Contains extended registration information.

Returns
  Extended registration success info object.

long com.latencybusters.lbm.LBMSourceEvent.sequenceNumber | ( |  | ) |
| inherited

Sequence number associated with this event.

This value may not be valid for all event types.

Returns
  Sequence number.

LBMSourceEventSequenceNumberInfo com.latencybusters.lbm.LBMSourceEvent.sequenceNumberInfo | ( |  | ) |
| inherited

Gets extended sequence number info.

Returns
  Sequence number info.

LBMSourceEventWakeupInfo com.latencybusters.lbm.LBMSourceEvent.sourceWakeupInfo | ( |  | ) |
| inherited

Source wakeup info object.

Contains extended information about a source wakeup event.

Returns
  Source wakeup info object.

LBMSourceEventTimestampInfo com.latencybusters.lbm.LBMSourceEvent.timestampInfo | ( |  | ) |
| inherited

Gets an object containing timestamp information.

Returns
  An LBMSourceEventTimestamp object with information about the timestamp of a sent message.

int com.latencybusters.lbm.LBMSourceEvent.type | ( |  | ) |
| inherited

LBM Source Event type.

See also
  LBM

Returns
  LBM Source Event type

UMQSourceEventULBMessageInfo com.latencybusters.lbm.LBMSourceEvent.ulbMessageInfo | ( |  | ) |
| inherited

Gets an object containing extended information about a ULB message event. (UMQ only)

Returns
  A UMQSourceEventULBMessageInfo object with additional information about a ULB message event.

UMQSourceEventULBReceiverInfo com.latencybusters.lbm.LBMSourceEvent.ulbReceiverInfo | ( |  | ) |
| inherited

Gets an object containing extended information about a ULB receiver event. (UMQ only)

Returns
  A UMQSourceEventULBReceiverInfo object with additional information about a ULB receiver event.

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

- LBMContextSourceEvent.cs