EMA C++ Edition
List of all members
refinitiv::ema::access::OmmProviderEvent Class Reference

OmmProviderEvent encapsulates item identifiers. More...

Accessors

class ProviderItem
 
class NiProviderLoginItem
 
class NiProviderSingleItem
 
class LoginHandler
 
class DictionaryHandler
 
class DirectoryHandler
 
class MarketItemHandler
 
class OmmServerBaseImpl
 
UInt64 getHandle () const
  More...
 
void * getClosure () const
  More...
 
OmmProvidergetProvider () const
  More...
 
UInt64 getClientHandle () const
  More...
 
const ChannelInformationgetChannelInformation () const
  More...
 
const ChannelStatisticsgetChannelStatistics () const
  More...
 

Detailed Description

OmmProviderEvent is used to convey item identifiers to application. OmmProviderEvent is returned through OmmProviderClient callback methods.

Remarks
OmmProviderEvent is a read only class. This class is used for item identification only.
All methods in this class are Lock-free Method.
See also
OmmProvider OmmProviderClient

Definition at line 41 of file OmmProviderEvent.h.

Member Function Documentation

◆ getChannelInformation()

const ChannelInformation& refinitiv::ema::access::OmmProviderEvent::getChannelInformation ( ) const

Returns the Channel Information for this event

Returns
the channel information for this event

◆ getChannelStatistics()

const ChannelStatistics& refinitiv::ema::access::OmmProviderEvent::getChannelStatistics ( ) const

Returns the Channel Statistical Information for this event

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
the channel statistical information for this event

◆ getClientHandle()

UInt64 refinitiv::ema::access::OmmProviderEvent::getClientHandle ( ) const

Returns a unique client identifier (a.k.a., client handle) associated by EMA with a connected client.

Returns
client identifier or handle

◆ getClosure()

void* refinitiv::ema::access::OmmProviderEvent::getClosure ( ) const

Returns an identifier (a.k.a., closure) associated with an open stream on a OmmProvider application Application associates the closure with an open item stream on OmmProvider::registerClient( ... , ... , void* closure )

Returns
closure value

◆ getHandle()

UInt64 refinitiv::ema::access::OmmProviderEvent::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 OmmProvider::registerClient().

Returns
item identifier or handle

◆ getProvider()

OmmProvider& refinitiv::ema::access::OmmProviderEvent::getProvider ( ) const

Return OmmProvider instance for this event.

Returns
reference to OmmProvider