aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/src/protocols/errors.h
blob: cb3d3474ef2390f9531d03817d6aea6c0184ca82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
 * Copyright (c) 2020 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <string>
#include <system_error>

namespace transport {
namespace protocol {

/**
 * @brief Get the default server error category.
 * @return The default server error category instance.
 *
 * @warning The first call to this function is thread-safe only starting with
 * C++11.
 */
const std::error_category& protocol_category();

/**
 * The list of errors.
 */
enum class protocol_error {
  success = 0,
  signature_verification_failed,
  integrity_verification_failed,
  no_verifier_provided,
  io_error,
  max_retransmissions_error,
  session_aborted,
};

/**
 * @brief Create an error_code instance for the given error.
 * @param error The error.
 * @return The error_code instance.
 */
inline std::error_code make_error_code(protocol_error error) {
  return std::error_code(static_cast<int>(error), protocol_category());
}

/**
 * @brief Create an error_condition instance for the given error.
 * @param error The error.
 * @return The error_condition instance.
 */
inline std::error_condition make_error_condition(protocol_error error) {
  return std::error_condition(static_cast<int>(error), protocol_category());
}

/**
 * @brief A server error category.
 */
class protocol_category_impl : public std::error_category {
 public:
  /**
   * @brief Get the name of the category.
   * @return The name of the category.
   */
  virtual const char* name() const throw();

  /**
   * @brief Get the error message for a given error.
   * @param ev The error numeric value.
   * @return The message associated to the error.
   */
  virtual std::string message(int ev) const;
};
}  // namespace protocol
}  // namespace transport

namespace std {
// namespace system {
template <>
struct is_error_code_enum<::transport::protocol::protocol_error>
    : public std::true_type {};
// }  // namespace system
}  // namespace std