EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Refinitiv. All rights reserved. --
6  *|-----------------------------------------------------------------------------
7  */
8 
9 #ifndef __thomsonreuters_ema_access_StatusMsg_h
10 #define __thomsonreuters_ema_access_StatusMsg_h
11 
70 #include "Access/Include/Msg.h"
72 
73 namespace thomsonreuters {
74 
75 namespace ema {
76 
77 namespace access {
78 
80 {
81 public :
82 
84 
85 
87  StatusMsg();
88 
93  StatusMsg( const StatusMsg& other );
95 
97 
98 
100  virtual ~StatusMsg();
102 
104 
105 
108  DataType::DataTypeEnum getDataType() const;
109 
113  Data::DataCode getCode() const;
114 
118  const EmaBuffer& getAsHex() const;
119 
123  const EmaString& toString() const;
124 
129  bool hasItemGroup() const;
130 
135  bool hasState() const;
136 
141  bool hasPermissionData() const;
142 
147  bool hasPublisherId() const;
148 
153  bool hasServiceName() const;
154 
159  const OmmState& getState() const;
160 
165  const EmaBuffer& getItemGroup() const;
166 
171  const EmaBuffer& getPermissionData() const;
172 
177  UInt32 getPublisherIdUserId() const;
178 
183  UInt32 getPublisherIdUserAddress() const;
184 
188  bool getClearCache() const;
189 
193  bool getPrivateStream() const;
194 
198  const EmaString& getServiceName() const;
200 
202 
203 
207  StatusMsg& clear();
208 
213  StatusMsg& streamId( Int32 streamId );
214 
220  StatusMsg& domainType( UInt16 domainType = thomsonreuters::ema::rdm::MMT_MARKET_PRICE );
221 
226  StatusMsg& name( const EmaString& name );
227 
232  StatusMsg& nameType( UInt8 nameType = rdm::INSTRUMENT_NAME_RIC );
233 
239  StatusMsg& serviceName( const EmaString& serviceName );
240 
246  StatusMsg& serviceId( UInt32 serviceId );
247 
252  StatusMsg& id( Int32 id );
253 
258  StatusMsg& filter( UInt32 filter );
259 
267  StatusMsg& state( OmmState::StreamState streamState = OmmState::OpenEnum,
269  UInt8 statusCode = OmmState::NoneEnum,
270  const EmaString& statusText = EmaString() );
271 
276  StatusMsg& itemGroup( const EmaBuffer& itemGroup );
277 
282  StatusMsg& permissionData( const EmaBuffer& permissionData );
283 
289  StatusMsg& publisherId( UInt32 userId, UInt32 userAddress );
290 
295  StatusMsg& attrib( const ComplexType& data );
296 
301  StatusMsg& payload( const ComplexType& data );
302 
307  StatusMsg& extendedHeader( const EmaBuffer& buffer );
308 
313  StatusMsg& clearCache( bool clearCache = false );
314 
319  StatusMsg& privateStream( bool privateStream = false );
321 
322 private :
323 
324  friend class ItemCallbackClient;
325  friend class DictionaryCallbackClient;
326 
327  const EmaString& toString( UInt64 ) const;
328 
329  Decoder& getDecoder();
330 
331  StatusMsg& operator=( const StatusMsg& );
332 
333  mutable EmaString _toString;
334 };
335 
336 }
337 
338 }
339 
340 }
341 
342 #endif // __thomsonreuters_ema_access_StatusMsg_h
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
Msg class is a parent class for all message representing classes.
Definition: Msg.h:45
unsigned int UInt32
represents 32-bit unsigned integer
Definition: Common.h:56
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:56
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:32
#define EMA_ACCESS_API
Definition: Common.h:95
ComplexType class is a parent class from whom all complex data types inherit.
Definition: ComplexType.h:33
int Int32
represents 32-bit signed integer
Definition: Common.h:62
StatusMsg conveys item state information.
Definition: StatusMsg.h:79
static const thomsonreuters::ema::access::UInt8 INSTRUMENT_NAME_RIC
Definition: EmaRdm.h:197
OmmState represents State information in Omm.
Definition: OmmState.h:50
static const thomsonreuters::ema::access::UInt8 MMT_MARKET_PRICE
Definition: EmaRdm.h:50
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32