Kea  2.3.4-git
isc::dhcp::Option6StatusCode Class Reference

This class represents Status Code option (13) from RFC 8415. More...

#include <option6_status_code.h>

+ Inheritance diagram for isc::dhcp::Option6StatusCode:

Public Member Functions

 Option6StatusCode (const uint16_t status_code, const std::string &status_message)
 Constructor, used for options constructed (during transmission). More...
 
 Option6StatusCode (OptionBufferConstIter begin, OptionBufferConstIter end)
 Constructor, used for received options. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
std::string dataToText () const
 Returns textual representation of the option data. More...
 
uint16_t getStatusCode () const
 Returns numeric status code. More...
 
std::string getStatusCodeName () const
 Returns the name of the status code. More...
 
const std::string & getStatusMessage () const
 Returns status message. More...
 
virtual uint16_t len () const
 Returns total length of the option. More...
 
virtual void pack (isc::util::OutputBuffer &buf, bool check=true) const
 Writes option in wire-format. More...
 
void setStatusCode (const uint16_t status_code)
 Sets new numeric status code. More...
 
void setStatusMessage (const std::string &status_message)
 Sets new status message. More...
 
virtual std::string toText (int indent=0) const
 Returns textual representation of the option. More...
 
virtual void unpack (OptionBufferConstIter begin, OptionBufferConstIter end)
 Parses received buffer. More...
 
- Public Member Functions inherited from isc::dhcp::Option
 Option (Universe u, uint16_t type)
 ctor, used for options constructed, usually during transmission More...
 
 Option (Universe u, uint16_t type, const OptionBuffer &data)
 Constructor, used for received options. More...
 
 Option (Universe u, uint16_t type, OptionBufferConstIter first, OptionBufferConstIter last)
 Constructor, used for received options. More...
 
 Option (const Option &source)
 Copy constructor. More...
 
virtual ~Option ()
 just to force that every option has virtual dtor More...
 
void addOption (OptionPtr opt)
 Adds a sub-option. More...
 
bool delOption (uint16_t type)
 Attempts to delete first suboption of requested type. More...
 
bool equals (const OptionPtr &other) const
 Checks if options are equal. More...
 
virtual bool equals (const Option &other) const
 Checks if two options are equal. More...
 
virtual const OptionBuffergetData () const
 Returns pointer to actual data. More...
 
std::string getEncapsulatedSpace () const
 Returns the name of the option space encapsulated by this option. More...
 
virtual uint16_t getHeaderLen () const
 Returns length of header (2 for v4, 4 for v6) More...
 
OptionCollectiongetMutableOptions ()
 Returns all encapsulated options. More...
 
OptionPtr getOption (uint16_t type) const
 Returns shared_ptr to suboption of specific type. More...
 
const OptionCollectiongetOptions () const
 Returns all encapsulated options. More...
 
void getOptionsCopy (OptionCollection &options_copy) const
 Performs deep copy of suboptions. More...
 
uint16_t getType () const
 Returns option type (0-255 for DHCPv4, 0-65535 for DHCPv6) More...
 
uint16_t getUint16 () const
 Returns content of first word. More...
 
uint32_t getUint32 () const
 Returns content of first double word. More...
 
uint8_t getUint8 () const
 Returns content of first byte. More...
 
Universe getUniverse () const
 returns option universe (V4 or V6) More...
 
Optionoperator= (const Option &rhs)
 Assignment operator. More...
 
template<typename InputIterator >
void setData (InputIterator first, InputIterator last)
 Sets content of this option from buffer. More...
 
void setEncapsulatedSpace (const std::string &encapsulated_space)
 Sets the name of the option space encapsulated by this option. More...
 
void setUint16 (uint16_t value)
 Sets content of this option to a single uint16 value. More...
 
void setUint32 (uint32_t value)
 Sets content of this option to a single uint32 value. More...
 
void setUint8 (uint8_t value)
 Sets content of this option to a single uint8 value. More...
 
virtual std::vector< uint8_t > toBinary (const bool include_header=false) const
 Returns binary representation of the option. More...
 
virtual std::string toHexString (const bool include_header=false) const
 Returns string containing hexadecimal representation of option. More...
 
virtual std::string toString () const
 Returns string representation of the value. More...
 
virtual bool valid () const
 returns if option is valid (e.g. More...
 

Additional Inherited Members

- Public Types inherited from isc::dhcp::Option
typedef OptionPtr Factory(Option::Universe u, uint16_t type, const OptionBuffer &buf)
 a factory function prototype More...
 
enum  Universe { V4, V6 }
 defines option universe DHCPv4 or DHCPv6 More...
 
- Static Public Member Functions inherited from isc::dhcp::Option
static OptionPtr create (Universe u, uint16_t type)
 Factory function creating an instance of the Option. More...
 
static OptionPtr create (Universe u, uint16_t type, const OptionBuffer &data)
 Factory function creating an instance of the Option. More...
 
static OptionPtr factory (Option::Universe u, uint16_t type, const OptionBuffer &buf)
 Factory function to create instance of option. More...
 
static OptionPtr factory (Option::Universe u, uint16_t type)
 Factory function to create instance of option. More...
 
- Static Public Attributes inherited from isc::dhcp::Option
static bool lenient_parsing_
 Governs whether options should be parsed less strictly. More...
 
static const size_t OPTION4_HDR_LEN = 2
 length of the usual DHCPv4 option header (there are exceptions) More...
 
static const size_t OPTION6_HDR_LEN = 4
 length of any DHCPv6 option header More...
 
- Protected Member Functions inherited from isc::dhcp::Option
void check () const
 A protected method used for option correctness. More...
 
template<typename OptionType >
OptionPtr cloneInternal () const
 Copies this option and returns a pointer to the copy. More...
 
std::string headerToText (const int indent=0, const std::string &type_name="") const
 Returns option header in the textual format. More...
 
void packHeader (isc::util::OutputBuffer &buf, bool check=true) const
 Store option's header in a buffer. More...
 
void packOptions (isc::util::OutputBuffer &buf, bool check=true) const
 Store sub options in a buffer. More...
 
std::string suboptionsToText (const int indent=0) const
 Returns collection of suboptions in the textual format. More...
 
void unpackOptions (const OptionBuffer &buf)
 Builds a collection of sub options from the buffer. More...
 
- Protected Attributes inherited from isc::dhcp::Option
OptionBuffer data_
 contains content of this data More...
 
std::string encapsulated_space_
 Name of the option space being encapsulated by this option. More...
 
OptionCollection options_
 collection for storing suboptions More...
 
uint16_t type_
 option type (0-255 for DHCPv4, 0-65535 for DHCPv6) More...
 
Universe universe_
 option universe (V4 or V6) More...
 

Detailed Description

This class represents Status Code option (13) from RFC 8415.

Definition at line 24 of file option6_status_code.h.

Constructor & Destructor Documentation

◆ Option6StatusCode() [1/2]

isc::dhcp::Option6StatusCode::Option6StatusCode ( const uint16_t  status_code,
const std::string &  status_message 
)

Constructor, used for options constructed (during transmission).

Parameters
status_codeNumeric status code, e.g. STATUS_NoAddrsAvail.
status_messageTextual message for the statuscode.

Definition at line 31 of file option6_status_code.cc.

◆ Option6StatusCode() [2/2]

isc::dhcp::Option6StatusCode::Option6StatusCode ( OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)

Constructor, used for received options.

Exceptions
OutOfRangeif specified option is truncated
Parameters
beginIterator to first byte of option data
endIterator to end of option data (first byte after option end).

Definition at line 37 of file option6_status_code.cc.

References unpack().

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

OptionPtr isc::dhcp::Option6StatusCode::clone ( ) const
virtual

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Definition at line 47 of file option6_status_code.cc.

◆ dataToText()

std::string isc::dhcp::Option6StatusCode::dataToText ( ) const

Returns textual representation of the option data.

This method returns only the status code and the status message. It excludes the option header.

Definition at line 93 of file option6_status_code.cc.

References getStatusCode(), and getStatusCodeName().

Referenced by toText().

+ Here is the call graph for this function:

◆ getStatusCode()

uint16_t isc::dhcp::Option6StatusCode::getStatusCode ( ) const
inline

Returns numeric status code.

Definition at line 77 of file option6_status_code.h.

References getStatusCodeName().

Referenced by dataToText(), getStatusCodeName(), and pack().

+ Here is the call graph for this function:

◆ getStatusCodeName()

std::string isc::dhcp::Option6StatusCode::getStatusCodeName ( ) const

◆ getStatusMessage()

const std::string& isc::dhcp::Option6StatusCode::getStatusMessage ( ) const
inline

Returns status message.

Definition at line 92 of file option6_status_code.h.

◆ len()

uint16_t isc::dhcp::Option6StatusCode::len ( ) const
virtual

Returns total length of the option.

The returned length is a sum of the option header and data fields.

Reimplemented from isc::dhcp::Option.

Definition at line 80 of file option6_status_code.cc.

References isc::dhcp::Option::getHeaderLen().

+ Here is the call graph for this function:

◆ pack()

void isc::dhcp::Option6StatusCode::pack ( isc::util::OutputBuffer buf,
bool  check = true 
) const
virtual

Writes option in wire-format.

Writes option in wire-format to buf, returns pointer to first unused byte after stored option.

Parameters
[out]bufPointer to the output buffer.
checkif set to false, allows options larger than 255 for v4

Reimplemented from isc::dhcp::Option.

Definition at line 52 of file option6_status_code.cc.

References getStatusCode(), isc::dhcp::Option::packHeader(), isc::util::OutputBuffer::writeData(), and isc::util::OutputBuffer::writeUint16().

+ Here is the call graph for this function:

◆ setStatusCode()

void isc::dhcp::Option6StatusCode::setStatusCode ( const uint16_t  status_code)
inline

Sets new numeric status code.

Parameters
status_codeNew numeric status code.

Definition at line 87 of file option6_status_code.h.

◆ setStatusMessage()

void isc::dhcp::Option6StatusCode::setStatusMessage ( const std::string &  status_message)
inline

Sets new status message.

Parameters
status_messageNew status message (empty string is allowed).

Definition at line 99 of file option6_status_code.h.

◆ toText()

std::string isc::dhcp::Option6StatusCode::toText ( int  indent = 0) const
virtual

Returns textual representation of the option.

Parameters
indentNumber of spaces before printing text.

Reimplemented from isc::dhcp::Option.

Definition at line 85 of file option6_status_code.cc.

References dataToText(), and isc::dhcp::Option::headerToText().

+ Here is the call graph for this function:

◆ unpack()

void isc::dhcp::Option6StatusCode::unpack ( OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)
virtual

Parses received buffer.

Exceptions
OutOfRangeif specified option is truncated
Parameters
beginIterator to first byte of option data
endIterator to end of option data (first byte after option end)

Reimplemented from isc::dhcp::Option.

Definition at line 66 of file option6_status_code.cc.

References D6O_STATUS_CODE, isc_throw, and isc::util::readUint16().

Referenced by Option6StatusCode().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: