StatusMsg conveys item state 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 |
StatusMsg is used to convey item state information, permission change or item group id change.
The following code snippet shows receiving and processing of StatusMsg.
Definition at line 80 of file StatusMsg.h.
refinitiv::ema::access::StatusMsg::StatusMsg | ( | ) |
Constructs StatusMsg.
refinitiv::ema::access::StatusMsg::StatusMsg | ( | const StatusMsg & | other | ) |
|
virtual |
Destructor.
StatusMsg& refinitiv::ema::access::StatusMsg::attrib | ( | const ComplexType & | data | ) |
StatusMsg& refinitiv::ema::access::StatusMsg::clear | ( | ) |
StatusMsg& refinitiv::ema::access::StatusMsg::clearCache | ( | bool | clearCache = false | ) |
Specifies ClearCache.
[in] | clearCache | true if cache needs to be cleared; false otherwise (default value is false) |
StatusMsg& refinitiv::ema::access::StatusMsg::domainType | ( | UInt16 | domainType = refinitiv::ema::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.
bool refinitiv::ema::access::StatusMsg::getClearCache | ( | ) | const |
Returns ClearCache.
|
virtual |
Returns the Code, which indicates a special state of a DataType.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type.
Implements refinitiv::ema::access::Data.
const EmaBuffer& refinitiv::ema::access::StatusMsg::getItemGroup | ( | ) | const |
Returns ItemGroup.
OmmInvalidUsageException | if hasItemGroup() returns false |
const EmaBuffer& refinitiv::ema::access::StatusMsg::getPermissionData | ( | ) | const |
Returns PermissionData.
OmmInvalidUsageException | if hasPermissionData() returns false |
bool refinitiv::ema::access::StatusMsg::getPrivateStream | ( | ) | const |
Returns PrivateStream. @retturn true if this is private stream item; false otherwise
UInt32 refinitiv::ema::access::StatusMsg::getPublisherIdUserAddress | ( | ) | const |
Returns PublisherIdUserAddress.
OmmInvalidUsageException | if hasPublisherId() returns false |
UInt32 refinitiv::ema::access::StatusMsg::getPublisherIdUserId | ( | ) | const |
Returns PublisherIdUserId.
OmmInvalidUsageException | if hasPublisherId() returns false |
const EmaString& refinitiv::ema::access::StatusMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
const OmmState& refinitiv::ema::access::StatusMsg::getState | ( | ) | const |
Returns State.
OmmInvalidUsageException | if hasState() returns false |
bool refinitiv::ema::access::StatusMsg::hasItemGroup | ( | ) | const |
Indicates presence of ItemGroup.
bool refinitiv::ema::access::StatusMsg::hasPermissionData | ( | ) | const |
Indicates presence of PermissionData.
bool refinitiv::ema::access::StatusMsg::hasPublisherId | ( | ) | const |
Indicates presence of PublisherId.
bool refinitiv::ema::access::StatusMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
bool refinitiv::ema::access::StatusMsg::hasState | ( | ) | const |
Indicates presence of State.
Specifies Id.
[in] | id | specifies Id |
Specifies ItemGroup.
[in] | itemGroup | an EmaBuffer object with item group information |
Specifies Name.
[in] | name | specifies item name |
StatusMsg& refinitiv::ema::access::StatusMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
StatusMsg& refinitiv::ema::access::StatusMsg::payload | ( | const ComplexType & | data | ) |
Specifies PermissionData.
[in] | permissionData | an EmaBuffer object with permission data information |
StatusMsg& refinitiv::ema::access::StatusMsg::privateStream | ( | bool | privateStream = false | ) |
Specifies PrivateStream.
[in] | privateStream | true if private stream; false otherwise (default value is false) |
Specifies PublisherId.
[in] | UserId | specifies publisher's user id |
[in] | UserAddress | specifies publisher's user address |
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 |
StatusMsg& refinitiv::ema::access::StatusMsg::state | ( | OmmState::StreamState | streamState = OmmState::OpenEnum , |
OmmState::DataState | dataState = OmmState::OkEnum , |
||
UInt8 | statusCode = OmmState::NoneEnum , |
||
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') |
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::StatusMsg::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 |
![]() |
![]() |
|