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

Msg class is a parent class for all message representing classes. More...

Inheritance diagram for refinitiv::ema::access::Msg:
refinitiv::ema::access::ComplexType refinitiv::ema::access::Data refinitiv::ema::access::AckMsg refinitiv::ema::access::GenericMsg refinitiv::ema::access::PostMsg refinitiv::ema::access::RefreshMsg refinitiv::ema::access::ReqMsg refinitiv::ema::access::StatusMsg refinitiv::ema::access::UpdateMsg

Public Member Functions

Accessors
bool hasMsgKey () const
  More...
 
bool hasName () const
  More...
 
bool hasNameType () const
  More...
 
bool hasServiceId () const
  More...
 
bool hasId () const
  More...
 
bool hasFilter () const
  More...
 
bool hasExtendedHeader () const
  More...
 
Int32 getStreamId () const
  More...
 
UInt16 getDomainType () const
  More...
 
const EmaStringgetName () const
  More...
 
UInt8 getNameType () const
  More...
 
UInt32 getServiceId () const
  More...
 
Int32 getId () const
  More...
 
UInt32 getFilter () const
  More...
 
const EmaBuffergetExtendedHeader () const
  More...
 
const AttribgetAttrib () const
  More...
 
const PayloadgetPayload () const
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::ComplexType
virtual ~ComplexType ()
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::Data
const EmaStringgetCodeAsString () const
  More...
 
virtual DataType::DataTypeEnum getDataType () const =0
  More...
 
virtual DataCode getCode () const =0
  More...
 
virtual const EmaBuffergetAsHex () const =0
  More...
 
virtual const EmaStringtoString () const =0
  More...
 
 operator const char * () const
  More...
 
virtual ~Data ()
  More...
 

Destructor

class OmmConsumerConfigImpl
 
class OmmNiProviderConfigImpl
 
class EmaConfigImpl
 
class EmaConfigServerImpl
 
class OmmNiProviderImpl
 
class OmmIProviderImpl
 
class ItemCallbackClient
 
class DirectoryItem
 
class LoginItem
 
class NiProviderLoginItem
 
class SingleItem
 
class NiProviderSingleItem
 
class IProviderSingleItem
 
class DictionaryItem
 
class NiProviderDictionaryItem
 
class IProviderDictionaryItem
 
class ProviderItem
 
class TunnelItem
 
class TunnelStreamLoginReqMsgImpl
 
class SubItem
 
class MsgDecoder
 
class PackedMsgImpl
 
MsgDecoder_pDecoder
 
MsgEncoder * _pEncoder
 
Attrib _attrib
 
Payload _payload
 
virtual ~Msg ()
  More...
 
 Msg ()
 
const Encoder & getEncoder () const
  More...
 
bool hasEncoder () const
  More...
 
void setDecoder (MsgDecoder *)
 
bool hasDecoder () const
  More...
 

Additional Inherited Members

- Public Types inherited from refinitiv::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0 ,
  BlankEnum = 1
}
 
- Protected Member Functions inherited from refinitiv::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from refinitiv::ema::access::Data
 Data ()
 

Detailed Description

Remarks
All methods in this class are Lock-free Method.
See also
ComplexType, Attrib, Payload, AckMsg, GenericMsg, PostMsg, RefreshMsg, RequestMsg, StatusMsg, UpdateMsg, EmaBuffer, EmaString

Definition at line 45 of file Msg.h.

Constructor & Destructor Documentation

◆ ~Msg()

virtual refinitiv::ema::access::Msg::~Msg ( )
virtual

Destructor.

Member Function Documentation

◆ getAttrib()

const Attrib& refinitiv::ema::access::Msg::getAttrib ( ) const

Returns the contained attributes Data based on the attributes DataType.

Remarks
Attrib contains no data if Attrib::getDataType() returns DataType::NoDataEnum
Returns
reference to Attrib object

◆ getDomainType()

UInt16 refinitiv::ema::access::Msg::getDomainType ( ) const

Returns the DomainType, which is the unique identifier of a domain.

Returns
domain type value

◆ getEncoder()

const Encoder& refinitiv::ema::access::Msg::getEncoder ( ) const
protectedvirtual

◆ getExtendedHeader()

const EmaBuffer& refinitiv::ema::access::Msg::getExtendedHeader ( ) const

Returns the ExtendedHeader.

Exceptions
OmmInvalidUsageExceptionif hasExtendedHeader() returns false
Returns
EmaBuffer containing extendedHeader info value

◆ getFilter()

UInt32 refinitiv::ema::access::Msg::getFilter ( ) const

Returns the Filter within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasFilter() returns false
Returns
filter value

◆ getId()

Int32 refinitiv::ema::access::Msg::getId ( ) const

Returns the Identifier within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasId() returns false
Returns
id value

◆ getName()

const EmaString& refinitiv::ema::access::Msg::getName ( ) const

Returns the Name within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasName() returns false
Returns
EmaString containing name

◆ getNameType()

UInt8 refinitiv::ema::access::Msg::getNameType ( ) const

Returns the NameType within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasNameType() returns false
Returns
name type value

◆ getPayload()

const Payload& refinitiv::ema::access::Msg::getPayload ( ) const

Returns the contained payload Data based on the payload DataType.

Remarks
Payload contains no data if Payload::getDataType() returns DataType::NoDataEnum
Returns
reference to Payload object

◆ getServiceId()

UInt32 refinitiv::ema::access::Msg::getServiceId ( ) const

Returns the ServiceId within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasServiceId() returns false
Returns
service id value

◆ getStreamId()

Int32 refinitiv::ema::access::Msg::getStreamId ( ) const

Returns the StreamId, which is the unique open message stream identifier on the wire.

Returns
stream id value

◆ hasDecoder()

bool refinitiv::ema::access::Msg::hasDecoder ( ) const
protectedvirtual

◆ hasEncoder()

bool refinitiv::ema::access::Msg::hasEncoder ( ) const
protectedvirtual

◆ hasExtendedHeader()

bool refinitiv::ema::access::Msg::hasExtendedHeader ( ) const

Indicates presence of the ExtendedHeader.

Returns
true if extendedHeader is set; false otherwise

◆ hasFilter()

bool refinitiv::ema::access::Msg::hasFilter ( ) const

Indicates presence of the Filter within the MsgKey.

Returns
true if filter is set; false otherwise

◆ hasId()

bool refinitiv::ema::access::Msg::hasId ( ) const

Indicates presence of the Identifier within the MsgKey.

Returns
true if Id is set; false otherwise

◆ hasMsgKey()

bool refinitiv::ema::access::Msg::hasMsgKey ( ) const

Indicates presence of the MsgKey.

Returns
true if name, name type, service id, service name, id, filter, or attribute is set; false otherwise

◆ hasName()

bool refinitiv::ema::access::Msg::hasName ( ) const

Indicates presence of the Name within the MsgKey.

Returns
true if name is set; false otherwise

◆ hasNameType()

bool refinitiv::ema::access::Msg::hasNameType ( ) const

Indicates presence of the NameType within the MsgKey.

Returns
true if name type is set; false otherwise

◆ hasServiceId()

bool refinitiv::ema::access::Msg::hasServiceId ( ) const

Indicates presence of the ServiceId within the MsgKey.

Returns
true if service id is set; false otherwise