ndn::mgmt::ControlResponse Class Reference

ControlCommand response. More...

#include <ndn-cxx/mgmt/control-response.hpp>

+ Collaboration diagram for ndn::mgmt::ControlResponse:

Classes

class  Error
 

Public Member Functions

 ControlResponse ()
 
 ControlResponse (const Block &block)
 
 ControlResponse (uint32_t code, const std::string &text)
 
const BlockgetBody () const
 
uint32_t getCode () const
 
const std::string & getText () const
 
ControlResponsesetBody (const Block &body)
 
ControlResponsesetCode (uint32_t code)
 
ControlResponsesetText (const std::string &text)
 
void wireDecode (const Block &block)
 
const BlockwireEncode () const
 

Protected Attributes

Block m_body
 
uint32_t m_code = 200
 
std::string m_text
 
Block m_wire
 

Friends

std::ostream & operator<< (std::ostream &os, const ControlResponse &response)
 

Detailed Description

ControlCommand response.

Definition at line 32 of file control-response.hpp.

Constructor & Destructor Documentation

◆ ControlResponse() [1/3]

ndn::mgmt::ControlResponse::ControlResponse ( )
default

◆ ControlResponse() [2/3]

ndn::mgmt::ControlResponse::ControlResponse ( uint32_t  code,
const std::string &  text 
)

Definition at line 30 of file control-response.cpp.

◆ ControlResponse() [3/3]

ndn::mgmt::ControlResponse::ControlResponse ( const Block block)
explicit

Definition at line 36 of file control-response.cpp.

Member Function Documentation

◆ getBody()

const Block& ndn::mgmt::ControlResponse::getBody ( ) const
inline

Definition at line 67 of file control-response.hpp.

◆ getCode()

uint32_t ndn::mgmt::ControlResponse::getCode ( ) const
inline

Definition at line 49 of file control-response.hpp.

◆ getText()

const std::string& ndn::mgmt::ControlResponse::getText ( ) const
inline

Definition at line 58 of file control-response.hpp.

◆ setBody()

ControlResponse & ndn::mgmt::ControlResponse::setBody ( const Block body)

Definition at line 58 of file control-response.cpp.

◆ setCode()

ControlResponse & ndn::mgmt::ControlResponse::setCode ( uint32_t  code)

Definition at line 42 of file control-response.cpp.

◆ setText()

ControlResponse & ndn::mgmt::ControlResponse::setText ( const std::string &  text)

Definition at line 50 of file control-response.cpp.

◆ wireDecode()

void ndn::mgmt::ControlResponse::wireDecode ( const Block block)

Definition at line 85 of file control-response.cpp.

◆ wireEncode()

const Block & ndn::mgmt::ControlResponse::wireEncode ( ) const

Definition at line 67 of file control-response.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const ControlResponse response 
)
friend

Definition at line 92 of file control-response.hpp.

Member Data Documentation

◆ m_body

Block ndn::mgmt::ControlResponse::m_body
protected

Definition at line 84 of file control-response.hpp.

◆ m_code

uint32_t ndn::mgmt::ControlResponse::m_code = 200
protected

Definition at line 82 of file control-response.hpp.

◆ m_text

std::string ndn::mgmt::ControlResponse::m_text
protected

Definition at line 83 of file control-response.hpp.

◆ m_wire

Block ndn::mgmt::ControlResponse::m_wire
mutableprotected

Definition at line 86 of file control-response.hpp.