validity-period.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2017 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_VALIDITY_PERIOD_HPP
23 #define NDN_SECURITY_VALIDITY_PERIOD_HPP
24 
25 #include "../common.hpp"
26 #include "../encoding/tlv.hpp"
27 #include "../encoding/block.hpp"
28 #include "../util/time.hpp"
29 
30 namespace ndn {
31 namespace security {
32 
33 
38 {
39 public:
40  class Error : public tlv::Error
41  {
42  public:
43  explicit
44  Error(const std::string& what)
45  : tlv::Error(what)
46  {
47  }
48  };
49 
50 public:
54 
57  explicit
58  ValidityPeriod(const Block& block);
59 
69  const time::system_clock::TimePoint& notAfter);
70 
75  bool
77 
88  const time::system_clock::TimePoint& notAfter);
89 
92  std::pair<time::system_clock::TimePoint, time::system_clock::TimePoint>
93  getPeriod() const;
94 
97  template<encoding::Tag TAG>
98  size_t
99  wireEncode(EncodingImpl<TAG>& encoder) const;
100 
103  const Block&
104  wireEncode() const;
105 
109  void
110  wireDecode(const Block& wire);
111 
112 public: // EqualityComparable concept
113  bool
114  operator==(const ValidityPeriod& other) const;
115 
116  bool
117  operator!=(const ValidityPeriod& other) const;
118 
119 private:
120  typedef boost::chrono::time_point<time::system_clock, time::seconds> TimePoint;
121 
122  TimePoint m_notBefore;
123  TimePoint m_notAfter;
124 
125  mutable Block m_wire;
126 };
127 
129 
130 std::ostream&
131 operator<<(std::ostream& os, const ValidityPeriod& period);
132 
133 } // namespace security
134 } // namespace ndn
135 
136 #endif // NDN_SECURITY_VALIDITY_PERIOD_HPP
Copyright (c) 2013-2017 Regents of the University of California.
Definition: common.hpp:66
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
bool operator==(const ValidityPeriod &other) const
ValidityPeriod & setPeriod(const time::system_clock::TimePoint &notBefore, const time::system_clock::TimePoint &notAfter)
Set validity period [notBefore, notAfter].
static time_point now() noexcept
Definition: time.cpp:46
#define NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ClassName)
Abstraction of validity period.
std::pair< time::system_clock::TimePoint, time::system_clock::TimePoint > getPeriod() const
Get the stored validity period.
bool operator!=(const ValidityPeriod &other) const
const Block & wireEncode() const
Encode ValidityPeriod into TLV block.
time_point TimePoint
Definition: time.hpp:90
bool isValid(const time::system_clock::TimePoint &now=time::system_clock::now()) const
Check if now falls within the validity period.
ValidityPeriod()
Set validity period [UNIX epoch + 1 nanosecond, UNIX epoch] that is always invalid.
void wireDecode(const Block &wire)
Decode ValidityPeriod from TLV block.
std::ostream & operator<<(std::ostream &os, const SigningInfo &si)
represents an error in TLV encoding or decoding