EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Refinitiv. All rights reserved. --
6  *|-----------------------------------------------------------------------------
7  */
8 
9 #ifndef __thomsonreuters_ema_access_RefreshMsg_h
10 #define __thomsonreuters_ema_access_RefreshMsg_h
11 
68 #include "Access/Include/Msg.h"
70 #include "Access/Include/OmmQos.h"
71 
72 namespace thomsonreuters {
73 
74 namespace ema {
75 
76 namespace access {
77 
79 {
80 public :
81 
83 
84 
86  RefreshMsg();
87 
92  RefreshMsg( const RefreshMsg& other );
94 
96 
97 
99  virtual ~RefreshMsg();
101 
103 
104 
107  DataType::DataTypeEnum getDataType() const;
108 
112  Data::DataCode getCode() const;
113 
117  const EmaBuffer& getAsHex() const;
118 
122  const EmaString& toString() const;
123 
128  bool hasQos() const;
129 
134  bool hasSeqNum() const;
135 
140  bool hasPartNum() const;
141 
146  bool hasPermissionData() const;
147 
152  bool hasPublisherId() const;
153 
158  bool hasServiceName() const;
159 
163  const OmmState& getState() const;
164 
169  const OmmQos& getQos() const;
170 
175  UInt32 getSeqNum() const;
176 
181  UInt16 getPartNum() const;
182 
186  const EmaBuffer& getItemGroup() const;
187 
192  const EmaBuffer& getPermissionData() const;
193 
198  UInt32 getPublisherIdUserId() const;
199 
204  UInt32 getPublisherIdUserAddress() const;
205 
209  bool getSolicited() const;
210 
214  bool getDoNotCache() const;
215 
219  bool getComplete() const;
220 
224  bool getClearCache() const;
225 
229  bool getPrivateStream() const;
230 
235  const EmaString& getServiceName() const;
237 
239 
240 
244  RefreshMsg& clear();
245 
250  RefreshMsg& streamId( Int32 streamId );
251 
257  RefreshMsg& domainType( UInt16 domainType = rdm::MMT_MARKET_PRICE );
258 
263  RefreshMsg& name( const EmaString& name );
264 
269  RefreshMsg& nameType( UInt8 nameType = rdm::INSTRUMENT_NAME_RIC );
270 
276  RefreshMsg& serviceName( const EmaString& serviceName );
277 
283  RefreshMsg& serviceId( UInt32 serviceId );
284 
289  RefreshMsg& id( Int32 id );
290 
295  RefreshMsg& filter( UInt32 filter );
296 
303 
313  UInt8 statusCode = 0,
314  const EmaString& statusText = EmaString() );
315 
320  RefreshMsg& seqNum( UInt32 seqNum );
321 
326  RefreshMsg& partNum( UInt16 partNum );
327 
332  RefreshMsg& itemGroup( const EmaBuffer& itemGroup );
333 
338  RefreshMsg& permissionData( const EmaBuffer& permissionData );
339 
345  RefreshMsg& publisherId( UInt32 userId, UInt32 userAddress );
346 
351  RefreshMsg& attrib( const ComplexType& data );
352 
357  RefreshMsg& payload( const ComplexType& data );
358 
363  RefreshMsg& extendedHeader( const EmaBuffer& buffer );
364 
369  RefreshMsg& solicited( bool solicited = false );
370 
375  RefreshMsg& doNotCache( bool doNotCache = false );
376 
381  RefreshMsg& clearCache( bool clearCache = false );
382 
387  RefreshMsg& complete( bool complete = true );
388 
393  RefreshMsg& privateStream( bool privateStream = false );
395 
396 private :
397 
398  friend class ItemCallbackClient;
399  friend class DictionaryCallbackClient;
400 
401  const EmaString& toString( UInt64 ) const;
402 
403  Decoder& getDecoder();
404 
405  RefreshMsg& operator=( const RefreshMsg& );
406 
407  mutable EmaString _toString;
408 };
409 
410 }
411 
412 }
413 
414 }
415 
416 #endif // __thomsonreuters_ema_access_RefreshMsg_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
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:78
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