ndn-cxx/mgmt/nfd/channel-status.hpp

/* -*- 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_MGMT_NFD_CHANNEL_STATUS_HPP
#define NDN_CXX_MGMT_NFD_CHANNEL_STATUS_HPP

#include "ndn-cxx/encoding/block.hpp"

namespace ndn {
namespace nfd {

/**
 * \ingroup management
 * \brief Represents an item in NFD Channel dataset.
 * \sa https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Channel-Dataset
 */
class ChannelStatus
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };

  ChannelStatus();

  explicit
  ChannelStatus(const Block& payload);

  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder) const;

  const Block&
  wireEncode() const;

  void
  wireDecode(const Block& wire);

public: // getters & setters
  const std::string&
  getLocalUri() const
  {
    return m_localUri;
  }

  ChannelStatus&
  setLocalUri(const std::string& localUri);

private:
  std::string m_localUri;

  mutable Block m_wire;
};

NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus);

bool
operator==(const ChannelStatus& a, const ChannelStatus& b);

inline bool
operator!=(const ChannelStatus& a, const ChannelStatus& b)
{
  return !(a == b);
}

std::ostream&
operator<<(std::ostream& os, const ChannelStatus& status);

} // namespace nfd
} // namespace ndn

#endif // NDN_CXX_MGMT_NFD_CHANNEL_STATUS_HPP