OnixS BME SENAF Handler C++ library  2.1.0
API documentation
MarketControlListener.h
Go to the documentation of this file.
1 /*
2  * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
3  *
4  * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
5  * and international copyright treaties.
6  *
7  * Access to and use of the software is governed by the terms of the applicable ONIXS Software
8  * Services Agreement (the Agreement) and Customer end user license agreements granting
9  * a non-assignable, non-transferable and non-exclusive license to use the software
10  * for it's own data processing purposes under the terms defined in the Agreement.
11  *
12  * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
13  * of this source code or associated reference material to any other location for further reproduction
14  * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
15  *
16  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
17  * the terms of the Agreement is a violation of copyright law.
18  */
19 
20 #pragma once
21 
22 #include <OnixS/Senaf/MarketData/Export.h>
40 
41 namespace OnixS { namespace Senaf { namespace MarketData {
42 
43 /// \brief Defines the interface through which the Handler
44 /// notifies subscribers about Market Control Messages.
45 class ONIXS_BME_SENAF_EXPORT MarketControlListener
46 {
47 public:
48  /// Is called once Generic Low Priority (100) Message received.
49  ///
50  /// \param msg Generic Low Priority (100) Message.
51  /// \param msgInfo information about this particular message.
52  virtual void onGenericLowPriorityMessage(const GenericLowPriorityMessage& msg, const MessageInfo& msgInfo) = 0;
53 
54  /// Is called once Generic Medium Priority (101) Message received.
55  ///
56  /// \param msg Generic Medium Priority (101) Message.
57  /// \param msgInfo information about this particular message.
58  virtual void onGenericMediumPriorityMessage(const GenericMediumPriorityMessage& msg, const MessageInfo& msgInfo) = 0;
59 
60  /// Is called once Generic High Priority (102) Message received.
61  ///
62  /// \param msg Generic High Priority (102) Message.
63  /// \param msgInfo information about this particular message.
64  virtual void onGenericHighPriorityMessage(const GenericHighPriorityMessage& msg, const MessageInfo& msgInfo) = 0;
65 
66  /// Is called once Market Request Error (103) Message received.
67  ///
68  /// \param msg Market Request Error (103) Message.
69  /// \param msgInfo information about this particular message.
70  virtual void onMarketRequestError(const MarketRequestError& msg, const MessageInfo& msgInfo) = 0;
71 
72  /// Is called once Terminal Session Start-up Response (104) Message received.
73  ///
74  /// \param msg Terminal Session Start-up Response (104) Message.
75  /// \param msgInfo information about this particular message.
76  virtual void onTerminalSessionStartUpResponse(const TerminalSessionStartUpResponse& msg, const MessageInfo& msgInfo) = 0;
77 
78  /// Is called once General Error (105) Message received.
79  ///
80  /// \param msg General Error (105) Message.
81  /// \param msgInfo information about this particular message.
82  virtual void onGeneralError(const GeneralError& msg, const MessageInfo& msgInfo) = 0;
83 
84  /// Is called once Recovery Start (110) Message received.
85  ///
86  /// \param msg Recovery Start (110) Message.
87  /// \param msgInfo information about this particular message.
88  virtual void onRecoveryStart(const RecoveryStart& msg, const MessageInfo& msgInfo) = 0;
89 
90  /// Is called once Recovery End (111) Message received.
91  ///
92  /// \param msg Recovery End (111) Message.
93  /// \param msgInfo information about this particular message.
94  virtual void onRecoveryEnd(const RecoveryEnd& msg, const MessageInfo& msgInfo) = 0;
95 
96  /// Is called once Market Image Recovery Start (113) Message received.
97  ///
98  /// \param msg Market Image Recovery Start (113) Message.
99  /// \param msgInfo information about this particular message.
100  virtual void onMarketImageRecoveryStart(const MarketImageRecoveryStart& msg, const MessageInfo& msgInfo) = 0;
101 
102  /// Is called once Market Image Recovery End (114) Message received.
103  ///
104  /// \param msg Market Image Recovery End (114) Message.
105  /// \param msgInfo information about this particular message.
106  virtual void onMarketImageRecoveryEnd(const MarketImageRecoveryEnd& msg, const MessageInfo& msgInfo) = 0;
107 
108  /// Is called once System Problems Notification (130) Message received.
109  ///
110  /// \param msg System Problems Notification (130) Message.
111  /// \param msgInfo information about this particular message.
112  virtual void onSystemProblemsNotification(const SystemProblemsNotification& msg, const MessageInfo& msgInfo) = 0;
113 
114  /// Is called once Information Group Start (133) Message received.
115  ///
116  /// \param msg Information Group Start (133) Message.
117  /// \param msgInfo information about this particular message.
118  virtual void onInformationGroupStart(const InformationGroupStart& msg, const MessageInfo& msgInfo) = 0;
119 
120  /// Is called once Information Group End (134) Message received.
121  ///
122  /// \param msg Information Group End (134) Message.
123  /// \param msgInfo information about this particular message.
124  virtual void onInformationGroupEnd(const InformationGroupEnd& msg, const MessageInfo& msgInfo) = 0;
125 
126  /// Is called once Short Recovery Start (146) Message received.
127  ///
128  /// \param msg Short Recovery Start (146) Message.
129  /// \param msgInfo information about this particular message.
130  virtual void onShortRecoveryStart(const ShortRecoveryStart& msg, const MessageInfo& msgInfo) = 0;
131 
132  /// Is called once Short Recovery End (147) Message received.
133  ///
134  /// \param msg Short Recovery End (147) Message.
135  /// \param msgInfo information about this particular message.
136  virtual void onShortRecoveryEnd(const ShortRecoveryEnd& msg, const MessageInfo& msgInfo) = 0;
137 
138  /// Is called once Gap Fill (160) Message received.
139  ///
140  /// \param msg Gap Fill (160) Message.
141  /// \param msgInfo information about this particular message.
142  virtual void onGapFill(const GapFill& msg, const MessageInfo& msgInfo) = 0;
143 
144 protected:
146 };
147 
148 }}}
Defines the interface through which the Handler notifies subscribers about Market Control Messages...