OnixS C++ Tradeweb Approved Publication Arrangement (APA) Handler  1.2.2.18
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 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 
23 
24 #include <string>
25 
26 namespace OnixS
27 {
28  namespace Tradeweb
29  {
30  namespace MarketData
31  {
32  namespace Apa
33  {
34  /// Defines the state that the handler is in.
35  struct HandlerState
36  {
37  /// @copydoc HandlerState
38  enum Enum
39  {
40  Stopped, ///< Stopped.
41  Stopping, ///< The intermediate state when the Handler is not Stopped but not Started.
42  Started, ///< Started.
43  Starting, ///< The intermediate state when the Handler is not Started but not Stopped.
44  };
45  };
46 
47  /// Returns string representation of HandlerState value.
48  ONIXS_TRADEWEB_APA_API std::string enumToString (HandlerState::Enum);
49 
50  /// Status Listener.
52  {
53  public:
54  /// Implement this member to get notifications about handler state change.
55  virtual void onStateChanged (HandlerState::Enum newState) = 0;
56 
57  protected:
58  /// Disables public <b>delete</b> operator in the interface class.
59  virtual ~HandlerStateListener () {}
60  };
61  }
62  }
63  }
64 }
65 
66 
67 
The intermediate state when the Handler is not Stopped but not Started.
ONIXS_TRADEWEB_APA_API std::string enumToString(ErrorCode::Enum)
Returns string representation of ErrorCode value.
The intermediate state when the Handler is not Started but not Stopped.
Enum
Defines the state that the handler is in.
virtual ~HandlerStateListener()
Disables public delete operator in the interface class.
Defines the state that the handler is in.