EMA C++ Edition
Payload.h
Go to the documentation of this file.
1/*|-----------------------------------------------------------------------------
2 *| This source code is provided under the Apache 2.0 license
3 *| and is provided AS IS with no warranty or guarantee of fit for purpose.
4 *| See the project's LICENSE.md for details.
5 *| Copyright (C) 2019 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_Payload_h
10#define __refinitiv_ema_access_Payload_h
11
76
77namespace refinitiv {
78
79namespace ema {
80
81namespace access {
82
83class ReqMsg;
84class RefreshMsg;
85class UpdateMsg;
86class StatusMsg;
87class GenericMsg;
88class PostMsg;
89class AckMsg;
90class FieldList;
91class ElementList;
92class Map;
93class Vector;
94class Series;
95class FilterList;
96class OmmOpaque;
97class OmmXml;
98class OmmAnsiPage;
99class OmmError;
100
101class MsgDecoder;
102
104{
105public :
106
108
109
115
119 const ComplexType& getData() const;
120
125 const ReqMsg& getReqMsg() const;
126
131 const RefreshMsg& getRefreshMsg() const;
132
137 const UpdateMsg& getUpdateMsg() const;
138
143 const StatusMsg& getStatusMsg() const;
144
149 const PostMsg& getPostMsg() const;
150
155 const AckMsg& getAckMsg() const;
156
161 const GenericMsg& getGenericMsg() const;
162
167 const FieldList& getFieldList() const;
168
174
179 const Map& getMap() const;
180
185 const Vector& getVector() const;
186
191 const Series& getSeries() const;
192
197 const FilterList& getFilterList() const;
198
203 const OmmOpaque& getOpaque() const;
204
209 const OmmXml& getXml() const;
210
215 const OmmAnsiPage& getAnsiPage() const;
216
221 const OmmError& getError() const;
223
225
226
228 virtual ~Payload();
230
231private :
232
233 friend class Msg;
234
235 const Data* _pPayload;
236
237 Payload();
238 Payload( const Payload& );
239 Payload& operator=( const Payload& );
240};
241
242}
243
244}
245
246}
247
248#endif // __refinitiv_ema_access_Payload_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:69
ComplexType class is a parent class from whom all complex data types inherit.
Definition: ComplexType.h:34
Data class is a parent abstract class defining common interfaces for all Data type classes.
Definition: Data.h:39
ElementList is a heterogeneous container of complex and primitive data type entries.
Definition: ElementList.h:178
FieldList is a heterogeneous container of complex and primitive data type entries.
Definition: FieldList.h:180
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:134
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:88
Map is a homogeneous container of complex data type entries.
Definition: Map.h:126
Msg class is a parent class for all message representing classes.
Definition: Msg.h:46
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:73
OmmError represents received Omm data who fails to process properly.
Definition: OmmError.h:63
OmmOpaque represents Opaque data format in Omm.
Definition: OmmOpaque.h:73
OmmXml represents XML data format in Omm.
Definition: OmmXml.h:73
Payload conveys the data part of item image.
Definition: Payload.h:104
const PostMsg & getPostMsg() const
const UpdateMsg & getUpdateMsg() const
const GenericMsg & getGenericMsg() const
const Series & getSeries() const
DataType::DataTypeEnum getDataType() const
const OmmOpaque & getOpaque() const
const StatusMsg & getStatusMsg() const
const ElementList & getElementList() const
const RefreshMsg & getRefreshMsg() const
const FilterList & getFilterList() const
const OmmError & getError() const
const ComplexType & getData() const
const OmmXml & getXml() const
const FieldList & getFieldList() const
const AckMsg & getAckMsg() const
const Vector & getVector() const
const Map & getMap() const
const ReqMsg & getReqMsg() const
const OmmAnsiPage & getAnsiPage() const
PostMsg allows consumer applications to contribute content.
Definition: PostMsg.h:63
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:80
ReqMsg allows consumer application to express its interest in an item.
Definition: ReqMsg.h:60
Series is a homogeneous container of complex data type entries.
Definition: Series.h:130
StatusMsg conveys item state information.
Definition: StatusMsg.h:81
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:73
Vector is a homogeneous container of complex data type entries.
Definition: Vector.h:123