option_opaque_data_tuples.h

Go to the documentation of this file.

// Copyright (C) 2015-2023 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 OPTION_OPAQUE_DATA_TUPLES_H
#define OPTION_OPAQUE_DATA_TUPLES_H
 
#include <dhcp/dhcp4.h>
#include <dhcp/dhcp6.h>
#include <dhcp/opaque_data_tuple.h>
#include <dhcp/option.h>
#include <util/buffer.h>
#include <boost/shared_ptr.hpp>
#include <dhcp/option_data_types.h>
#include <stdint.h>
 
namespace isc {
namespace dhcp {
 
class OptionOpaqueDataTuples : public Option {
public:
 
    typedef std::vector<OpaqueDataTuple> TuplesCollection;
 
    OptionOpaqueDataTuples(Option::Universe u,
                           const uint16_t type,
                           OpaqueDataTuple::LengthFieldType length_field_type = OpaqueDataTuple::LENGTH_EMPTY);
 
    OptionOpaqueDataTuples(Option::Universe u,
                           const uint16_t type,
                           OptionBufferConstIter begin,
                           OptionBufferConstIter end,
                           OpaqueDataTuple::LengthFieldType length_field_type = OpaqueDataTuple::LENGTH_EMPTY);
 
    OptionPtr clone() const;
 
    virtual void pack(isc::util::OutputBuffer& buf, bool check = true) const;
 
    virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end);
 
    void addTuple(const OpaqueDataTuple& tuple);
 
    void setTuple(const size_t at, const OpaqueDataTuple& tuple);
 
    OpaqueDataTuple getTuple(const size_t at) const;
 
    size_t getTuplesNum() const {
        return (tuples_.size());
    }
 
    const TuplesCollection& getTuples() const {
        return (tuples_);
    }
 
    bool hasTuple(const std::string& tuple_str) const;
 
    virtual uint16_t len() const;
 
    virtual std::string toText(int indent = 0) const;
 
private:
    OpaqueDataTuple::LengthFieldType length_field_type_;
 
    TuplesCollection tuples_;
 
};
 
typedef boost::shared_ptr<OptionOpaqueDataTuples> OptionOpaqueDataTuplesPtr;
 
}
}
 
#endif // OPTION_OPAQUE_DATA_TUPLES_H