EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members
thomsonreuters::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
 
void * getClosure () const
 
OmmProvidergetProvider () const
 
UInt64 getClientHandle () const
 
const ChannelInformationgetChannelInformation () const
 
const ChannelStatisticsgetChannelStatistics () const
 

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

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

Returns the Channel Information for this event

Returns
the channel information for this event
const ChannelStatistics& thomsonreuters::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
UInt64 thomsonreuters::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
void* thomsonreuters::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
UInt64 thomsonreuters::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
OmmProvider& thomsonreuters::ema::access::OmmProviderEvent::getProvider ( ) const

Return OmmProvider instance for this event.

Returns
reference to OmmProvider

Friends And Related Function Documentation

friend class DictionaryHandler
friend

Definition at line 85 of file OmmProviderEvent.h.

friend class DirectoryHandler
friend

Definition at line 86 of file OmmProviderEvent.h.

friend class LoginHandler
friend

Definition at line 84 of file OmmProviderEvent.h.

friend class MarketItemHandler
friend

Definition at line 87 of file OmmProviderEvent.h.

friend class NiProviderLoginItem
friend

Definition at line 82 of file OmmProviderEvent.h.

friend class NiProviderSingleItem
friend

Definition at line 83 of file OmmProviderEvent.h.

friend class OmmServerBaseImpl
friend

Definition at line 88 of file OmmProviderEvent.h.

friend class ProviderItem
friend

Definition at line 81 of file OmmProviderEvent.h.