diff options
Diffstat (limited to 'src/lib/dhcp/option6_status_code.h')
| -rw-r--r-- | src/lib/dhcp/option6_status_code.h | 207 |
1 files changed, 207 insertions, 0 deletions
diff --git a/src/lib/dhcp/option6_status_code.h b/src/lib/dhcp/option6_status_code.h new file mode 100644 index 0000000..f133c5d --- /dev/null +++ b/src/lib/dhcp/option6_status_code.h @@ -0,0 +1,207 @@ +// Copyright (C) 2015-2022 Internet Systems Consortium, Inc. ("ISC") +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +#ifndef OPTION6_STATUS_CODE_H +#define OPTION6_STATUS_CODE_H + +#include <dhcp/option.h> +#include <boost/shared_ptr.hpp> +#include <stdint.h> +#include <string> + +namespace isc { +namespace dhcp { + +class Option6StatusCode; + +/// @brief Pointer to the @c isc::dhcp::Option6StatusCode. +typedef boost::shared_ptr<Option6StatusCode> Option6StatusCodePtr; + +/// @brief This class represents Status Code option (13) from RFC 8415. +class Option6StatusCode: public Option { +public: + /// @brief Constructor, used for options constructed (during transmission). + /// + /// @param status_code Numeric status code, e.g. STATUS_NoAddrsAvail. + /// @param status_message Textual message for the statuscode. + Option6StatusCode(const uint16_t status_code, const std::string& status_message); + + /// @brief Constructor, used for received options. + /// + /// @throw OutOfRange if specified option is truncated + /// + /// @param begin Iterator to first byte of option data + /// @param end Iterator to end of option data (first byte after option end). + Option6StatusCode(OptionBufferConstIter begin, OptionBufferConstIter end); + + /// @brief Copies this option and returns a pointer to the copy. + virtual OptionPtr clone() const; + + /// @brief Writes option in wire-format. + /// + /// Writes option in wire-format to buf, returns pointer to first unused + /// byte after stored option. + /// + /// @param [out] buf Pointer to the output buffer. + /// @param check if set to false, allows options larger than 255 for v4 + virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const; + + /// @brief Parses received buffer. + /// + /// @throw OutOfRange if specified option is truncated + /// + /// @param begin Iterator to first byte of option data + /// @param end Iterator to end of option data (first byte after option end) + virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end); + + /// @brief Returns total length of the option. + /// + /// The returned length is a sum of the option header and data fields. + virtual uint16_t len() const; + + /// @brief Returns textual representation of the option. + /// + /// @param indent Number of spaces before printing text. + virtual std::string toText(int indent = 0) const; + + /// @brief Returns textual representation of the option data. + /// + /// This method returns only the status code and the status + /// message. It excludes the option header. + std::string dataToText() const; + + /// @brief Returns numeric status code. + uint16_t getStatusCode() const { + return (status_code_); + } + + /// @brief Returns the name of the status code. + std::string getStatusCodeName() const; + + /// @brief Sets new numeric status code. + /// + /// @param status_code New numeric status code. + void setStatusCode(const uint16_t status_code) { + status_code_ = status_code; + } + + /// @brief Returns status message. + const std::string& getStatusMessage() const { + return (status_message_); + } + + /// @brief Sets new status message. + /// + /// @param status_message New status message (empty string is allowed). + void setStatusMessage(const std::string& status_message) { + status_message_ = status_message; + } + +private: + /// @brief Numeric status code. + uint16_t status_code_; + + /// @brief Textual message. + std::string status_message_; +}; + +/// The SLP Service Scope option has a similar layout... + +class Option4SlpServiceScope; + +/// @brief Pointer to the @c isc::dhcp::Option4SlpServiceScope. +typedef boost::shared_ptr<Option4SlpServiceScope> Option4SlpServiceScopePtr; + +/// @brief This class represents SLP Service Scope option (79) from RFC2610. +class Option4SlpServiceScope: public Option { +public: + /// @brief Constructor, used for options constructed (during transmission). + /// + /// @param mandatory_flag Mandatory flag. + /// @param scope_list Textual scope list, may be empty + Option4SlpServiceScope(const bool mandatory_flag, const std::string& scope_list); + + /// @brief Constructor, used for received options. + /// + /// @throw OutOfRange if specified option is truncated + /// + /// @param begin Iterator to first byte of option data + /// @param end Iterator to end of option data (first byte after option end). + Option4SlpServiceScope(OptionBufferConstIter begin, OptionBufferConstIter end); + + /// @brief Copies this option and returns a pointer to the copy. + virtual OptionPtr clone() const; + + /// @brief Writes option in wire-format. + /// + /// Writes option in wire-format to buf, returns pointer to first unused + /// byte after stored option. + /// + /// @param [out] buf Pointer to the output buffer. + /// @param check if set to false, allows options larger than 255 for v4 + virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const; + + /// @brief Parses received buffer. + /// + /// @throw OutOfRange if specified option is truncated + /// @throw BadDataTypeCast if first byte is not 0 or 1 + /// + /// @param begin Iterator to first byte of option data + /// @param end Iterator to end of option data (first byte after option end) + virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end); + + /// @brief Returns total length of the option. + /// + /// The returned length is a sum of the option header and data fields. + virtual uint16_t len() const; + + /// @brief Returns textual representation of the option. + /// + /// @param indent Number of spaces before printing text. + virtual std::string toText(int indent = 0) const; + + /// @brief Returns textual representation of the option data. + /// + /// This method returns only the status code and the status + /// message. It excludes the option header. + std::string dataToText() const; + + /// @brief Returns mandatory flag + bool getMandatoryFlag() const { + return (mandatory_flag_); + } + + /// @brief Sets new mandatory flag. + /// + /// @param mandatory_flag New numeric status code. + void setMandatoryFlag(const bool mandatory_flag) { + mandatory_flag_ = mandatory_flag; + } + + /// @brief Returns scope list. + const std::string& getScopeList() const { + return (scope_list_); + } + + /// @brief Sets new scope list. + /// + /// @param scope_list New scope list (empty string is allowed). + void setScopeList(std::string& scope_list) { + scope_list_ = scope_list; + } + +private: + /// @brief Mandatory flag. + bool mandatory_flag_; + + /// @brief Scope list. + std::string scope_list_; +}; + +} // isc::dhcp namespace +} // isc namespace + +#endif // OPTION6_STATUS_CODE_H |