RefreshMsg conveys item image, state, permission and group information. 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 |
RefreshMsg is sent when item data needs to be synchronized. This happens as a response to received ReqMsg or when upstream source requires it. RefreshMsg sent as a response to ReqMsg is called solicited refresh while unsolicited refresh is sent when upstream source requires synchronization of downstream consumers.
The following code snippet shows receiving and processing of RefreshMsg.
Definition at line 79 of file RefreshMsg.h.
refinitiv::ema::access::RefreshMsg::RefreshMsg | ( | ) |
Constructs RefreshMsg.
refinitiv::ema::access::RefreshMsg::RefreshMsg | ( | const RefreshMsg & | other | ) |
Copy constructor.
|
virtual |
Destructor.
RefreshMsg& refinitiv::ema::access::RefreshMsg::attrib | ( | const ComplexType & | data | ) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::clear | ( | ) |
Clears the RefreshMsg.
RefreshMsg& refinitiv::ema::access::RefreshMsg::clearCache | ( | bool | clearCache = false | ) |
Specifies ClearCache.
[in] | clearCache | true if cache needs to be cleared; false otherwise (default value is false) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::complete | ( | bool | complete = true | ) |
Specifies RefreshComplete.
[in] | complete | true if this is the last part of multi part refresh or single part refresh; false otherwise (default value is true) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::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) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::doNotCache | ( | bool | doNotCache = false | ) |
Specifies DoNotCache.
[in] | doNotCache | true if this refresh must not be cached; false otherwise (default value is false) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::extendedHeader | ( | const EmaBuffer & | buffer | ) |
Specifies ExtendedHeader.
[in] | buffer | an EmaBuffer containing extendedHeader information |
RefreshMsg& refinitiv::ema::access::RefreshMsg::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.
bool refinitiv::ema::access::RefreshMsg::getClearCache | ( | ) | const |
Returns ClearCache.
|
virtual |
Returns the Code, which indicates a special state of a DataType.
Implements refinitiv::ema::access::Data.
bool refinitiv::ema::access::RefreshMsg::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.
bool refinitiv::ema::access::RefreshMsg::getDoNotCache | ( | ) | const |
Returns DoNotCache.
const EmaBuffer& refinitiv::ema::access::RefreshMsg::getItemGroup | ( | ) | const |
Returns ItemGroup.
UInt16 refinitiv::ema::access::RefreshMsg::getPartNum | ( | ) | const |
Returns PartNum.
OmmInvalidUsageException | if hasPartNum() returns false |
const EmaBuffer& refinitiv::ema::access::RefreshMsg::getPermissionData | ( | ) | const |
Returns PermissionData.
OmmInvalidUsageException | if hasPermissionData() returns false |
bool refinitiv::ema::access::RefreshMsg::getPrivateStream | ( | ) | const |
Returns PrivateStream. @retturn true if this is private stream item
UInt32 refinitiv::ema::access::RefreshMsg::getPublisherIdUserAddress | ( | ) | const |
Returns PublisherIdUserAddress.
OmmInvalidUsageException | if hasPublisherId() returns false |
UInt32 refinitiv::ema::access::RefreshMsg::getPublisherIdUserId | ( | ) | const |
Returns PublisherIdUserId.
OmmInvalidUsageException | if hasPublisherId() returns false |
const OmmQos& refinitiv::ema::access::RefreshMsg::getQos | ( | ) | const |
UInt32 refinitiv::ema::access::RefreshMsg::getSeqNum | ( | ) | const |
Returns SeqNum.
OmmInvalidUsageException | if hasSeqNum() returns false |
const EmaString& refinitiv::ema::access::RefreshMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
OmmInvalidUsageException | if hasServiceName() returns false |
bool refinitiv::ema::access::RefreshMsg::getSolicited | ( | ) | const |
Returns Solicited.
const OmmState& refinitiv::ema::access::RefreshMsg::getState | ( | ) | const |
Returns State.
bool refinitiv::ema::access::RefreshMsg::hasPartNum | ( | ) | const |
Indicates presence of PartNum.
bool refinitiv::ema::access::RefreshMsg::hasPermissionData | ( | ) | const |
Indicates presence of PermissionData.
bool refinitiv::ema::access::RefreshMsg::hasPublisherId | ( | ) | const |
Indicates presence of PublisherId.
bool refinitiv::ema::access::RefreshMsg::hasQos | ( | ) | const |
Indicates presence of Qos.
bool refinitiv::ema::access::RefreshMsg::hasSeqNum | ( | ) | const |
Indicates presence of SeqNum.
bool refinitiv::ema::access::RefreshMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
RefreshMsg& refinitiv::ema::access::RefreshMsg::id | ( | Int32 | id | ) |
Specifies Id.
[in] | id | specifies Id |
RefreshMsg& refinitiv::ema::access::RefreshMsg::itemGroup | ( | const EmaBuffer & | itemGroup | ) |
Specifies ItemGroup.
[in] | itemGroup | an EmaBuffer object with item group information |
RefreshMsg& refinitiv::ema::access::RefreshMsg::name | ( | const EmaString & | name | ) |
Specifies Name.
[in] | name | an EmaString object containing item name |
RefreshMsg& refinitiv::ema::access::RefreshMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::partNum | ( | UInt16 | partNum | ) |
Specifies PartNum.
[in] | partNum | specifies part number |
RefreshMsg& refinitiv::ema::access::RefreshMsg::payload | ( | const ComplexType & | data | ) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::permissionData | ( | const EmaBuffer & | permissionData | ) |
Specifies PermissionData.
[in] | permissionData | an EmaBuffer object with permission data information |
RefreshMsg& refinitiv::ema::access::RefreshMsg::privateStream | ( | bool | privateStream = false | ) |
Specifies PrivateStream.
[in] | privateStream | true if private stream; false otherwise (default value is false) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::publisherId | ( | UInt32 | userId, |
UInt32 | userAddress | ||
) |
Specifies PublisherId.
[in] | UserId | specifies publisher's user id |
[in] | UserAddress | specifies publisher's user address |
RefreshMsg& refinitiv::ema::access::RefreshMsg::qos | ( | UInt32 | timeliness = OmmQos::RealTimeEnum , |
UInt32 | rate = OmmQos::TickByTickEnum |
||
) |
Specifies Qos.
[in] | timeliness | specifies Qos Timeliness (default value is OmmQos::RealTimeEnum) |
[in] | rate | specifies Qos rate (default value is OmmQos::TickByTickEnum) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::seqNum | ( | UInt32 | seqNum | ) |
Specifies SeqNum.
[in] | seqNum | specifies sequence number |
RefreshMsg& refinitiv::ema::access::RefreshMsg::serviceId | ( | UInt32 | serviceId | ) |
Specifies ServiceId.
OmmInvalidUsageException | if service name is already set |
[in] | serviceId | service identifier |
RefreshMsg& refinitiv::ema::access::RefreshMsg::serviceName | ( | const EmaString & | serviceName | ) |
Specifies ServiceName.
OmmInvalidUsageException | if service id is already set |
[in] | serviceName | an EmaString object containing service name |
RefreshMsg& refinitiv::ema::access::RefreshMsg::solicited | ( | bool | solicited = false | ) |
Specifies Solicited.
[in] | solicited | true if this refresh is solicited; false otherwise (default value is false) |
RefreshMsg& refinitiv::ema::access::RefreshMsg::state | ( | OmmState::StreamState | streamState = OmmState::OpenEnum , |
OmmState::DataState | dataState = OmmState::OkEnum , |
||
UInt8 | statusCode = 0 , |
||
const EmaString & | statusText = EmaString() |
||
) |
Specifies State.
[in] | streamState | conveys item stream state value (default value is OmmState::OpenEnum) |
[in] | dataState | conveys item data state value (default value is OmmState::SuspectEnum) |
[in] | statusCode | conveys specific item state code (default value is OmmState::NoneEnum) |
[in] | statusText | conveys item status explanation (default value is 'empty string') |
RefreshMsg& refinitiv::ema::access::RefreshMsg::streamId | ( | Int32 | streamId | ) |
Specifies StreamId.
[in] | id | stream id |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::RefreshMsg::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 |
![]() |
![]() |
|