control-response.cpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2025 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.
 */
 
#include "ndn-cxx/mgmt/control-response.hpp"
#include "ndn-cxx/encoding/block-helpers.hpp"
#include "ndn-cxx/encoding/tlv-nfd.hpp"
 
namespace ndn::mgmt {
 
ControlResponse::ControlResponse() = default;
 
ControlResponse::ControlResponse(uint32_t code, const std::string& text)
  : m_code(code)
  , m_text(text)
{
}
 
ControlResponse::ControlResponse(const Block& block)
{
  wireDecode(block);
}
 
ControlResponse&
ControlResponse::setCode(uint32_t code)
{
  m_code = code;
  m_wire.reset();
  return *this;
}
 
ControlResponse&
ControlResponse::setText(const std::string& text)
{
  m_text = text;
  m_wire.reset();
  return *this;
}
 
ControlResponse&
ControlResponse::setBody(const Block& body)
{
  m_body = body;
  m_body.encode(); // will do nothing if already encoded
  m_wire.reset();
  return *this;
}
 
const Block&
ControlResponse::wireEncode() const
{
  if (m_wire.hasWire()) {
    return m_wire;
  }
 
  m_wire = Block(tlv::nfd::ControlResponse);
  m_wire.push_back(makeNonNegativeIntegerBlock(tlv::nfd::StatusCode, m_code));
  m_wire.push_back(makeStringBlock(tlv::nfd::StatusText, m_text));
  if (m_body.hasWire()) {
    m_wire.push_back(m_body);
  }
 
  m_wire.encode();
  return m_wire;
}
 
void
ControlResponse::wireDecode(const Block& wire)
{
  if (wire.type() != tlv::nfd::ControlResponse) {
    NDN_THROW(Error("ControlResponse", wire.type()));
  }
 
  *this = {};
  m_wire = wire;
  m_wire.parse();
 
  auto it = m_wire.elements_begin();
  if (it != m_wire.elements_end() && it->type() == tlv::nfd::StatusCode) {
    m_code = readNonNegativeIntegerAs<uint32_t>(*it);
    ++it;
  }
  else {
    NDN_THROW(Error("StatusCode is missing or out of order"));
  }
 
  if (it != m_wire.elements_end() && it->type() == tlv::nfd::StatusText) {
    m_text = readString(*it);
    ++it;
  }
  else {
    NDN_THROW(Error("StatusText is missing or out of order"));
  }
 
  if (it != m_wire.elements_end()) {
    m_body = *it;
  }
}
 
} // namespace ndn::mgmt