AckMsg indicates success or failure of PostMsg. More...
Public Types | |
enum | NackCode { NoneEnum = 0 , AccessDeniedEnum = 1 , DeniedBySourceEnum = 2 , SourceDownEnum = 3 , SourceUnknownEnum = 4 , NoResourcesEnum = 5 , NoResponseEnum = 6 , GatewayDownEnum = 7 , SymbolUnknownEnum = 10 , NotOpenEnum = 11 , InvalidContentEnum = 12 } |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
Operations | |
class | ItemCallbackClient |
AckMsg & | clear () |
More... | |
AckMsg & | streamId (Int32 streamId) |
More... | |
AckMsg & | domainType (UInt16 domainType=rdm::MMT_MARKET_PRICE) |
More... | |
AckMsg & | name (const EmaString &name) |
More... | |
AckMsg & | nameType (UInt8 nameType=rdm::INSTRUMENT_NAME_RIC) |
More... | |
AckMsg & | serviceName (const EmaString &serviceName) |
More... | |
AckMsg & | serviceId (UInt32 serviceId) |
More... | |
AckMsg & | id (Int32 id) |
More... | |
AckMsg & | filter (UInt32 filter) |
More... | |
AckMsg & | seqNum (UInt32 seqNum) |
More... | |
AckMsg & | ackId (UInt32 postId) |
More... | |
AckMsg & | nackCode (UInt8 nackCode) |
More... | |
AckMsg & | text (const EmaString &text) |
More... | |
AckMsg & | attrib (const ComplexType &attrib) |
More... | |
AckMsg & | payload (const ComplexType &payload) |
More... | |
AckMsg & | extendedHeader (const EmaBuffer &buffer) |
More... | |
AckMsg & | privateStream (bool privateStream=false) |
More... | |
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 |
If requested, AckMsg is sent by provider acting on PostMsg received from consumer. AckMsg indicates success or failure of caching / processing of received PostMsg. AckMsg is optional. Consumer requests provider to send AckMsg by calling PostMsg::solicitAck( true ).
The following code snippet shows processing of received AckMsg.
An enumeration representing negative acknowledgement code.
refinitiv::ema::access::AckMsg::AckMsg | ( | ) |
Constructs AckMsg.
refinitiv::ema::access::AckMsg::AckMsg | ( | const AckMsg & | other | ) |
|
virtual |
Destructor.
Specifies AckId.
[in] | postId | specifies related post id |
AckMsg& refinitiv::ema::access::AckMsg::attrib | ( | const ComplexType & | attrib | ) |
AckMsg& refinitiv::ema::access::AckMsg::clear | ( | ) |
AckMsg& refinitiv::ema::access::AckMsg::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 |
UInt32 refinitiv::ema::access::AckMsg::getAckId | ( | ) | const |
Returns the AckId.
|
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.
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type.
Implements refinitiv::ema::access::Data.
UInt8 refinitiv::ema::access::AckMsg::getNackCode | ( | ) | const |
const EmaString& refinitiv::ema::access::AckMsg::getNackCodeAsString | ( | ) | const |
Returns the NackCode value as a string format.
bool refinitiv::ema::access::AckMsg::getPrivateStream | ( | ) | const |
Returns PrivateStream.
UInt32 refinitiv::ema::access::AckMsg::getSeqNum | ( | ) | const |
Returns SeqNum.
OmmInvalidUsageException | if hasSeqNum() returns false |
const EmaString& refinitiv::ema::access::AckMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
OmmInvalidUsageException | if hasServiceName() returns false |
const EmaString& refinitiv::ema::access::AckMsg::getText | ( | ) | const |
bool refinitiv::ema::access::AckMsg::hasNackCode | ( | ) | const |
Indicates presence of NackCode.
bool refinitiv::ema::access::AckMsg::hasSeqNum | ( | ) | const |
Indicates presence of SeqNum.
bool refinitiv::ema::access::AckMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
bool refinitiv::ema::access::AckMsg::hasText | ( | ) | const |
Indicates presence of Text.
Specifies Id.
[in] | id | specifies Id |
Specifies NackCode.
[in] | nackCode | a negative acknowledgement code |
Specifies Name.
[in] | name | specifies item name |
AckMsg& refinitiv::ema::access::AckMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
AckMsg& refinitiv::ema::access::AckMsg::payload | ( | const ComplexType & | payload | ) |
AckMsg& refinitiv::ema::access::AckMsg::privateStream | ( | bool | privateStream = false | ) |
Specifies PrivateStream.
[in] | privateStream | specifies if this is a private stream (default is false) |
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 |
Specifies Text.
[in] | text | specifies message text information |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::AckMsg::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 |
![]() |
![]() |
|