Kea  2.3.7
opaque_data_tuple.h
Go to the documentation of this file.
1 // Copyright (C) 2014-2023 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 OPAQUE_DATA_TUPLE_H
8 #define OPAQUE_DATA_TUPLE_H
9 
10 #include <dhcp/option.h>
11 #include <util/buffer.h>
12 #include <util/io_utilities.h>
13 
14 #include <iostream>
15 #include <iterator>
16 #include <string>
17 #include <vector>
18 
19 namespace isc {
20 namespace dhcp {
21 
25 public:
26  OpaqueDataTupleError(const char* file, size_t line, const char* what) :
27  isc::Exception(file, line, what) { };
28 };
29 
30 
48 public:
49 
61  };
62 
64  using Buffer = std::vector<uint8_t>;
65  using InputIterator = Buffer::const_iterator;
66 
71  OpaqueDataTuple(LengthFieldType length_field_type);
72 
84  OpaqueDataTuple(LengthFieldType length_field_type,
85  InputIterator begin,
86  InputIterator end)
87  : length_field_type_(length_field_type) {
88  unpack(begin, end);
89  }
90 
104  void append(const char* data, const size_t len) {
105  data_.insert(data_.end(), data, data + len);
106  }
107  void append(InputIterator data, const size_t len) {
108  data_.insert(data_.end(), data, data + len);
109  }
110 
117  void append(const std::string& text);
118 
129  void assign(const char* data, const size_t len) {
130  data_.assign(data, data + len);
131  }
132  void assign(InputIterator data, const size_t len) {
133  data_.assign(data, data + len);
134  }
135 
142  void assign(const std::string& text);
143 
145  void clear();
146 
150  bool equals(const std::string& other) const;
151 
154  return (length_field_type_);
155  }
156 
158  size_t getLength() const {
159  return (data_.size());
160  }
161 
163  size_t getTotalLength() const {
164  return (getDataFieldSize() + getLength());
165  }
166 
172  const Buffer& getData() const {
173  return (data_);
174  }
175 
177  std::string getText() const;
178 
200  void pack(isc::util::OutputBuffer& buf) const;
201 
217  void unpack(InputIterator begin, InputIterator end);
218 
220  //{@
221 
228  OpaqueDataTuple& operator=(const std::string& other);
229 
237  bool operator==(const std::string& other) const;
238 
247  bool operator!=(const std::string& other);
249 
253  int getDataFieldSize() const;
254 
255 private:
256 
258  Buffer data_;
259 
261  LengthFieldType length_field_type_;
262 };
263 
265 typedef boost::shared_ptr<OpaqueDataTuple> OpaqueDataTuplePtr;
266 
276 std::ostream& operator<<(std::ostream& os, const OpaqueDataTuple& tuple);
277 
286 std::istream& operator>>(std::istream& is, OpaqueDataTuple& tuple);
287 
288 } // namespace isc::dhcp
289 } // namespace isc
290 
291 #endif
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 to be thrown when the operation on OpaqueDataTuple object results in an error.
OpaqueDataTupleError(const char *file, size_t line, const char *what)
Represents a single instance of the opaque data preceded by length.
bool operator==(const std::string &other) const
Equality operator.
void clear()
Removes the contents of the tuple.
int getDataFieldSize() const
Returns the size of the tuple length field.
OpaqueDataTuple & operator=(const std::string &other)
Assignment operator.
OpaqueDataTuple(LengthFieldType length_field_type)
Default constructor.
void assign(InputIterator data, const size_t len)
LengthFieldType
Size of the length field in the tuple.
void pack(isc::util::OutputBuffer &buf) const
Renders the tuple to a buffer in the wire format.
void append(InputIterator data, const size_t len)
const Buffer & getData() const
Returns a reference to the buffer holding tuple data.
LengthFieldType getLengthFieldType() const
Returns tuple length data field type.
Buffer::const_iterator InputIterator
void assign(const char *data, const size_t len)
Assigns data to the tuple.
std::string getText() const
Return the tuple data in the textual format.
size_t getTotalLength() const
Returns a total size of the tuple, including length field.
void append(const char *data, const size_t len)
Appends data to the tuple.
bool equals(const std::string &other) const
Checks if the data carried in the tuple match the string.
void unpack(InputIterator begin, InputIterator end)
Parses wire data and creates a tuple from it.
bool operator!=(const std::string &other)
Inequality operator.
OpaqueDataTuple(LengthFieldType length_field_type, InputIterator begin, InputIterator end)
Constructor.
std::vector< uint8_t > Buffer
Defines a type of the data buffer used to hold the opaque data.
size_t getLength() const
Returns the length of the data in the tuple.
The OutputBuffer class is a buffer abstraction for manipulating mutable data.
Definition: buffer.h:294
std::istream & operator>>(std::istream &is, OpaqueDataTuple &tuple)
Inserts data carried in the stream into the tuple.
std::ostream & operator<<(std::ostream &os, const OpaqueDataTuple &tuple)
Inserts the OpaqueDataTuple as a string into stream.
boost::shared_ptr< OpaqueDataTuple > OpaqueDataTuplePtr
Pointer to the OpaqueDataTuple object.
Defines the logger used by the top-level component of kea-lfc.