OnixS C++ Eurex T7 Market and Reference Data Interface (EMDI, RDI, EOBI) Handlers  7.4.3
API documentation
ErrorListener.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 Eurex
29  {
30  namespace MarketData
31  {
32  /// Known (selected) error codes.
33  struct ONIXS_EUREX_EMDI_API ErrorCode
34  {
35  /// @copydoc ErrorCode
36  enum Enum
37  {
38  General = 1, ///< Identifiers errors of generic nature.
39  };
40  };
41 
42  /// Returns string representation of ErrorCode value.
43  ONIXS_EUREX_EMDI_API std::string enumToString (ErrorCode::Enum);
44 
45  /// Defines an interface through which the Handler notifies subscribers
46  /// about errors occurred while processing messages.
48  {
49  public:
50  /// Implement this member to get notified about errors.
51  /// @param code identifies error occurred while processing messages.
52  /// @param description supplies notes on occurred error.
53  /// @note Usually, Handler is capable to recover from errors by itself.
54  /// That means, there's no need to restart manually.
55  /// Instead, Handler will perform all necessary recovering by itself.
56  virtual void onError (ErrorCode::Enum code, const std::string& description) = 0;
57 
58  protected:
59  /// Class provides an interface for handling errors in subscriptions.
60  /// It doesn't provide an interface for instance deletion. However,
61  /// since C++ doesn't have pure interface concept, destructor will be
62  /// generated anyway. We can only control proper use of it. For this
63  /// reason we hide from public use and make it available for descendants.
64  virtual ~ErrorListener() {}
65  };
66 
67  }
68  }
69 }
70 
ONIXS_EUREX_EMDI_API std::string enumToString(HandlerState::Enum)
Returns string representation of HandlerState value.
Known (selected) error codes.
Definition: ErrorListener.h:33
Definition: Defines.h:30
Enum
Known (selected) error codes.
Definition: ErrorListener.h:36