1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139 | // Copyright (C) 2011-2026 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_IAADDR_H
#define OPTION6_IAADDR_H
#include <asiolink/io_address.h>
#include <dhcp/option.h>
#include <boost/shared_ptr.hpp>
namespace isc {
namespace dhcp {
class Option6IAAddr;
/// A pointer to the @c isc::dhcp::Option6IAAddr object.
typedef boost::shared_ptr<Option6IAAddr> Option6IAAddrPtr;
class Option6IAAddr: public Option {
public:
/// length of the fixed part of the IAADDR option
static const size_t OPTION6_IAADDR_LEN = 24;
/// @brief Constructor, used for options constructed (during transmission).
///
/// @throw BadValue if specified addr is not IPv6
///
/// @param type option type
/// @param addr reference to an address
/// @param preferred address preferred lifetime (in seconds)
/// @param valid address valid lifetime (in seconds)
Option6IAAddr(uint16_t type, const isc::asiolink::IOAddress& addr,
uint32_t preferred, uint32_t valid);
/// @brief Constructor, used for received options.
///
/// @throw OutOfRange if specified option is truncated
///
/// @param type option type
/// @param begin iterator to first byte of option data
/// @param end iterator to end of option data (first byte after option end)
/// @param rec_level recursion level.
Option6IAAddr(uint32_t type, OptionBuffer::const_iterator begin,
OptionBuffer::const_iterator end, size_t rec_level = 0);
/// @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 buf pointer to a buffer
/// @param check if set to false, allows options larger than 255 for v4
void pack(isc::util::OutputBuffer& buf, bool check = true) const;<--- Function in derived class
/// @brief Parses received buffer.
///
/// @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 Parses received buffer with limited recursion.
///
/// @param begin iterator to first byte of option data
/// @param end iterator to end of option data (first byte after option end)
/// @param rec_level recursion level.
void unpack(OptionBufferConstIter begin,
OptionBufferConstIter end,
size_t rec_level);
/// Returns string representation of the option.
///
/// @param indent number of spaces before printing text
///
/// @return string with text representation.
virtual std::string
toText(int indent = 0) const;<--- Function in derived class
/// sets address in this option.
///
/// @param addr address to be sent in this option
void setAddress(const isc::asiolink::IOAddress& addr) { addr_ = addr; }
/// Sets preferred lifetime (in seconds)
///
/// @param pref address preferred lifetime (in seconds)
///
void setPreferred(unsigned int pref) { preferred_=pref; }<--- The function 'setPreferred' is never used.
/// Sets valid lifetime (in seconds).
///
/// @param valid address valid lifetime (in seconds)
///
void setValid(unsigned int valid) { valid_=valid; }<--- The function 'setValid' is never used.
/// Returns address contained within this option.
///
/// @return address
isc::asiolink::IOAddress
getAddress() const { return addr_; }
/// Returns preferred lifetime of an address.
///
/// @return preferred lifetime (in seconds)
unsigned int
getPreferred() const { return preferred_; }
/// Returns valid lifetime of an address.
///
/// @return valid lifetime (in seconds)
unsigned int
getValid() const { return valid_; }
/// returns data length (data length + DHCPv4/DHCPv6 option header)
virtual uint16_t len() const;<--- Function in derived class
protected:
/// contains an IPv6 address
isc::asiolink::IOAddress addr_;
/// contains preferred-lifetime timer (in seconds)
unsigned int preferred_;
/// contains valid-lifetime timer (in seconds)
unsigned int valid_;
};
} // isc::dhcp namespace
} // isc namespace
#endif // OPTION_IA_H
|