OnixS C++ Tullett Prebon SURF Handler  1.6.1
API documentation
HandlerStateListener.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
13  * part of this source code or associated reference material to any other location for further
14  * reproduction or redistribution, and any amendments to this copyright notice, are expressly
15  * prohibited.
16  *
17  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
18  * the terms of the Agreement is a violation of copyright law.
19  */
20 
21 #pragma once
22 
23 #include <OnixS/SURF/MarketData/Export.h>
24 
25 #include <string>
26 
27 namespace OnixS { namespace SURF { namespace MarketData {
28 
29 /// Defines the state that the handler is in.
31 {
32  /// \copydoc HandlerState
33  enum Enum
34  {
35  Disconnected, ///< Disconnected.
36  Disconnecting, ///< Disconnecting.
37  Connected, ///< Connected.
38  Connecting, ///< Connecting.
39  };
40 };
41 
42 /// Returns string representation of HandlerState value.
43 ONIXS_TP_SURF_EXPORT std::string enumToString(HandlerState::Enum);
44 
45 /// Defines an interface through which the Handler notifies subscribers
46 /// about state change events occurred in runtime.
48 {
49 public:
50  /// Implement this member to get notifications about handler state change.
51  ///
52  /// \param newState new Handler's state.
53  virtual void onStateChanged(HandlerState::Enum newState) = 0;
54 
55 protected:
56  /// Class provides an interface for handling Handler's state change events.
57  /// It doesn't provide an interface for instance deletion. However,
58  /// since C++ doesn't have pure interface concept, destructor will be
59  /// generated anyway. We can only control proper use of it. For this
60  /// reason we hide from public use and make it available for descendants.
61  virtual ~HandlerStateListener() {}
62 };
63 
64 }}} // namespace OnixS::SURF::MarketData
Defines the state that the handler is in.
Definition: Decimal.h:28
Enum
Defines the state that the handler is in.
std::string enumToString(RecordType::Enum)
Returns string representation.