ReqMsg allows consumer application to express its interest in an item. More...
Public Types | |
enum | Rate { TickByTickEnum = 0 , JustInTimeConflatedEnum = 0xFFFFFF00 , BestConflatedRateEnum = 0xFFFFFFFF , BestRateEnum = 0xFFFFFFFE } |
enum | Timeliness { RealTimeEnum = 0 , BestDelayedTimelinessEnum = 0xFFFFFFFF , BestTimelinessEnum = 0xFFFFFFFE } |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
Additional Inherited Members | |
![]() | |
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 |
Among other attributes, ReqMsg conveys item's name, service, domain type, and desired quality of service. ReqMsg may also be used to: specify application interest in a dynamic view, open a batch of items, or request a symbol list item with its data.
The following code snippet shows specification of ReqMsg and registration of interest in this item.
An enumeration representing Qos Rate.
An enumeration representing Qos Timeliness.
refinitiv::ema::access::ReqMsg::ReqMsg | ( | ) |
Constructs ReqMsg.
refinitiv::ema::access::ReqMsg::ReqMsg | ( | const ReqMsg & | other | ) |
|
virtual |
Destructor.
ReqMsg& refinitiv::ema::access::ReqMsg::attrib | ( | const ComplexType & | data | ) |
ReqMsg& refinitiv::ema::access::ReqMsg::clear | ( | ) |
ReqMsg& refinitiv::ema::access::ReqMsg::conflatedInUpdates | ( | bool | conflatedInUpdates = false | ) |
Specifies ConflatedInUpdates.
[in] | conflatedInUpdates | specifies if conflated update is requested (default value is false) |
ReqMsg& refinitiv::ema::access::ReqMsg::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) |
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.
bool refinitiv::ema::access::ReqMsg::getConflatedInUpdates | ( | ) | const |
Returns ConflatedInUpdates.
|
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::ReqMsg::getInitialImage | ( | ) | const |
Returns InitialImage.
bool refinitiv::ema::access::ReqMsg::getInterestAfterRefresh | ( | ) | const |
Returns InterestAfterRefresh.
bool refinitiv::ema::access::ReqMsg::getPause | ( | ) | const |
Returns Pause.
UInt8 refinitiv::ema::access::ReqMsg::getPriorityClass | ( | ) | const |
Returns PriorityClass.
OmmInvalidUsageException | if hasPriority() returns false |
UInt16 refinitiv::ema::access::ReqMsg::getPriorityCount | ( | ) | const |
Returns PriorityCount.
OmmInvalidUsageException | if hasPriority() returns false |
bool refinitiv::ema::access::ReqMsg::getPrivateStream | ( | ) | const |
Returns PrivateStream.
UInt32 refinitiv::ema::access::ReqMsg::getQosRate | ( | ) | const |
UInt32 refinitiv::ema::access::ReqMsg::getQosTimeliness | ( | ) | const |
Returns QosTimeliness.
OmmInvalidUsageException | if hasQos() returns false |
const EmaString& refinitiv::ema::access::ReqMsg::getRateAsString | ( | ) | const |
Returns the Rate value as a string format.
const EmaString& refinitiv::ema::access::ReqMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
OmmInvalidUsageException | if hasServiceName() returns false |
const EmaString& refinitiv::ema::access::ReqMsg::getTimelinessAsString | ( | ) | const |
Returns the Timeliness value as a string format.
bool refinitiv::ema::access::ReqMsg::hasBatch | ( | ) | const |
Indicates presence of Batch.
bool refinitiv::ema::access::ReqMsg::hasPriority | ( | ) | const |
Indicates presence of Priority.
bool refinitiv::ema::access::ReqMsg::hasQos | ( | ) | const |
bool refinitiv::ema::access::ReqMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
bool refinitiv::ema::access::ReqMsg::hasView | ( | ) | const |
Indicates presence of View.
Specifies Id.
[in] | id | specifies Id |
ReqMsg& refinitiv::ema::access::ReqMsg::initialImage | ( | bool | initialImage = true | ) |
Specifies InitialImage.
[in] | initialImage | specifies if initial image / refresh is requested (default value is true) |
ReqMsg& refinitiv::ema::access::ReqMsg::interestAfterRefresh | ( | bool | interestAfterRefresh = true | ) |
Specifies InterestAfterRefresh.
[in] | interestAfterRefresh | specifies if streaming or snapshot item is requested default value is true / streaming item) |
Specifies Name.
[in] | name | specifies item name |
ReqMsg& refinitiv::ema::access::ReqMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
ReqMsg& refinitiv::ema::access::ReqMsg::pause | ( | bool | pause = false | ) |
Specifies Pause.
[in] | pause | specifies if pause is requested (default value is false) |
ReqMsg& refinitiv::ema::access::ReqMsg::payload | ( | const ComplexType & | data | ) |
ReqMsg& refinitiv::ema::access::ReqMsg::priority | ( | UInt8 | priorityClass = 1 , |
UInt16 | priorityCount = 1 |
||
) |
Specifies Priority.
[in] | priorityClass | specifies priority class |
[in] | priorityCount | specifies priority count within priority class |
ReqMsg& refinitiv::ema::access::ReqMsg::privateStream | ( | bool | privateStream = false | ) |
Specifies PrivateStream.
[in] | privateStream | specifies if private stream is requested (default value is false) |
ReqMsg& refinitiv::ema::access::ReqMsg::qos | ( | UInt32 | timeliness = BestTimelinessEnum , |
UInt32 | rate = BestRateEnum |
||
) |
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::ReqMsg::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 |
![]() |
![]() |
|