EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Protected Member Functions | Protected Attributes | Friends
thomsonreuters::ema::access::Msg Class Reference

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

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

Public Member Functions

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

Protected Member Functions

const Encoder & getEncoder () const
 
bool hasDecoder () const
 
bool hasEncoder () const
 
 Msg ()
 
void setDecoder (MsgDecoder *)
 
- Protected Member Functions inherited from thomsonreuters::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from thomsonreuters::ema::access::Data
 Data ()
 

Protected Attributes

Attrib _attrib
 
Payload _payload
 
MsgDecoder_pDecoder
 
MsgEncoder * _pEncoder
 

Friends

class DictionaryItem
 
class DirectoryItem
 
class EmaConfigImpl
 
class EmaConfigServerImpl
 
class IProviderDictionaryItem
 
class IProviderSingleItem
 
class ItemCallbackClient
 
class LoginItem
 
class MsgDecoder
 
class NiProviderDictionaryItem
 
class NiProviderLoginItem
 
class NiProviderSingleItem
 
class OmmConsumerConfigImpl
 
class OmmIProviderImpl
 
class OmmNiProviderConfigImpl
 
class OmmNiProviderImpl
 
class ProviderItem
 
class SingleItem
 
class SubItem
 
class TunnelItem
 
class TunnelStreamLoginReqMsgImpl
 

Additional Inherited Members

- Public Types inherited from thomsonreuters::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0,
  BlankEnum = 1
}
 

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

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

Destructor.

thomsonreuters::ema::access::Msg::Msg ( )
protected

Member Function Documentation

const Attrib& thomsonreuters::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
UInt16 thomsonreuters::ema::access::Msg::getDomainType ( ) const

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

Returns
domain type value
const Encoder& thomsonreuters::ema::access::Msg::getEncoder ( ) const
protectedvirtual
const EmaBuffer& thomsonreuters::ema::access::Msg::getExtendedHeader ( ) const

Returns the ExtendedHeader.

Exceptions
OmmInvalidUsageExceptionif hasExtendedHeader() returns false
Returns
EmaBuffer containing extendedHeader info value
UInt32 thomsonreuters::ema::access::Msg::getFilter ( ) const

Returns the Filter within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasFilter() returns false
Returns
filter value
Int32 thomsonreuters::ema::access::Msg::getId ( ) const

Returns the Identifier within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasId() returns false
Returns
id value
const EmaString& thomsonreuters::ema::access::Msg::getName ( ) const

Returns the Name within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasName() returns false
Returns
EmaString containing name
UInt8 thomsonreuters::ema::access::Msg::getNameType ( ) const

Returns the NameType within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasNameType() returns false
Returns
name type value
const Payload& thomsonreuters::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
UInt32 thomsonreuters::ema::access::Msg::getServiceId ( ) const

Returns the ServiceId within the MsgKey.

Exceptions
OmmInvalidUsageExceptionif hasServiceId() returns false
Returns
service id value
Int32 thomsonreuters::ema::access::Msg::getStreamId ( ) const

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

Returns
stream id value
bool thomsonreuters::ema::access::Msg::hasDecoder ( ) const
protectedvirtual
bool thomsonreuters::ema::access::Msg::hasEncoder ( ) const
protectedvirtual
bool thomsonreuters::ema::access::Msg::hasExtendedHeader ( ) const

Indicates presence of the ExtendedHeader.

Returns
true if extendedHeader is set; false otherwise
bool thomsonreuters::ema::access::Msg::hasFilter ( ) const

Indicates presence of the Filter within the MsgKey.

Returns
true if filter is set; false otherwise
bool thomsonreuters::ema::access::Msg::hasId ( ) const

Indicates presence of the Identifier within the MsgKey.

Returns
true if Id is set; false otherwise
bool thomsonreuters::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
bool thomsonreuters::ema::access::Msg::hasName ( ) const

Indicates presence of the Name within the MsgKey.

Returns
true if name is set; false otherwise
bool thomsonreuters::ema::access::Msg::hasNameType ( ) const

Indicates presence of the NameType within the MsgKey.

Returns
true if name type is set; false otherwise
bool thomsonreuters::ema::access::Msg::hasServiceId ( ) const

Indicates presence of the ServiceId within the MsgKey.

Returns
true if service id is set; false otherwise
void thomsonreuters::ema::access::Msg::setDecoder ( MsgDecoder )
protected

Friends And Related Function Documentation

friend class DictionaryItem
friend

Definition at line 167 of file Msg.h.

friend class DirectoryItem
friend

Definition at line 161 of file Msg.h.

friend class EmaConfigImpl
friend

Definition at line 156 of file Msg.h.

friend class EmaConfigServerImpl
friend

Definition at line 157 of file Msg.h.

friend class IProviderDictionaryItem
friend

Definition at line 169 of file Msg.h.

friend class IProviderSingleItem
friend

Definition at line 166 of file Msg.h.

friend class ItemCallbackClient
friend

Definition at line 160 of file Msg.h.

friend class LoginItem
friend

Definition at line 162 of file Msg.h.

friend class MsgDecoder
friend

Definition at line 174 of file Msg.h.

friend class NiProviderDictionaryItem
friend

Definition at line 168 of file Msg.h.

friend class NiProviderLoginItem
friend

Definition at line 163 of file Msg.h.

friend class NiProviderSingleItem
friend

Definition at line 165 of file Msg.h.

friend class OmmConsumerConfigImpl
friend

Definition at line 154 of file Msg.h.

friend class OmmIProviderImpl
friend

Definition at line 159 of file Msg.h.

friend class OmmNiProviderConfigImpl
friend

Definition at line 155 of file Msg.h.

friend class OmmNiProviderImpl
friend

Definition at line 158 of file Msg.h.

friend class ProviderItem
friend

Definition at line 170 of file Msg.h.

friend class SingleItem
friend

Definition at line 164 of file Msg.h.

friend class SubItem
friend

Definition at line 173 of file Msg.h.

friend class TunnelItem
friend

Definition at line 171 of file Msg.h.

friend class TunnelStreamLoginReqMsgImpl
friend

Definition at line 172 of file Msg.h.

Member Data Documentation

Attrib thomsonreuters::ema::access::Msg::_attrib
protected

Definition at line 186 of file Msg.h.

Payload thomsonreuters::ema::access::Msg::_payload
protected

Definition at line 187 of file Msg.h.

MsgDecoder* thomsonreuters::ema::access::Msg::_pDecoder
protected

Definition at line 183 of file Msg.h.

MsgEncoder* thomsonreuters::ema::access::Msg::_pEncoder
protected

Definition at line 184 of file Msg.h.