NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
validity-period.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
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:
53  ValidityPeriod() = default;
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 
128 std::ostream&
129 operator<<(std::ostream& os, const ValidityPeriod& period);
130 
131 } // namespace security
132 } // namespace ndn
133 
134 #endif // NDN_SECURITY_VALIDITY_PERIOD_HPP
Copyright (c) 2011-2015 Regents of the University of California.
bool operator!=(const ValidityPeriod &other) const
const Block & wireEncode() const
Encode ValidityPeriod into TLV block.
bool operator==(const ValidityPeriod &other) const
ValidityPeriod()=default
Set validity period (UNIX epoch, UNIX epoch) that is always invalid.
Class representing a wire element of NDN-TLV packet format.
Definition: block.hpp:43
bool isValid(const time::system_clock::TimePoint &now=time::system_clock::now()) const
Check if now falls within the validity period.
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:45
std::ostream & operator<<(std::ostream &os, CommandInterestValidator::ErrorCode error)
Abstraction of validity period.
std::pair< time::system_clock::TimePoint, time::system_clock::TimePoint > getPeriod() const
Get the stored validity period.
time_point TimePoint
Definition: time.hpp:90
void wireDecode(const Block &wire)
Decode ValidityPeriod from TLV block.
represents an error in TLV encoding or decoding
Definition: tlv.hpp:50