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

GenericMsg allows applications to bidirectionally send messages without any implied message semantics. More...

Inheritance diagram for refinitiv::ema::access::GenericMsg:
refinitiv::ema::access::Msg refinitiv::ema::access::ComplexType refinitiv::ema::access::Data

Public Member Functions

Constructor
 GenericMsg ()
  More...
 
 GenericMsg (const GenericMsg &other)
  More...
 
Destructor
virtual ~GenericMsg ()
  More...
 
Accessors
DataType::DataTypeEnum getDataType () const
  More...
 
Data::DataCode getCode () const
  More...
 
const EmaBuffergetAsHex () const
  More...
 
const EmaStringtoString () const
  More...
 
const EmaStringtoString (const refinitiv::ema::rdm::DataDictionary &dictionary) const
  More...
 
bool hasSeqNum () const
  More...
 
bool hasSecondarySeqNum () const
  More...
 
bool hasPartNum () const
  More...
 
bool hasPermissionData () const
  More...
 
UInt32 getSeqNum () const
  More...
 
UInt32 getSecondarySeqNum () const
  More...
 
UInt16 getPartNum () const
  More...
 
const EmaBuffergetPermissionData () const
  More...
 
bool getComplete () const
  More...
 
- Public Member Functions inherited from refinitiv::ema::access::Msg
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...
 
virtual ~Msg ()
  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...
 
 operator const char * () const
  More...
 
virtual ~Data ()
  More...
 

Operations

class ItemCallbackClient
 
GenericMsgclear ()
  More...
 
GenericMsgstreamId (Int32 streamId)
  More...
 
GenericMsgdomainType (UInt16 domainType=rdm::MMT_MARKET_PRICE)
  More...
 
GenericMsgname (const EmaString &name)
  More...
 
GenericMsgnameType (UInt8 nameType=rdm::INSTRUMENT_NAME_RIC)
  More...
 
GenericMsgserviceId (UInt32 serviceId)
  More...
 
GenericMsgid (Int32 id)
  More...
 
GenericMsgfilter (UInt32 filter)
  More...
 
GenericMsgseqNum (UInt32 seqNum)
  More...
 
GenericMsgsecondarySeqNum (UInt32 secondarySeqNum)
  More...
 
GenericMsgpartNum (UInt16 partNum)
  More...
 
GenericMsgpermissionData (const EmaBuffer &permissionData)
  More...
 
GenericMsgattrib (const ComplexType &data)
  More...
 
GenericMsgpayload (const ComplexType &data)
  More...
 
GenericMsgextendedHeader (const EmaBuffer &buffer)
  More...
 
GenericMsgproviderDriven (bool providerDriven=true)
  More...
 
GenericMsgcomplete (bool complete=true)
  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::Msg
 Msg ()
 
const Encoder & getEncoder () const
  More...
 
bool hasEncoder () const
  More...
 
void setDecoder (MsgDecoder *)
 
bool hasDecoder () const
  More...
 
- Protected Member Functions inherited from refinitiv::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from refinitiv::ema::access::Data
 Data ()
 
- Protected Attributes inherited from refinitiv::ema::access::Msg
MsgDecoder_pDecoder
 
MsgEncoder * _pEncoder
 
Attrib _attrib
 
Payload _payload
 

Detailed Description

GenericMsg may be sent on any item stream using OmmConsumer::submit( const GenericMsg& , UInt64 ).

The following code snippet shows processing of received GenericMsg.

class AppClient : public OmmConsumerClient
{
...
void onGenericMsg( const GenericMsg& , const OmmConsumerEvent& );
};
void AppClient::onGenericMsg( const GenericMsg& genMsg, const OmmConsumerEvent& )
{
if ( genMsg.hasName() )
cout << genMsg.getName() << "\n";
switch ( gemMsg.getPayload().getDataTyoe() )
{
decode( genMsg.getPayload().getFieldList() );
break;
break;
}
}

The following code snippet shows setting and submission of GenericMsg.

GenericMsg genMsg;
genMsg.name( "my generic message" );
elist.addInt( "int", 123 ).addAscii( "ascii", "my ascii" ).complete();
genMsg.payload( eList );
genMsg.complete( true );
consumer.submit( genMsg, itemHandle );
friend class ElementList
Definition: Data.h:132
Remarks
Calling get***() method on an optional member of GenericMsg must be preceded by a call to respective has***() method.
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform setting and getting of information from GenericMsg.
Objects of this class are not cache-able.
Decoding of just encoded GenericMsg in the same application is not supported.
All methods in this class are Lock-free Method.
See also
Data, Msg, EmaString, EmaBuffer,

Definition at line 87 of file GenericMsg.h.

Constructor & Destructor Documentation

◆ GenericMsg() [1/2]

refinitiv::ema::access::GenericMsg::GenericMsg ( )

Constructs GenericMsg.

◆ GenericMsg() [2/2]

refinitiv::ema::access::GenericMsg::GenericMsg ( const GenericMsg other)

Copy constructor.

Remarks
this is used to copy and process GenericMsg outside of EMA's callback methods.
this method does not support passing in just encoded GenericMsg in the application space.

◆ ~GenericMsg()

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

Destructor.

Member Function Documentation

◆ attrib()

GenericMsg& refinitiv::ema::access::GenericMsg::attrib ( const ComplexType data)

Specifies Attrib.

Parameters
[in]attriban object of ComplexType
Returns
reference to this object

◆ clear()

GenericMsg& refinitiv::ema::access::GenericMsg::clear ( )

Clears the GenericMsg.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object

◆ complete()

GenericMsg& refinitiv::ema::access::GenericMsg::complete ( bool  complete = true)

Specifies Complete.

Remarks
must be set to true for one part generic message
Parameters
[in]completespecifies if this is the last part of the multi part generic message
Returns
reference to this object

◆ domainType()

GenericMsg& refinitiv::ema::access::GenericMsg::domainType ( UInt16  domainType = rdm::MMT_MARKET_PRICE)

Specifies DomainType.

Exceptions
OmmUnsupportedDomainTypeExceptionif domainType is greater than 255
Parameters
[in]domainTypespecifies RDM Message Model Type (default value is rdm::MMT_MARKET_PRICE)
Returns
reference to this object

◆ extendedHeader()

GenericMsg& refinitiv::ema::access::GenericMsg::extendedHeader ( const EmaBuffer buffer)

Specifies ExtendedHeader.

Parameters
[in]bufferan EmaBuffer containing extendedHeader information
Returns
reference to this object

◆ filter()

GenericMsg& refinitiv::ema::access::GenericMsg::filter ( UInt32  filter)

Specifies Filter.

Parameters
[in]filterspecifies filter
Returns
reference to this object

◆ getAsHex()

const EmaBuffer& refinitiv::ema::access::GenericMsg::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
a buffer with the message hex information

Implements refinitiv::ema::access::Data.

◆ getCode()

Data::DataCode refinitiv::ema::access::GenericMsg::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::NoCodeEnum

Implements refinitiv::ema::access::Data.

◆ getComplete()

bool refinitiv::ema::access::GenericMsg::getComplete ( ) const

Returns Complete.

Returns
true if this is a one part generic message or the final part of the multi part generic message.

◆ getDataType()

DataType::DataTypeEnum refinitiv::ema::access::GenericMsg::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type.

Returns
DataType::GenericMsgEnum

Implements refinitiv::ema::access::Data.

◆ getPartNum()

UInt16 refinitiv::ema::access::GenericMsg::getPartNum ( ) const

Returns PartNum.

Exceptions
OmmInvalidUsageExceptionif hasPartNum() returns false
Returns
part number

◆ getPermissionData()

const EmaBuffer& refinitiv::ema::access::GenericMsg::getPermissionData ( ) const

Returns PermissionData.

Exceptions
OmmInvalidUsageExceptionif hasPermissionData() returns false
Returns
EmaBuffer containing permission data

◆ getSecondarySeqNum()

UInt32 refinitiv::ema::access::GenericMsg::getSecondarySeqNum ( ) const

Returns SecondarySeqNum.

Exceptions
OmmInvalidUsageExceptionif hasSecondarySeqNum() returns false
Returns
secondary sequence number

◆ getSeqNum()

UInt32 refinitiv::ema::access::GenericMsg::getSeqNum ( ) const

Returns SeqNum.

Exceptions
OmmInvalidUsageExceptionif hasSeqNum() returns false
Returns
sequence number

◆ hasPartNum()

bool refinitiv::ema::access::GenericMsg::hasPartNum ( ) const

Indicates presence of PartNum.

Remarks
part number is an optional member of GenericMsg
Returns
true if part number is set; false otherwise

◆ hasPermissionData()

bool refinitiv::ema::access::GenericMsg::hasPermissionData ( ) const

Indicates presence of PermissionData.

Remarks
permission data is optional on GenericMsg
Returns
true if permission data is set; false otherwise

◆ hasSecondarySeqNum()

bool refinitiv::ema::access::GenericMsg::hasSecondarySeqNum ( ) const

Indicates presence of SecondarySeqNum.

Remarks
secondary sequence number is an optional member of GenericMsg
Returns
true if secondary sequence number is set; false otherwise

◆ hasSeqNum()

bool refinitiv::ema::access::GenericMsg::hasSeqNum ( ) const

Indicates presence of SeqNum.

Remarks
sequence number is an optional member of GenericMsg
Returns
true if sequence number is set; false otherwise

◆ id()

GenericMsg& refinitiv::ema::access::GenericMsg::id ( Int32  id)

Specifies Id.

Parameters
[in]idspecifies Id
Returns
reference to this object

◆ name()

GenericMsg& refinitiv::ema::access::GenericMsg::name ( const EmaString name)

Specifies Name.

Parameters
[in]namespecifies item name
Returns
reference to this object

◆ nameType()

GenericMsg& refinitiv::ema::access::GenericMsg::nameType ( UInt8  nameType = rdm::INSTRUMENT_NAME_RIC)

Specifies NameType.

Parameters
[in]nameTypespecifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC)
Returns
reference to this object

◆ partNum()

GenericMsg& refinitiv::ema::access::GenericMsg::partNum ( UInt16  partNum)

Specifies PartNum.

Parameters
[in]partNumspecifies part number
Returns
reference to this object

◆ payload()

GenericMsg& refinitiv::ema::access::GenericMsg::payload ( const ComplexType data)

Specifies Payload.

Parameters
[in]payloadan object of ComplexType
Returns
reference to this object

◆ permissionData()

GenericMsg& refinitiv::ema::access::GenericMsg::permissionData ( const EmaBuffer permissionData)

Specifies PermissionData.

Parameters
[in]permissionDataan EmaBuffer object with permission data information
Returns
reference to this object

◆ providerDriven()

GenericMsg& refinitiv::ema::access::GenericMsg::providerDriven ( bool  providerDriven = true)

Specifies ProviderDriven.

Parameters
[in]providerDrivenspecifies ProviderDriven
Returns
reference to this object

◆ secondarySeqNum()

GenericMsg& refinitiv::ema::access::GenericMsg::secondarySeqNum ( UInt32  secondarySeqNum)

Specifies SecondarySeqNum.

Parameters
[in]secondarySeqNumspecifies secondary sequence number
Returns
reference to this object

◆ seqNum()

GenericMsg& refinitiv::ema::access::GenericMsg::seqNum ( UInt32  seqNum)

Specifies SeqNum.

Parameters
[in]seqNumspecifies sequence number
Returns
reference to this object

◆ serviceId()

GenericMsg& refinitiv::ema::access::GenericMsg::serviceId ( UInt32  serviceId)

Specifies ServiceId.

Parameters
[in]serviceIdspecifies service id
Returns
reference to this object

◆ streamId()

GenericMsg& refinitiv::ema::access::GenericMsg::streamId ( Int32  streamId)

Specifies StreamId.

Parameters
[in]streamIdspecifies stream id
Returns
reference to this object

◆ toString() [1/2]

const EmaString& refinitiv::ema::access::GenericMsg::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements refinitiv::ema::access::Data.

◆ toString() [2/2]

const EmaString& refinitiv::ema::access::GenericMsg::toString ( const refinitiv::ema::rdm::DataDictionary dictionary) const

Returns a string representation of the class instance for just encoded object.

Parameters
[in]dictionaryuse for toString() conversion
Returns
string representation of the class instance