blob: 79b84e054e5422991a30066c00d64061a938b388 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013-2018 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_CONTROL_PARAMETERS_HPP
#define NDN_MGMT_NFD_CONTROL_PARAMETERS_HPP
#include "../../encoding/nfd-constants.hpp"
#include "../../name.hpp"
#include "../../util/time.hpp"
#include "../control-parameters.hpp"
namespace ndn {
namespace nfd {
/**
* \ingroup management
*/
enum ControlParameterField {
CONTROL_PARAMETER_NAME,
CONTROL_PARAMETER_FACE_ID,
CONTROL_PARAMETER_URI,
CONTROL_PARAMETER_LOCAL_URI,
CONTROL_PARAMETER_ORIGIN,
CONTROL_PARAMETER_COST,
CONTROL_PARAMETER_CAPACITY,
CONTROL_PARAMETER_FLAGS,
CONTROL_PARAMETER_MASK,
CONTROL_PARAMETER_STRATEGY,
CONTROL_PARAMETER_EXPIRATION_PERIOD,
CONTROL_PARAMETER_FACE_PERSISTENCY,
CONTROL_PARAMETER_UBOUND
};
const std::string CONTROL_PARAMETER_FIELD[CONTROL_PARAMETER_UBOUND] = {
"Name",
"FaceId",
"Uri",
"LocalUri",
"Origin",
"Cost",
"Capacity",
"Flags",
"Mask",
"Strategy",
"ExpirationPeriod",
"FacePersistency"
};
/**
* \ingroup management
* \brief represents parameters in a ControlCommand request or response
* \sa https://redmine.named-data.net/projects/nfd/wiki/ControlCommand#ControlParameters
* \details This type is copyable because it's an abstraction of a TLV type.
*/
class ControlParameters : public mgmt::ControlParameters
{
public:
class Error : public tlv::Error
{
public:
explicit
Error(const std::string& what)
: tlv::Error(what)
{
}
};
ControlParameters();
explicit
ControlParameters(const Block& block);
template<encoding::Tag TAG>
size_t
wireEncode(EncodingImpl<TAG>& encoder) const;
Block
wireEncode() const final;
void
wireDecode(const Block& wire) final;
public: // getters & setters
bool
hasName() const
{
return m_hasFields[CONTROL_PARAMETER_NAME];
}
const Name&
getName() const
{
BOOST_ASSERT(this->hasName());
return m_name;
}
ControlParameters&
setName(const Name& name)
{
m_wire.reset();
m_name = name;
m_hasFields[CONTROL_PARAMETER_NAME] = true;
return *this;
}
ControlParameters&
unsetName()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_NAME] = false;
return *this;
}
bool
hasFaceId() const
{
return m_hasFields[CONTROL_PARAMETER_FACE_ID];
}
uint64_t
getFaceId() const
{
BOOST_ASSERT(this->hasFaceId());
return m_faceId;
}
ControlParameters&
setFaceId(uint64_t faceId)
{
m_wire.reset();
m_faceId = faceId;
m_hasFields[CONTROL_PARAMETER_FACE_ID] = true;
return *this;
}
ControlParameters&
unsetFaceId()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_FACE_ID] = false;
return *this;
}
bool
hasUri() const
{
return m_hasFields[CONTROL_PARAMETER_URI];
}
const std::string&
getUri() const
{
BOOST_ASSERT(this->hasUri());
return m_uri;
}
ControlParameters&
setUri(const std::string& uri)
{
m_wire.reset();
m_uri = uri;
m_hasFields[CONTROL_PARAMETER_URI] = true;
return *this;
}
ControlParameters&
unsetUri()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_URI] = false;
return *this;
}
bool
hasLocalUri() const
{
return m_hasFields[CONTROL_PARAMETER_LOCAL_URI];
}
const std::string&
getLocalUri() const
{
BOOST_ASSERT(this->hasLocalUri());
return m_localUri;
}
ControlParameters&
setLocalUri(const std::string& localUri)
{
m_wire.reset();
m_localUri = localUri;
m_hasFields[CONTROL_PARAMETER_LOCAL_URI] = true;
return *this;
}
ControlParameters&
unsetLocalUri()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_LOCAL_URI] = false;
return *this;
}
bool
hasOrigin() const
{
return m_hasFields[CONTROL_PARAMETER_ORIGIN];
}
RouteOrigin
getOrigin() const
{
BOOST_ASSERT(this->hasOrigin());
return m_origin;
}
ControlParameters&
setOrigin(RouteOrigin origin)
{
m_wire.reset();
m_origin = origin;
m_hasFields[CONTROL_PARAMETER_ORIGIN] = true;
return *this;
}
ControlParameters&
unsetOrigin()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_ORIGIN] = false;
return *this;
}
bool
hasCost() const
{
return m_hasFields[CONTROL_PARAMETER_COST];
}
uint64_t
getCost() const
{
BOOST_ASSERT(this->hasCost());
return m_cost;
}
ControlParameters&
setCost(uint64_t cost)
{
m_wire.reset();
m_cost = cost;
m_hasFields[CONTROL_PARAMETER_COST] = true;
return *this;
}
ControlParameters&
unsetCost()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_COST] = false;
return *this;
}
bool
hasCapacity() const
{
return m_hasFields[CONTROL_PARAMETER_CAPACITY];
}
uint64_t
getCapacity() const
{
BOOST_ASSERT(this->hasCapacity());
return m_capacity;
}
ControlParameters&
setCapacity(uint64_t capacity)
{
m_wire.reset();
m_capacity = capacity;
m_hasFields[CONTROL_PARAMETER_CAPACITY] = true;
return *this;
}
ControlParameters&
unsetCapacity()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_CAPACITY] = false;
return *this;
}
bool
hasFlags() const
{
return m_hasFields[CONTROL_PARAMETER_FLAGS];
}
uint64_t
getFlags() const
{
BOOST_ASSERT(this->hasFlags());
return m_flags;
}
ControlParameters&
setFlags(uint64_t flags)
{
m_wire.reset();
m_flags = flags;
m_hasFields[CONTROL_PARAMETER_FLAGS] = true;
return *this;
}
ControlParameters&
unsetFlags()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_FLAGS] = false;
return *this;
}
bool
hasMask() const
{
return m_hasFields[CONTROL_PARAMETER_MASK];
}
uint64_t
getMask() const
{
BOOST_ASSERT(this->hasMask());
return m_mask;
}
ControlParameters&
setMask(uint64_t mask)
{
m_wire.reset();
m_mask = mask;
m_hasFields[CONTROL_PARAMETER_MASK] = true;
return *this;
}
ControlParameters&
unsetMask()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_MASK] = false;
return *this;
}
bool
hasStrategy() const
{
return m_hasFields[CONTROL_PARAMETER_STRATEGY];
}
const Name&
getStrategy() const
{
BOOST_ASSERT(this->hasStrategy());
return m_strategy;
}
ControlParameters&
setStrategy(const Name& strategy)
{
m_wire.reset();
m_strategy = strategy;
m_hasFields[CONTROL_PARAMETER_STRATEGY] = true;
return *this;
}
ControlParameters&
unsetStrategy()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_STRATEGY] = false;
return *this;
}
bool
hasExpirationPeriod() const
{
return m_hasFields[CONTROL_PARAMETER_EXPIRATION_PERIOD];
}
const time::milliseconds&
getExpirationPeriod() const
{
BOOST_ASSERT(this->hasExpirationPeriod());
return m_expirationPeriod;
}
ControlParameters&
setExpirationPeriod(const time::milliseconds& expirationPeriod)
{
m_wire.reset();
m_expirationPeriod = expirationPeriod;
m_hasFields[CONTROL_PARAMETER_EXPIRATION_PERIOD] = true;
return *this;
}
ControlParameters&
unsetExpirationPeriod()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_EXPIRATION_PERIOD] = false;
return *this;
}
bool
hasFacePersistency() const
{
return m_hasFields[CONTROL_PARAMETER_FACE_PERSISTENCY];
}
FacePersistency
getFacePersistency() const
{
BOOST_ASSERT(this->hasFacePersistency());
return m_facePersistency;
}
ControlParameters&
setFacePersistency(FacePersistency persistency)
{
m_wire.reset();
m_facePersistency = persistency;
m_hasFields[CONTROL_PARAMETER_FACE_PERSISTENCY] = true;
return *this;
}
ControlParameters&
unsetFacePersistency()
{
m_wire.reset();
m_hasFields[CONTROL_PARAMETER_FACE_PERSISTENCY] = false;
return *this;
}
const std::vector<bool>&
getPresentFields() const
{
return m_hasFields;
}
public: // Flags and Mask helpers
/**
* \return whether bit is enabled in Mask
* \param bit bit position within range [0, 64) (least significant bit is 0)
*/
bool
hasFlagBit(size_t bit) const;
/**
* \return bit at a position in Flags
* \param bit bit position within range [0, 64) (least significant bit is 0)
*/
bool
getFlagBit(size_t bit) const;
/**
* \brief set a bit in Flags
* \param bit bit position within range [0, 64) (least significant bit is 0)
* \param value new value in Flags
* \param wantMask if true, enable the bit in Mask
*/
ControlParameters&
setFlagBit(size_t bit, bool value, bool wantMask = true);
/**
* \brief disable a bit in Mask
* \param bit bit position within range [0, 64) (least significant bit is 0)
* \post If all bits are disabled, Flags and Mask fields are deleted.
*/
ControlParameters&
unsetFlagBit(size_t bit);
private: // fields
std::vector<bool> m_hasFields;
Name m_name;
uint64_t m_faceId;
std::string m_uri;
std::string m_localUri;
RouteOrigin m_origin;
uint64_t m_cost;
uint64_t m_capacity;
uint64_t m_flags;
uint64_t m_mask;
Name m_strategy;
time::milliseconds m_expirationPeriod;
FacePersistency m_facePersistency;
private:
mutable Block m_wire;
};
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ControlParameters);
std::ostream&
operator<<(std::ostream& os, const ControlParameters& parameters);
} // namespace nfd
} // namespace ndn
#endif // NDN_MGMT_NFD_CONTROL_PARAMETERS_HPP