EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OmmConsumerClient.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_OmmConsumerClient_h
10 #define __thomsonreuters_ema_access_OmmConsumerClient_h
11 
68 #include "Access/Include/Common.h"
69 
70 namespace thomsonreuters {
71 
72 namespace ema {
73 
74 namespace access {
75 
76 class OmmConsumerEvent;
77 class Msg;
78 class RefreshMsg;
79 class UpdateMsg;
80 class StatusMsg;
81 class GenericMsg;
82 class AckMsg;
83 
85 {
86 public :
87 
89 
90 
96  virtual void onRefreshMsg( const RefreshMsg& refreshMsg, const OmmConsumerEvent& consumerEvent );
97 
104  virtual void onUpdateMsg( const UpdateMsg& updateMsg, const OmmConsumerEvent& consumerEvent );
105 
111  virtual void onStatusMsg( const StatusMsg& statusMsg, const OmmConsumerEvent& consumerEvent );
112 
119  virtual void onGenericMsg( const GenericMsg& genericMsg, const OmmConsumerEvent& consumerEvent );
120 
127  virtual void onAckMsg( const AckMsg& ackMsg, const OmmConsumerEvent& consumerEvent );
128 
135  virtual void onAllMsg( const Msg& msg, const OmmConsumerEvent& consumerEvent );
137 
138 protected :
139 
141  virtual ~OmmConsumerClient();
142 
143 private :
144 
146  OmmConsumerClient& operator=( const OmmConsumerClient& );
147 };
148 
149 }
150 
151 }
152 
153 }
154 
155 #endif // __thomsonreuters_ema_access_OmmConsumerClient_h
OmmConsumerClient class provides callback interfaces to pass received messages.
Msg class is a parent class for all message representing classes.
Definition: Msg.h:45
#define EMA_ACCESS_API
Definition: Common.h:95
StatusMsg conveys item state information.
Definition: StatusMsg.h:79
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:78
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:86
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:71
Common.h file provides definitions of common variable types used in EMA.
OmmConsumerEvent encapsulates item identifiers.
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:67