Payload conveys the data part of item image. More...
Public Member Functions | |
Accessors | |
DataType::DataTypeEnum | getDataType () const |
More... | |
const ComplexType & | getData () const |
More... | |
const ReqMsg & | getReqMsg () const |
More... | |
const RefreshMsg & | getRefreshMsg () const |
More... | |
const UpdateMsg & | getUpdateMsg () const |
More... | |
const StatusMsg & | getStatusMsg () const |
More... | |
const PostMsg & | getPostMsg () const |
More... | |
const AckMsg & | getAckMsg () const |
More... | |
const GenericMsg & | getGenericMsg () const |
More... | |
const FieldList & | getFieldList () const |
More... | |
const ElementList & | getElementList () const |
More... | |
const Map & | getMap () const |
More... | |
const Vector & | getVector () const |
More... | |
const Series & | getSeries () const |
More... | |
const FilterList & | getFilterList () const |
More... | |
const OmmOpaque & | getOpaque () const |
More... | |
const OmmXml & | getXml () const |
More... | |
const OmmAnsiPage & | getAnsiPage () const |
More... | |
const OmmError & | getError () const |
More... | |
Destructor | |
class | Msg |
virtual | ~Payload () |
More... | |
Payload contains objects of complex type.
The following code snippet shows extracting of Payload and its content while processing UpdateMsg.
class AppClient : public OmmConsumerClient { ...
void onUpdateMsg( const UpdateMsg& , const OmmConsumerEvent& ); };
void AppClient::onUpdateMsg( const UpdateMsg& updateMsg, const OmmConsumerEvent& ) { ...
const Payload& payload = refreshMsg.getPayload();
switch ( payload.getDataType() ) { case DataType::FieldListEnum : decode( payload.getFieldList() ); break; case DataType::MapEnum : decode( payload.getMap() ); break; case DataType::NoDataEnum : break; }
... }
|
virtual |
Destructor.
const AckMsg& refinitiv::ema::access::Payload::getAckMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not AckMsg |
const OmmAnsiPage& refinitiv::ema::access::Payload::getAnsiPage | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not OmmAnsiPage |
const ComplexType& refinitiv::ema::access::Payload::getData | ( | ) | const |
Returns the complex type based on the DataType.
DataType::DataTypeEnum refinitiv::ema::access::Payload::getDataType | ( | ) | const |
Returns the DataType of the contained data.
const ElementList& refinitiv::ema::access::Payload::getElementList | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not ElementList |
const OmmError& refinitiv::ema::access::Payload::getError | ( | ) | const |
Returns Error.
OmmInvalidUsageException | if contained object is not OmmError |
const FieldList& refinitiv::ema::access::Payload::getFieldList | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not FieldList |
const FilterList& refinitiv::ema::access::Payload::getFilterList | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not FilterList |
const GenericMsg& refinitiv::ema::access::Payload::getGenericMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not GenericMsg |
const Map& refinitiv::ema::access::Payload::getMap | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not Map |
const OmmOpaque& refinitiv::ema::access::Payload::getOpaque | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not OmmOpaque |
const PostMsg& refinitiv::ema::access::Payload::getPostMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not PostMsg |
const RefreshMsg& refinitiv::ema::access::Payload::getRefreshMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not RefreshMsg |
const ReqMsg& refinitiv::ema::access::Payload::getReqMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not ReqMsg |
const Series& refinitiv::ema::access::Payload::getSeries | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not Series |
const StatusMsg& refinitiv::ema::access::Payload::getStatusMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not StatusMsg |
const UpdateMsg& refinitiv::ema::access::Payload::getUpdateMsg | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not UpdateMsg |
const Vector& refinitiv::ema::access::Payload::getVector | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not Vector |
const OmmXml& refinitiv::ema::access::Payload::getXml | ( | ) | const |
Returns the current OMM data represented as a specific complex type.
OmmInvalidUsageException | if contained object is not OmmXml |
![]() |
![]() |
|