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