EMA C++ Edition
StatusMsg.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_StatusMsg_h
10#define __refinitiv_ema_access_StatusMsg_h
11
70#include "Access/Include/Msg.h"
72#include "DataDictionary.h"
73
74namespace refinitiv {
75
76namespace ema {
77
78namespace access {
79
81{
82public :
83
85
86
89
94 StatusMsg( const StatusMsg& other );
96
98
99
101 virtual ~StatusMsg();
103
105
106
110
115
119 const EmaBuffer& getAsHex() const;
120
124 const EmaString& toString() const;
125
130 const EmaString& toString( const refinitiv::ema::rdm::DataDictionary& dictionary ) const;
131
136 bool hasItemGroup() const;
137
142 bool hasState() const;
143
148 bool hasPermissionData() const;
149
154 bool hasPublisherId() const;
155
160 bool hasServiceName() const;
161
166 const OmmState& getState() const;
167
172 const EmaBuffer& getItemGroup() const;
173
179
185
191
195 bool getClearCache() const;
196
200 bool getPrivateStream() const;
201
205 const EmaString& getServiceName() const;
207
209
210
215
221
228
233 StatusMsg& name( const EmaString& name );
234
240
246 StatusMsg& serviceName( const EmaString& serviceName );
247
254
260
266
276 UInt8 statusCode = OmmState::NoneEnum,
277 const EmaString& statusText = EmaString() );
278
283 StatusMsg& itemGroup( const EmaBuffer& itemGroup );
284
289 StatusMsg& permissionData( const EmaBuffer& permissionData );
290
296 StatusMsg& publisherId( UInt32 userId, UInt32 userAddress );
297
302 StatusMsg& attrib( const ComplexType& data );
303
309
315
320 StatusMsg& clearCache( bool clearCache = false );
321
326 StatusMsg& privateStream( bool privateStream = false );
328
329private :
330
331 friend class ItemCallbackClient;
332 friend class DictionaryCallbackClient;
333
334 const EmaString& toString( UInt64 ) const;
335
336 Decoder& getDecoder();
337
338 StatusMsg& operator=( const StatusMsg& );
339
340 mutable EmaString _toString;
341};
342
343}
344
345}
346
347}
348
349#endif // __refinitiv_ema_access_StatusMsg_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
StatusMsg conveys item state information.
Definition: StatusMsg.h:81
StatusMsg & serviceName(const EmaString &serviceName)
const EmaBuffer & getAsHex() const
StatusMsg & serviceId(UInt32 serviceId)
StatusMsg & domainType(UInt16 domainType=refinitiv::ema::rdm::MMT_MARKET_PRICE)
const EmaString & toString(const refinitiv::ema::rdm::DataDictionary &dictionary) const
StatusMsg & filter(UInt32 filter)
StatusMsg & streamId(Int32 streamId)
Data::DataCode getCode() const
const EmaBuffer & getPermissionData() const
StatusMsg & extendedHeader(const EmaBuffer &buffer)
UInt32 getPublisherIdUserAddress() const
const EmaString & getServiceName() const
StatusMsg & name(const EmaString &name)
StatusMsg & attrib(const ComplexType &data)
StatusMsg & privateStream(bool privateStream=false)
const EmaString & toString() const
const OmmState & getState() const
StatusMsg & payload(const ComplexType &data)
DataType::DataTypeEnum getDataType() const
StatusMsg & nameType(UInt8 nameType=rdm::INSTRUMENT_NAME_RIC)
StatusMsg & state(OmmState::StreamState streamState=OmmState::OpenEnum, OmmState::DataState dataState=OmmState::OkEnum, UInt8 statusCode=OmmState::NoneEnum, const EmaString &statusText=EmaString())
StatusMsg(const StatusMsg &other)
const EmaBuffer & getItemGroup() const
StatusMsg & permissionData(const EmaBuffer &permissionData)
StatusMsg & publisherId(UInt32 userId, UInt32 userAddress)
StatusMsg & clearCache(bool clearCache=false)
StatusMsg & itemGroup(const EmaBuffer &itemGroup)