EMA C++ Edition
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 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_OmmConsumerClient_h
10#define __refinitiv_ema_access_OmmConsumerClient_h
11
69
70namespace refinitiv {
71
72namespace ema {
73
74namespace access {
75
76class OmmConsumerEvent;
77class Msg;
78class RefreshMsg;
79class UpdateMsg;
80class StatusMsg;
81class GenericMsg;
82class AckMsg;
83
85{
86public :
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
138protected :
139
142
143private :
144
146 OmmConsumerClient& operator=( const OmmConsumerClient& );
147};
148
149}
150
151}
152
153}
154
155#endif // __refinitiv_ema_access_OmmConsumerClient_h
Common.h file provides definitions of common variable types used in EMA.
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:69
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:88
Msg class is a parent class for all message representing classes.
Definition: Msg.h:46
OmmConsumerClient class provides callback interfaces to pass received messages.
virtual void onRefreshMsg(const RefreshMsg &refreshMsg, const OmmConsumerEvent &consumerEvent)
virtual void onAckMsg(const AckMsg &ackMsg, const OmmConsumerEvent &consumerEvent)
virtual void onStatusMsg(const StatusMsg &statusMsg, const OmmConsumerEvent &consumerEvent)
virtual void onGenericMsg(const GenericMsg &genericMsg, const OmmConsumerEvent &consumerEvent)
virtual void onUpdateMsg(const UpdateMsg &updateMsg, const OmmConsumerEvent &consumerEvent)
virtual void onAllMsg(const Msg &msg, const OmmConsumerEvent &consumerEvent)
OmmConsumerEvent encapsulates item identifiers.
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:80
StatusMsg conveys item state information.
Definition: StatusMsg.h:81
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:73