UpdateMsg conveys changes to item data. 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 |
The following code snippet shows receiving and processing of UpdateMsg.
Definition at line 72 of file UpdateMsg.h.
refinitiv::ema::access::UpdateMsg::UpdateMsg | ( | ) |
Constructs UpdateMsg.
refinitiv::ema::access::UpdateMsg::UpdateMsg | ( | const UpdateMsg & | other | ) |
|
virtual |
Destructor.
UpdateMsg& refinitiv::ema::access::UpdateMsg::attrib | ( | const ComplexType & | data | ) |
UpdateMsg& refinitiv::ema::access::UpdateMsg::clear | ( | ) |
Specifies Conflated.
[in] | count | specifies how many updates were conflated |
[in] | time | specifies how long the conflation was on |
UpdateMsg& refinitiv::ema::access::UpdateMsg::domainType | ( | UInt16 | domainType = rdm::MMT_MARKET_PRICE | ) |
Specifies DomainType.
OmmUnsupportedDomainType | if domainType is greater than 255 |
[in] | domainType | specifies RDM Message Model Type (default value is rdm::MMT_MARKET_PRICE) |
UpdateMsg& refinitiv::ema::access::UpdateMsg::doNotCache | ( | bool | doNotCache = false | ) |
Specifies DoNotCache.
[in] | doNotCache | true if this update must not be cached; false otherwise (default value is false) |
UpdateMsg& refinitiv::ema::access::UpdateMsg::doNotConflate | ( | bool | doNotConflate = false | ) |
Specifies DoNotConflate.
[in] | doNotConflate | true if this update must not be conflated; false otherwise (default value is false) |
UpdateMsg& refinitiv::ema::access::UpdateMsg::doNotRipple | ( | bool | doNotRipple = false | ) |
Specifies DoNotRipple.
[in] | doNotRipple | true if this update does not ripple; false otherwise (default value is false) |
Specifies ExtendedHeader.
[in] | buffer | an EmaBuffer containing extendedHeader information |
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.
UInt16 refinitiv::ema::access::UpdateMsg::getConflatedCount | ( | ) | const |
Returns ConflatedCount.
OmmInvalidUsageException | if hasConflated() returns false |
UInt16 refinitiv::ema::access::UpdateMsg::getConflatedTime | ( | ) | const |
Returns ConflatedTime.
OmmInvalidUsageException | if hasConflated() returns false |
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type.
Implements refinitiv::ema::access::Data.
bool refinitiv::ema::access::UpdateMsg::getDoNotCache | ( | ) | const |
Returns DoNotCache.
bool refinitiv::ema::access::UpdateMsg::getDoNotConflate | ( | ) | const |
Returns DoNotConflate.
bool refinitiv::ema::access::UpdateMsg::getDoNotRipple | ( | ) | const |
Returns DoNotRipple.
const EmaBuffer& refinitiv::ema::access::UpdateMsg::getPermissionData | ( | ) | const |
Returns PermissionData.
OmmInvalidUsageException | if hasPermissionData() returns false |
UInt32 refinitiv::ema::access::UpdateMsg::getPublisherIdUserAddress | ( | ) | const |
Returns PublisherIdUserAddress.
OmmInvalidUsageException | if hasPublisherId() returns false |
UInt32 refinitiv::ema::access::UpdateMsg::getPublisherIdUserId | ( | ) | const |
Returns PublisherIdUserId.
OmmInvalidUsageException | if hasPublisherId() returns false |
UInt32 refinitiv::ema::access::UpdateMsg::getSeqNum | ( | ) | const |
Returns SeqNum.
OmmInvalidUsageException | if hasSeqNum() returns false |
const EmaString& refinitiv::ema::access::UpdateMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
OmmInvalidUsageException | if hasServiceName() returns false |
UInt8 refinitiv::ema::access::UpdateMsg::getUpdateTypeNum | ( | ) | const |
Returns UpdateTypeNum.
bool refinitiv::ema::access::UpdateMsg::hasConflated | ( | ) | const |
Indicates presence of Conflated.
bool refinitiv::ema::access::UpdateMsg::hasPermissionData | ( | ) | const |
Indicates presence of PermissionData.
bool refinitiv::ema::access::UpdateMsg::hasPublisherId | ( | ) | const |
Indicates presence of PublisherId.
bool refinitiv::ema::access::UpdateMsg::hasSeqNum | ( | ) | const |
Indicates presence of SeqNum.
bool refinitiv::ema::access::UpdateMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
Specifies Id.
[in] | id | specifies Id |
Specifies Name.
[in] | name | specifies item name |
UpdateMsg& refinitiv::ema::access::UpdateMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
UpdateMsg& refinitiv::ema::access::UpdateMsg::payload | ( | const ComplexType & | data | ) |
Specifies PermissionData.
[in] | permissionData | an EmaBuffer object with permission data information |
Specifies PublisherId.
[in] | UserId | specifies publisher's user id |
[in] | UserAddress | specifies publisher's user address |
Specifies SeqNum.
[in] | seqNum | specifies sequence number |
Specifies ServiceId.
OmmInvalidUsageException | if service name is already set |
[in] | serviceId | specifies service id |
Specifies ServiceName.
OmmInvalidUsageException | if service id is already set |
[in] | serviceName | specifies service name |
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::UpdateMsg::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 |
Specifies UpdateTypeNum.
[in] | updateTypeNum | specifies update type number (e.g., rdm::INSTRUMENT_UPDATE_QUOTE) |
![]() |
![]() |
|