GenericMsg allows applications to bidirectionally send messages without any implied message semantics. More...
Operations | |
class | ItemCallbackClient |
GenericMsg & | clear () |
More... | |
GenericMsg & | streamId (Int32 streamId) |
More... | |
GenericMsg & | domainType (UInt16 domainType=rdm::MMT_MARKET_PRICE) |
More... | |
GenericMsg & | name (const EmaString &name) |
More... | |
GenericMsg & | nameType (UInt8 nameType=rdm::INSTRUMENT_NAME_RIC) |
More... | |
GenericMsg & | serviceId (UInt32 serviceId) |
More... | |
GenericMsg & | id (Int32 id) |
More... | |
GenericMsg & | filter (UInt32 filter) |
More... | |
GenericMsg & | seqNum (UInt32 seqNum) |
More... | |
GenericMsg & | secondarySeqNum (UInt32 secondarySeqNum) |
More... | |
GenericMsg & | partNum (UInt16 partNum) |
More... | |
GenericMsg & | permissionData (const EmaBuffer &permissionData) |
More... | |
GenericMsg & | attrib (const ComplexType &data) |
More... | |
GenericMsg & | payload (const ComplexType &data) |
More... | |
GenericMsg & | extendedHeader (const EmaBuffer &buffer) |
More... | |
GenericMsg & | providerDriven (bool providerDriven=true) |
More... | |
GenericMsg & | complete (bool complete=true) |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
Msg () | |
const Encoder & | getEncoder () const |
More... | |
bool | hasEncoder () const |
More... | |
void | setDecoder (MsgDecoder *) |
bool | hasDecoder () const |
More... | |
![]() | |
ComplexType () | |
![]() | |
Data () | |
![]() | |
MsgDecoder * | _pDecoder |
MsgEncoder * | _pEncoder |
Attrib | _attrib |
Payload | _payload |
GenericMsg may be sent on any item stream using OmmConsumer::submit( const GenericMsg& , UInt64 ).
The following code snippet shows processing of received GenericMsg.
The following code snippet shows setting and submission of GenericMsg.
Definition at line 87 of file GenericMsg.h.
refinitiv::ema::access::GenericMsg::GenericMsg | ( | ) |
Constructs GenericMsg.
refinitiv::ema::access::GenericMsg::GenericMsg | ( | const GenericMsg & | other | ) |
Copy constructor.
|
virtual |
Destructor.
GenericMsg& refinitiv::ema::access::GenericMsg::attrib | ( | const ComplexType & | data | ) |
GenericMsg& refinitiv::ema::access::GenericMsg::clear | ( | ) |
Clears the GenericMsg.
GenericMsg& refinitiv::ema::access::GenericMsg::complete | ( | bool | complete = true | ) |
Specifies Complete.
[in] | complete | specifies if this is the last part of the multi part generic message |
GenericMsg& refinitiv::ema::access::GenericMsg::domainType | ( | UInt16 | domainType = rdm::MMT_MARKET_PRICE | ) |
Specifies DomainType.
OmmUnsupportedDomainTypeException | if domainType is greater than 255 |
[in] | domainType | specifies RDM Message Model Type (default value is rdm::MMT_MARKET_PRICE) |
GenericMsg& refinitiv::ema::access::GenericMsg::extendedHeader | ( | const EmaBuffer & | buffer | ) |
Specifies ExtendedHeader.
[in] | buffer | an EmaBuffer containing extendedHeader information |
GenericMsg& refinitiv::ema::access::GenericMsg::filter | ( | UInt32 | filter | ) |
Specifies Filter.
[in] | filter | specifies filter |
|
virtual |
Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the Code, which indicates a special state of a DataType.
Implements refinitiv::ema::access::Data.
bool refinitiv::ema::access::GenericMsg::getComplete | ( | ) | const |
Returns Complete.
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type.
Implements refinitiv::ema::access::Data.
UInt16 refinitiv::ema::access::GenericMsg::getPartNum | ( | ) | const |
Returns PartNum.
OmmInvalidUsageException | if hasPartNum() returns false |
const EmaBuffer& refinitiv::ema::access::GenericMsg::getPermissionData | ( | ) | const |
Returns PermissionData.
OmmInvalidUsageException | if hasPermissionData() returns false |
UInt32 refinitiv::ema::access::GenericMsg::getSecondarySeqNum | ( | ) | const |
Returns SecondarySeqNum.
OmmInvalidUsageException | if hasSecondarySeqNum() returns false |
UInt32 refinitiv::ema::access::GenericMsg::getSeqNum | ( | ) | const |
Returns SeqNum.
OmmInvalidUsageException | if hasSeqNum() returns false |
bool refinitiv::ema::access::GenericMsg::hasPartNum | ( | ) | const |
Indicates presence of PartNum.
bool refinitiv::ema::access::GenericMsg::hasPermissionData | ( | ) | const |
Indicates presence of PermissionData.
bool refinitiv::ema::access::GenericMsg::hasSecondarySeqNum | ( | ) | const |
Indicates presence of SecondarySeqNum.
bool refinitiv::ema::access::GenericMsg::hasSeqNum | ( | ) | const |
Indicates presence of SeqNum.
GenericMsg& refinitiv::ema::access::GenericMsg::id | ( | Int32 | id | ) |
Specifies Id.
[in] | id | specifies Id |
GenericMsg& refinitiv::ema::access::GenericMsg::name | ( | const EmaString & | name | ) |
Specifies Name.
[in] | name | specifies item name |
GenericMsg& refinitiv::ema::access::GenericMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
GenericMsg& refinitiv::ema::access::GenericMsg::partNum | ( | UInt16 | partNum | ) |
Specifies PartNum.
[in] | partNum | specifies part number |
GenericMsg& refinitiv::ema::access::GenericMsg::payload | ( | const ComplexType & | data | ) |
GenericMsg& refinitiv::ema::access::GenericMsg::permissionData | ( | const EmaBuffer & | permissionData | ) |
Specifies PermissionData.
[in] | permissionData | an EmaBuffer object with permission data information |
GenericMsg& refinitiv::ema::access::GenericMsg::providerDriven | ( | bool | providerDriven = true | ) |
Specifies ProviderDriven.
[in] | providerDriven | specifies ProviderDriven |
GenericMsg& refinitiv::ema::access::GenericMsg::secondarySeqNum | ( | UInt32 | secondarySeqNum | ) |
Specifies SecondarySeqNum.
[in] | secondarySeqNum | specifies secondary sequence number |
GenericMsg& refinitiv::ema::access::GenericMsg::seqNum | ( | UInt32 | seqNum | ) |
Specifies SeqNum.
[in] | seqNum | specifies sequence number |
GenericMsg& refinitiv::ema::access::GenericMsg::serviceId | ( | UInt32 | serviceId | ) |
Specifies ServiceId.
[in] | serviceId | specifies service id |
GenericMsg& refinitiv::ema::access::GenericMsg::streamId | ( | Int32 | streamId | ) |
Specifies StreamId.
[in] | streamId | specifies stream id |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
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.
[in] | dictionary | use for toString() conversion |
![]() |
![]() |
|