OnixS C++ MTS Cash SDP Handler  1.6.5
API documentation
ErrorListener.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
4 *
5 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
6 * and international copyright treaties.
7 *
8 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
9 * Services Agreement (the Agreement) and Customer end user license agreements granting
10 * a non-assignable, non-transferable and non-exclusive license to use the software
11 * for it's own data processing purposes under the terms defined in the Agreement.
12 *
13 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
14 * of this source code or associated reference material to any other location for further reproduction
15 * or redistribution, and any amendments to this copyright notice, are expressly 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 #include "OnixS/MTS/Cash/SDP/ABI.h"
22 
23 namespace OnixS {
24 namespace Mts {
25 namespace Cash {
26 namespace SDP {
27 /// Known (selected) error codes.
28 ///
29 struct ONIXS_MTS_CASH_SDP_API ErrorCode
30 {
31  /// @copydoc ErrorCode
32  ///
33  enum Enum
34  {
35  General = 1, ///< Identifies errors of generic nature.
36  };
37 };
38 
39 /// Returns string representation of ErrorCode value.
40 ///
41 ONIXS_MTS_CASH_SDP_API std::string enumToString (ErrorCode::Enum);
42 
43 /// Defines an interface through which the Handler notifies subscribers
44 /// about errors occurred while processing messages.
46 {
47 public:
48  /// Implement this member to get notified about errors.
49  /// @param code identifies error occurred while processing messages.
50  /// @param description supplies notes on occurred error.
51  /// @note Usually, Handler is capable to recover from errors by itself.
52  /// That means, there's no need to restart manually.
53  /// Instead, Handler will perform all necessary recovering by itself.
54  virtual void onError (ErrorCode::Enum code, const std::string& description) = 0;
55 
56 protected:
57  /// Class provides an interface for handling errors in subscriptions.
58  /// It doesn't provide an interface for instance deletion. However,
59  /// since C++ doesn't have pure interface concept, destructor will be
60  /// generated anyway. We can only control proper use of it. For this
61  /// reason we hide from public use and make it available for descendants.
62  virtual ~ErrorListener() {}
63 };
64 
65 }
66 }
67 }
68 }
ONIXS_MTS_CASH_SDP_API std::string enumToString(ErrorCode::Enum)