PostMsg allows consumer applications to contribute content. More...
Public Types | |
enum | PostUserRights { CreateEnum = 0x01 , DeleteEnum = 0x02 , ModifyPermissionEnum = 0x04 } |
![]() | |
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 |
PostMsg may be submitted on any market item stream or login stream. Submission on a market item stream is referred to as the "on stream posting" while submission on a login stream is considered as the "off stream posting". On stream posting content is related to the item on whose stream the posting happens, while the off stream posting may contain info about any item.
PostMsg may be submitted using OmmConsumer::submit( const PostMsg& , UInt64 ).
The following code snippet shows setting and submission of an on stream PostMsg.
refinitiv::ema::access::PostMsg::PostMsg | ( | ) |
Constructs PostMsg.
refinitiv::ema::access::PostMsg::PostMsg | ( | const PostMsg & | other | ) |
|
virtual |
Destructor.
PostMsg& refinitiv::ema::access::PostMsg::attrib | ( | const ComplexType & | data | ) |
PostMsg& refinitiv::ema::access::PostMsg::clear | ( | ) |
PostMsg& refinitiv::ema::access::PostMsg::complete | ( | bool | complete = true | ) |
Specifies Complete.
[in] | complete | specifies if this is the last part of the multi part post message |
PostMsg& refinitiv::ema::access::PostMsg::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::PostMsg::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.
UInt16 refinitiv::ema::access::PostMsg::getPartNum | ( | ) | const |
Returns PartNum.
OmmInvalidUsageException | if hasPartNum() returns false |
const EmaBuffer& refinitiv::ema::access::PostMsg::getPermissionData | ( | ) | const |
Returns PermissionData.
OmmInvalidUsageException | if hasPermissionData() returns false |
UInt32 refinitiv::ema::access::PostMsg::getPostId | ( | ) | const |
UInt16 refinitiv::ema::access::PostMsg::getPostUserRights | ( | ) | const |
Returns PostUserRights.
OmmInvalidUsageException | if hasPostUserRights() returns false |
const EmaString& refinitiv::ema::access::PostMsg::getPostUserRightsAsString | ( | ) | const |
Returns the PostUserRights value as a string format.
UInt32 refinitiv::ema::access::PostMsg::getPublisherIdUserAddress | ( | ) | const |
Returns PublisherIdUserAddress.
UInt32 refinitiv::ema::access::PostMsg::getPublisherIdUserId | ( | ) | const |
Returns PublisherIdUserId.
UInt32 refinitiv::ema::access::PostMsg::getSeqNum | ( | ) | const |
Returns SeqNum.
OmmInvalidUsageException | if hasSeqNum() returns false |
const EmaString& refinitiv::ema::access::PostMsg::getServiceName | ( | ) | const |
Returns the ServiceName within the MsgKey.
OmmInvalidUsageException | if hasServiceName() returns false |
bool refinitiv::ema::access::PostMsg::getSolicitAck | ( | ) | const |
Indicates that acknowledgement is requested.
bool refinitiv::ema::access::PostMsg::hasPartNum | ( | ) | const |
Indicates presence of PartNum.
bool refinitiv::ema::access::PostMsg::hasPermissionData | ( | ) | const |
Indicates presence of PermissionData.
bool refinitiv::ema::access::PostMsg::hasPostId | ( | ) | const |
Indicates presence of the PostId.
bool refinitiv::ema::access::PostMsg::hasPostUserRights | ( | ) | const |
Indicates presence of PostUserRights.
bool refinitiv::ema::access::PostMsg::hasSeqNum | ( | ) | const |
Indicates presence of SeqNum.
bool refinitiv::ema::access::PostMsg::hasServiceName | ( | ) | const |
Indicates presence of the ServiceName within the MsgKey.
Specifies Id.
[in] | id | specifies Id |
Specifies Name.
[in] | name | specifies item name |
PostMsg& refinitiv::ema::access::PostMsg::nameType | ( | UInt8 | nameType = rdm::INSTRUMENT_NAME_RIC | ) |
Specifies NameType.
[in] | nameType | specifies RDM Instrument NameType (default value is rdm::INSTRUMENT_NAME_RIC) |
Specifies PartNum.
[in] | partNum | specifies part number |
PostMsg& refinitiv::ema::access::PostMsg::payload | ( | const ComplexType & | data | ) |
Specifies PermissionData.
[in] | permissionData | an EmaBuffer object with permission data information |
Specifies PostId.
[in] | postId | specifies post id |
Specifies PostUserRights.
[in] | postUserRights | specifies post user rights |
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 |
PostMsg& refinitiv::ema::access::PostMsg::solicitAck | ( | bool | ack = false | ) |
Specifies acknowledgement.
[in] | ack | specifies if an acknowledgement is requested (default value is false) |
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::PostMsg::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 |
![]() |
![]() |
|