Kea  2.3.4-git
option_opaque_data_tuples.h
Go to the documentation of this file.
1 // Copyright (C) 2015-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 OPTION_OPAQUE_DATA_TUPLES_H
8 #define OPTION_OPAQUE_DATA_TUPLES_H
9 
10 #include <dhcp/dhcp4.h>
11 #include <dhcp/dhcp6.h>
12 #include <dhcp/opaque_data_tuple.h>
13 #include <dhcp/option.h>
14 #include <util/buffer.h>
15 #include <boost/shared_ptr.hpp>
16 #include <stdint.h>
17 
18 namespace isc {
19 namespace dhcp {
20 
37 public:
38 
40  typedef std::vector<OpaqueDataTuple> TuplesCollection;
41 
49  OptionOpaqueDataTuples(Option::Universe u, const uint16_t type);
50 
61  OptionOpaqueDataTuples(Option::Universe u, const uint16_t type,
64 
66  OptionPtr clone() const;
67 
72  virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const;
73 
82  virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end);
83 
89  void addTuple(const OpaqueDataTuple& tuple);
90 
102  void setTuple(const size_t at, const OpaqueDataTuple& tuple);
103 
110  OpaqueDataTuple getTuple(const size_t at) const;
111 
113  size_t getTuplesNum() const {
114  return (tuples_.size());
115  }
116 
118  const TuplesCollection& getTuples() const {
119  return (tuples_);
120  }
121 
127  bool hasTuple(const std::string& tuple_str) const;
128 
130  virtual uint16_t len() const;
131 
136  virtual std::string toText(int indent = 0) const;
137 
138 private:
139 
146  OpaqueDataTuple::LengthFieldType getLengthFieldType() const {
149  }
150 
154  uint16_t getMinimalLength() const {
155  return (4);
156  }
157 
159  TuplesCollection tuples_;
160 
161 };
162 
164 typedef boost::shared_ptr<OptionOpaqueDataTuples> OptionOpaqueDataTuplesPtr;
165 
166 }
167 }
168 
169 #endif // OPTION_OPAQUE_DATA_TUPLES_H
void setTuple(const size_t at, const OpaqueDataTuple &tuple)
Replaces tuple at the specified index with a new tuple.
size_t getTuplesNum() const
Returns the number of opaque data tuples added to the option.
void addTuple(const OpaqueDataTuple &tuple)
Adds a new opaque data tuple to the option.
OptionOpaqueDataTuples(Option::Universe u, const uint16_t type)
Constructor.
const TuplesCollection & getTuples() const
Returns collection of opaque data tuples carried in the option.
OpaqueDataTuple getTuple(const size_t at) const
Returns opaque data tuple at the specified position.
std::vector< OpaqueDataTuple > TuplesCollection
Collection of opaque data tuples carried by the option.
boost::shared_ptr< Option > OptionPtr
Definition: option.h:36
Universe
defines option universe DHCPv4 or DHCPv6
Definition: option.h:83
Universe universe_
option universe (V4 or V6)
Definition: option.h:587
OptionPtr clone() const
Copies this option and returns a pointer to the copy.
bool hasTuple(const std::string &tuple_str) const
Checks if the object holds the opaque data tuple with the specified string.
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:294
OptionBuffer::const_iterator OptionBufferConstIter
const_iterator for walking over OptionBuffer
Definition: option.h:30
LengthFieldType
Size of the length field in the tuple.
Defines the logger used by the top-level component of kea-lfc.
virtual std::string toText(int indent=0) const
Returns text representation of the option.
Represents a single instance of the opaque data preceded by length.
This class encapsulates a collection of data tuples and could be used by multiple options...
virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end)
Parses buffer holding an option.
virtual uint16_t len() const
Returns the full length of the option, including option header.
boost::shared_ptr< OptionOpaqueDataTuples > OptionOpaqueDataTuplesPtr
Defines a pointer to the OptionOpaqueDataTuples.
virtual void pack(isc::util::OutputBuffer &buf, bool check=true) const
Renders option into the buffer in the wire format.