validity-period.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_SECURITY_VALIDITY_PERIOD_HPP
#define NDN_CXX_SECURITY_VALIDITY_PERIOD_HPP
 
#include "ndn-cxx/encoding/block.hpp"
#include "ndn-cxx/encoding/tlv.hpp"
#include "ndn-cxx/util/time.hpp"
 
namespace ndn::security {
 
class ValidityPeriod : private boost::equality_comparable<ValidityPeriod>
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
  static ValidityPeriod
  makeRelative(time::seconds validFrom, time::seconds validUntil,
               const time::system_clock::time_point& now = time::system_clock::now());
 
  ValidityPeriod();
 
  explicit
  ValidityPeriod(const Block& block);
 
  ValidityPeriod(const time::system_clock::time_point& notBefore,
                 const time::system_clock::time_point& notAfter);
 
  bool
  isValid(const time::system_clock::time_point& now = time::system_clock::now()) const;
 
  ValidityPeriod&
  setPeriod(const time::system_clock::time_point& notBefore,
            const time::system_clock::time_point& notAfter);
 
  std::pair<time::system_clock::time_point, time::system_clock::time_point>
  getPeriod() const;
 
  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder) const;
 
  const Block&
  wireEncode() const;
 
  void
  wireDecode(const Block& wire);
 
private:
  using TimePoint = boost::chrono::time_point<time::system_clock, time::seconds>;
 
  static TimePoint
  toTimePointFloor(const time::system_clock::time_point& t);
 
  static TimePoint
  toTimePointCeil(const time::system_clock::time_point& t);
 
  static TimePoint
  decodeTimePoint(const Block& element);
 
private: // non-member operators
  // NOTE: the following "hidden friend" operators are available via
  //       argument-dependent lookup only and must be defined inline.
  // boost::equality_comparable provides != operator.
 
  friend bool
  operator==(const ValidityPeriod& lhs, const ValidityPeriod& rhs)
  {
    return lhs.m_notBefore == rhs.m_notBefore &&
           lhs.m_notAfter == rhs.m_notAfter;
  }
 
private:
  TimePoint m_notBefore;
  TimePoint m_notAfter;
 
  mutable Block m_wire;
};
 
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ValidityPeriod);
 
std::ostream&
operator<<(std::ostream& os, const ValidityPeriod& period);
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_VALIDITY_PERIOD_HPP