EMA C++ Edition
UpdateMsg.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, 2024 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_UpdateMsg_h
10#define __refinitiv_ema_access_UpdateMsg_h
11
63#include "Access/Include/Msg.h"
64#include "DataDictionary.h"
65
66namespace refinitiv {
67
68namespace ema {
69
70namespace access {
71
73{
74public :
75
77
78
81
86 UpdateMsg( const UpdateMsg& other );
88
90
91
93 virtual ~UpdateMsg();
95
97
98
102
107
111 const EmaBuffer& getAsHex() const;
112
116 const EmaString& toString() const;
117
122 const EmaString& toString( const refinitiv::ema::rdm::DataDictionary& dictionary ) const;
123
128 bool hasSeqNum() const;
129
134 bool hasPermissionData() const;
135
139 bool hasConflated() const;
140
145 bool hasPublisherId() const;
146
151 bool hasServiceName() const;
152
157
163
169
175
181
187
193
197 bool getDoNotCache() const;
198
202 bool getDoNotConflate() const;
203
207 bool getDoNotRipple() const;
208
213 const EmaString& getServiceName() const;
215
217
218
223
229
236
241 UpdateMsg& name( const EmaString& name );
242
248
254 UpdateMsg& serviceName( const EmaString& serviceName );
255
262
268
274
278 UpdateMsg& updateTypeNum( UInt8 updateTypeNum );
279
285
290 UpdateMsg& permissionData( const EmaBuffer& permissionData );
291
297 UpdateMsg& conflated( UInt16 count = 0, UInt16 time = 0 );
298
304 UpdateMsg& publisherId( UInt32 userId, UInt32 userAddress );
305
310 UpdateMsg& attrib( const ComplexType& data );
311
317
323
328 UpdateMsg& doNotCache( bool doNotCache = false );
329
334 UpdateMsg& doNotConflate( bool doNotConflate = false );
335
340 UpdateMsg& doNotRipple( bool doNotRipple = false );
342
343private :
344
345 friend class ItemCallbackClient;
346
347 const EmaString& toString( UInt64 ) const;
348
349 Decoder& getDecoder();
350
351 UpdateMsg& operator=( const UpdateMsg& );
352
353 mutable EmaString _toString;
354};
355
356}
357
358}
359
360}
361
362#endif // __refinitiv_ema_access_UpdateMsg_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
int Int32
represents 32-bit signed integer
Definition: Common.h:62
unsigned int UInt32
represents 32-bit unsigned integer
Definition: Common.h:56
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32
unsigned short UInt16
represents 16-bit unsigned integer
Definition: Common.h:44
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
static const refinitiv::ema::access::UInt8 MMT_MARKET_PRICE
Definition: EmaRdm.h:50
static const refinitiv::ema::access::UInt8 INSTRUMENT_NAME_RIC
Definition: EmaRdm.h:197
The ema namespace contains all interfaces and definitions specified for use with EMA.
ComplexType class is a parent class from whom all complex data types inherit.
Definition: ComplexType.h:34
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:33
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:57
Msg class is a parent class for all message representing classes.
Definition: Msg.h:46
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:73
const EmaString & toString(const refinitiv::ema::rdm::DataDictionary &dictionary) const
UpdateMsg & conflated(UInt16 count=0, UInt16 time=0)
Data::DataCode getCode() const
UpdateMsg & nameType(UInt8 nameType=rdm::INSTRUMENT_NAME_RIC)
UpdateMsg & streamId(Int32 streamId)
UpdateMsg & doNotConflate(bool doNotConflate=false)
UpdateMsg & serviceName(const EmaString &serviceName)
const EmaString & getServiceName() const
const EmaBuffer & getAsHex() const
const EmaString & toString() const
UpdateMsg & extendedHeader(const EmaBuffer &buffer)
UpdateMsg(const UpdateMsg &other)
const EmaBuffer & getPermissionData() const
UpdateMsg & payload(const ComplexType &data)
UpdateMsg & serviceId(UInt32 serviceId)
UpdateMsg & domainType(UInt16 domainType=rdm::MMT_MARKET_PRICE)
UpdateMsg & filter(UInt32 filter)
UpdateMsg & permissionData(const EmaBuffer &permissionData)
UpdateMsg & name(const EmaString &name)
UpdateMsg & doNotRipple(bool doNotRipple=false)
UInt32 getPublisherIdUserAddress() const
DataType::DataTypeEnum getDataType() const
UpdateMsg & seqNum(UInt32 seqNum)
UpdateMsg & publisherId(UInt32 userId, UInt32 userAddress)
UpdateMsg & attrib(const ComplexType &data)
UpdateMsg & doNotCache(bool doNotCache=false)
UpdateMsg & updateTypeNum(UInt8 updateTypeNum)