NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
validation-error.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_SECURITY_V2_VALIDATION_ERROR_HPP
23 #define NDN_SECURITY_V2_VALIDATION_ERROR_HPP
24 
25 #include "ndn-cxx/detail/common.hpp"
26 
27 namespace ndn {
28 namespace security {
29 namespace v2 {
30 
34 class ValidationError
35 {
36 public:
41  enum Code : uint32_t {
42  NO_ERROR = 0,
43  INVALID_SIGNATURE = 1,
44  NO_SIGNATURE = 2,
45  CANNOT_RETRIEVE_CERT = 3,
46  EXPIRED_CERT = 4,
47  LOOP_DETECTED = 5,
48  MALFORMED_CERT = 6,
49  EXCEEDED_DEPTH_LIMIT = 7,
50  INVALID_KEY_LOCATOR = 8,
51  POLICY_ERROR = 9,
52  IMPLEMENTATION_ERROR = 255,
53  USER_MIN = 256 // custom error codes should use >=256
54  };
55 
56 public:
60  ValidationError(uint32_t code, const std::string& info = "")
61  : m_code(code)
62  , m_info(info)
63  {
64  }
65 
66  uint32_t
67  getCode() const
68  {
69  return m_code;
70  }
71 
72  const std::string&
73  getInfo() const
74  {
75  return m_info;
76  }
77 
78 private:
79  uint32_t m_code;
80  std::string m_info;
81 };
82 
83 std::ostream&
84 operator<<(std::ostream& os, ValidationError::Code code);
85 
86 std::ostream&
87 operator<<(std::ostream& os, const ValidationError& error);
88 
89 } // namespace v2
90 } // namespace security
91 } // namespace ndn
92 
93 #endif // NDN_SECURITY_V2_VALIDATION_ERROR_HPP
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34
ndn::security::v2::ValidationError::Code
Code
Known validation error code.
Definition: validation-error.hpp:41
ndn::security::v2::ValidationError::getInfo
const std::string & getInfo() const
Definition: validation-error.hpp:73
common.hpp
import common constructs for ndn-cxx library internal use
ndn::security::v2::ValidationError::ValidationError
ValidationError(uint32_t code, const std::string &info="")
Validation error, implicitly convertible from an error code and info.
Definition: validation-error.hpp:60
ndn::security::v2::operator<<
std::ostream & operator<<(std::ostream &os, const AdditionalDescription &other)
Definition: additional-description.cpp:178
ndn::security::v2::ValidationError
Validation error code and optional detailed error message.
Definition: validation-error.hpp:34