Kea 2.5.9
option6_client_fqdn.h
Go to the documentation of this file.
1// Copyright (C) 2013-2022 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef OPTION6_CLIENT_FQDN_H
8#define OPTION6_CLIENT_FQDN_H
9
10#include <dhcp/option.h>
11#include <dns/name.h>
12
13#include <string>
14
15namespace isc {
16namespace dhcp {
17
21public:
22 InvalidOption6FqdnFlags(const char* file, size_t line, const char* what) :
23 isc::Exception(file, line, what) {}
24};
25
28public:
29 InvalidOption6FqdnDomainName(const char* file, size_t line,
30 const char* what) :
31 isc::Exception(file, line, what) {}
32};
33
35class Option6ClientFqdnImpl;
36
87class Option6ClientFqdn : public Option {
88public:
89
92
93 static const uint8_t FLAG_S = 0x01;
94 static const uint8_t FLAG_O = 0x02;
95 static const uint8_t FLAG_N = 0x04;
97
99 static const uint8_t FLAG_MASK = 0x7;
100
102 static const uint16_t FLAG_FIELD_LEN = 1;
103
107 FULL
108 };
109
119 explicit Option6ClientFqdn(const uint8_t flags,
120 const std::string& domain_name,
121 const DomainNameType domain_name_type = FULL);
122
129 Option6ClientFqdn(const uint8_t flags);
130
143
146
148 virtual OptionPtr clone() const;
149
151 virtual ~Option6ClientFqdn();
152
155
168 bool getFlag(const uint8_t flag) const;
169
182 void setFlag(const uint8_t flag, const bool set);
183
185 void resetFlags();
186
194 std::string getDomainName() const;
195
202
208 void setDomainName(const std::string& domain_name,
209 const DomainNameType domain_name_type);
210
215 void resetDomainName();
216
223
228 virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const;
229
240 virtual void unpack(OptionBufferConstIter first,
242
251 virtual std::string toText(int indent = 0) const;
252
257 virtual uint16_t len() const;
258
259private:
260
263};
264
266typedef boost::shared_ptr<Option6ClientFqdn> Option6ClientFqdnPtr;
267
268} // namespace isc::dhcp
269} // namespace isc
270
271#endif // OPTION6_CLIENT_FQDN_H
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Exception thrown when invalid domain name is specified.
InvalidOption6FqdnDomainName(const char *file, size_t line, const char *what)
Exception thrown when invalid flags have been specified for DHCPv6 Client Fqdn Option.
InvalidOption6FqdnFlags(const char *file, size_t line, const char *what)
Implements the logic for the Option6ClientFqdn class.
Represents DHCPv6 Client FQDN Option (code 39).
void resetFlags()
Sets the flag field value to 0.
static const uint8_t FLAG_S
S bit.
static const uint8_t FLAG_N
N bit.
DomainNameType getDomainNameType() const
Returns enumerator value which indicates whether domain-name is partial or full.
virtual OptionPtr clone() const
Copies this option and returns a pointer to the copy.
static const uint16_t FLAG_FIELD_LEN
The length of the flag field within DHCPv6 Client Fqdn Option.
void setDomainName(const std::string &domain_name, const DomainNameType domain_name_type)
Set new domain-name.
void resetDomainName()
Set empty domain-name.
static const uint8_t FLAG_O
O bit.
static const uint8_t FLAG_MASK
Mask which zeroes MBZ flag bits.
virtual uint16_t len() const
Returns length of the complete option (data length + DHCPv6 option header).
virtual void unpack(OptionBufferConstIter first, OptionBufferConstIter last)
Parses option from the received buffer.
std::string getDomainName() const
Returns the domain-name in the text format.
DomainNameType
Type of the domain-name: partial or full.
virtual void pack(isc::util::OutputBuffer &buf, bool check=true) const
Writes option in the wire format into a buffer.
Option6ClientFqdn & operator=(const Option6ClientFqdn &source)
Assignment operator.
void packDomainName(isc::util::OutputBuffer &buf) const
Writes domain-name in the wire format into a buffer.
virtual std::string toText(int indent=0) const
Returns string representation of the option.
bool getFlag(const uint8_t flag) const
Checks if the specified flag of the DHCPv6 Client FQDN Option is set.
virtual ~Option6ClientFqdn()
Destructor.
void setFlag(const uint8_t flag, const bool set)
Modifies the value of the specified DHCPv6 Client Fqdn Option flag.
void check() const
A protected method used for option correctness.
Definition: option.cc:90
The OutputBuffer class is a buffer abstraction for manipulating mutable data.
Definition: buffer.h:343
OptionBuffer::const_iterator OptionBufferConstIter
const_iterator for walking over OptionBuffer
Definition: option.h:30
boost::shared_ptr< Option6ClientFqdn > Option6ClientFqdnPtr
A pointer to the Option6ClientFqdn object.
boost::shared_ptr< Option > OptionPtr
Definition: option.h:37
Defines the logger used by the top-level component of kea-lfc.