OmmConsumerEvent encapsulates item identifiers.
More...
OmmConsumerEvent is used to convey item identifiers to application. OmmConsumerEvent is returned through OmmConsumerClient callback methods.
- See also
- OmmConsumer, OmmConsumerClient
Definition at line 38 of file OmmConsumerEvent.h.
◆ getChannelInformation()
const ChannelInformation& refinitiv::ema::access::OmmConsumerEvent::getChannelInformation |
( |
| ) |
const |
Returns the Channel Information for this event
- Returns
- the channel information for this event
◆ getChannelStatistics()
const ChannelStatistics& refinitiv::ema::access::OmmConsumerEvent::getChannelStatistics |
( |
| ) |
const |
Returns the Channel Statistics for this event
- Exceptions
-
- Returns
- the channel Statistics for this event
◆ getClosure()
void* refinitiv::ema::access::OmmConsumerEvent::getClosure |
( |
| ) |
const |
Returns an identifier (a.k.a., closure) associated with an open stream by consumer application Application associates the closure with an open item stream on OmmConsumer::registerClient( ... , ... , void* closure, ... )
- Returns
- closure value
◆ getHandle()
UInt64 refinitiv::ema::access::OmmConsumerEvent::getHandle |
( |
| ) |
const |
Returns a unique item identifier (a.k.a., item handle) associated by EMA with an open item stream. Item identifier is returned from OmmConsumer::registerClient(). For tunnel stream onStatusMsg() call backs this is the parent handle returned by the OmmConsume::registerClient() method. For tunnel stream sub-stream call backs this is the handle of the sub-stream itself.
- Returns
- item identifier or handle
◆ getParentHandle()
UInt64 refinitiv::ema::access::OmmConsumerEvent::getParentHandle |
( |
| ) |
const |
Returns current item's parent item identifier (a.k.a. parent item handle). Application specifies parent item identifier on OmmConsumer::registerClient( ... , ... , ... , UInt64 parentHandle ). For tunnel stream sub-stream call backs this is the handle of parent tunnel stream. For batch request items this is the item identifier of the top level batch request.
- Returns
- parent item identifier or parent handle