EMA C++ Edition
RefreshMsg.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_RefreshMsg_h
10#define __refinitiv_ema_access_RefreshMsg_h
11
68#include "Access/Include/Msg.h"
71#include "DataDictionary.h"
72
73namespace refinitiv {
74
75namespace ema {
76
77namespace access {
78
80{
81public :
82
84
85
88
93 RefreshMsg( const RefreshMsg& other );
95
97
98
100 virtual ~RefreshMsg();
102
104
105
109
114
118 const EmaBuffer& getAsHex() const;
119
123 const EmaString& toString() const;
124
129 const EmaString& toString( const refinitiv::ema::rdm::DataDictionary& dictionary ) const;
130
135 bool hasQos() const;
136
141 bool hasSeqNum() const;
142
147 bool hasPartNum() const;
148
153 bool hasPermissionData() const;
154
159 bool hasPublisherId() const;
160
165 bool hasServiceName() const;
166
170 const OmmState& getState() const;
171
176 const OmmQos& getQos() const;
177
183
189
193 const EmaBuffer& getItemGroup() const;
194
200
206
212
216 bool getSolicited() const;
217
221 bool getDoNotCache() const;
222
226 bool getComplete() const;
227
231 bool getClearCache() const;
232
236 bool getPrivateStream() const;
237
242 const EmaString& getServiceName() const;
244
246
247
252
258
265
270 RefreshMsg& name( const EmaString& name );
271
277
283 RefreshMsg& serviceName( const EmaString& serviceName );
284
291
297
303
310
320 UInt8 statusCode = 0,
321 const EmaString& statusText = EmaString() );
322
328
334
339 RefreshMsg& itemGroup( const EmaBuffer& itemGroup );
340
345 RefreshMsg& permissionData( const EmaBuffer& permissionData );
346
352 RefreshMsg& publisherId( UInt32 userId, UInt32 userAddress );
353
359
365
371
376 RefreshMsg& solicited( bool solicited = false );
377
382 RefreshMsg& doNotCache( bool doNotCache = false );
383
388 RefreshMsg& clearCache( bool clearCache = false );
389
394 RefreshMsg& complete( bool complete = true );
395
400 RefreshMsg& privateStream( bool privateStream = false );
402
403private :
404
405 friend class ItemCallbackClient;
406 friend class DictionaryCallbackClient;
407
408 const EmaString& toString( UInt64 ) const;
409
410 Decoder& getDecoder();
411
412 RefreshMsg& operator=( const RefreshMsg& );
413
414 mutable EmaString _toString;
415};
416
417}
418
419}
420
421}
422
423#endif // __refinitiv_ema_access_RefreshMsg_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
OmmState represents State information in Omm.
Definition: OmmState.h:51
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:80
RefreshMsg & state(OmmState::StreamState streamState=OmmState::OpenEnum, OmmState::DataState dataState=OmmState::OkEnum, UInt8 statusCode=0, const EmaString &statusText=EmaString())
Data::DataCode getCode() const
const OmmState & getState() const
RefreshMsg & seqNum(UInt32 seqNum)
RefreshMsg(const RefreshMsg &other)
const EmaString & toString(const refinitiv::ema::rdm::DataDictionary &dictionary) const
RefreshMsg & filter(UInt32 filter)
RefreshMsg & streamId(Int32 streamId)
const EmaBuffer & getAsHex() const
RefreshMsg & clearCache(bool clearCache=false)
RefreshMsg & domainType(UInt16 domainType=rdm::MMT_MARKET_PRICE)
RefreshMsg & solicited(bool solicited=false)
RefreshMsg & privateStream(bool privateStream=false)
RefreshMsg & complete(bool complete=true)
RefreshMsg & nameType(UInt8 nameType=rdm::INSTRUMENT_NAME_RIC)
const EmaBuffer & getPermissionData() const
RefreshMsg & itemGroup(const EmaBuffer &itemGroup)
RefreshMsg & attrib(const ComplexType &data)
RefreshMsg & publisherId(UInt32 userId, UInt32 userAddress)
RefreshMsg & qos(UInt32 timeliness=OmmQos::RealTimeEnum, UInt32 rate=OmmQos::TickByTickEnum)
RefreshMsg & serviceName(const EmaString &serviceName)
RefreshMsg & name(const EmaString &name)
RefreshMsg & permissionData(const EmaBuffer &permissionData)
RefreshMsg & partNum(UInt16 partNum)
const EmaBuffer & getItemGroup() const
RefreshMsg & payload(const ComplexType &data)
RefreshMsg & extendedHeader(const EmaBuffer &buffer)
const EmaString & toString() const
RefreshMsg & serviceId(UInt32 serviceId)
const EmaString & getServiceName() const
RefreshMsg & doNotCache(bool doNotCache=false)
const OmmQos & getQos() const
DataType::DataTypeEnum getDataType() const