blob: aa7accb66043b9a02e4ed7f9942af96de53cbb1e [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013-2017 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_MGMT_NFD_FACE_STATUS_HPP
#define NDN_MGMT_NFD_FACE_STATUS_HPP
#include "face-traits.hpp"
#include "../../util/time.hpp"
namespace ndn {
namespace nfd {
/**
* \ingroup management
* \brief represents an item in NFD Face dataset
* \sa https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Face-Dataset
*/
class FaceStatus : public FaceTraits<FaceStatus>
{
public:
FaceStatus();
explicit
FaceStatus(const Block& block);
/** \brief prepend FaceStatus to the encoder
*/
template<encoding::Tag TAG>
size_t
wireEncode(EncodingImpl<TAG>& encoder) const;
/** \brief encode FaceStatus
*/
const Block&
wireEncode() const;
/** \brief decode FaceStatus
*/
void
wireDecode(const Block& wire);
public: // getters & setters
bool
hasExpirationPeriod() const
{
return !!m_expirationPeriod;
}
time::milliseconds
getExpirationPeriod() const
{
BOOST_ASSERT(hasExpirationPeriod());
return *m_expirationPeriod;
}
FaceStatus&
setExpirationPeriod(time::milliseconds expirationPeriod);
FaceStatus&
unsetExpirationPeriod();
uint64_t
getNInInterests() const
{
return m_nInInterests;
}
FaceStatus&
setNInInterests(uint64_t nInInterests);
uint64_t
getNInData() const
{
return m_nInData;
}
FaceStatus&
setNInData(uint64_t nInData);
uint64_t
getNInNacks() const
{
return m_nInNacks;
}
FaceStatus&
setNInNacks(uint64_t nInNacks);
uint64_t
getNOutInterests() const
{
return m_nOutInterests;
}
FaceStatus&
setNOutInterests(uint64_t nOutInterests);
uint64_t
getNOutData() const
{
return m_nOutData;
}
FaceStatus&
setNOutData(uint64_t nOutData);
uint64_t
getNOutNacks() const
{
return m_nOutNacks;
}
FaceStatus&
setNOutNacks(uint64_t nOutNacks);
uint64_t
getNInBytes() const
{
return m_nInBytes;
}
FaceStatus&
setNInBytes(uint64_t nInBytes);
uint64_t
getNOutBytes() const
{
return m_nOutBytes;
}
FaceStatus&
setNOutBytes(uint64_t nOutBytes);
private:
optional<time::milliseconds> m_expirationPeriod;
uint64_t m_nInInterests;
uint64_t m_nInData;
uint64_t m_nInNacks;
uint64_t m_nOutInterests;
uint64_t m_nOutData;
uint64_t m_nOutNacks;
uint64_t m_nInBytes;
uint64_t m_nOutBytes;
};
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(FaceStatus);
bool
operator==(const FaceStatus& a, const FaceStatus& b);
inline bool
operator!=(const FaceStatus& a, const FaceStatus& b)
{
return !(a == b);
}
std::ostream&
operator<<(std::ostream& os, const FaceStatus& status);
} // namespace nfd
} // namespace ndn
#endif // NDN_MGMT_NFD_FACE_STATUS_HPP