option_vendor_class.h

Go to the documentation of this file.

// Copyright (C) 2014-2018 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_VENDOR_CLASS_H
#define OPTION_VENDOR_CLASS_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 <stdint.h>

namespace isc {
namespace dhcp {

class OptionVendorClass : public Option {
public:

    typedef std::vector<OpaqueDataTuple> TuplesCollection;

    OptionVendorClass(Option::Universe u, const uint32_t vendor_id);

    OptionVendorClass(Option::Universe u, OptionBufferConstIter begin,
                      OptionBufferConstIter end);

    OptionPtr clone() const;

    virtual void pack(isc::util::OutputBuffer& buf) const;

    virtual void unpack(OptionBufferConstIter begin, OptionBufferConstIter end);

    uint32_t getVendorId() const {
        return (vendor_id_);
    }

    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:

    static uint16_t getOptionCode(Option::Universe u) {
        if (u == V4) {
            return (DHO_VIVCO_SUBOPTIONS);
        } else {
            return (D6O_VENDOR_CLASS);
        }
    }

    OpaqueDataTuple::LengthFieldType getLengthFieldType() const {
        return (getUniverse() == V4 ? OpaqueDataTuple::LENGTH_1_BYTE :
                OpaqueDataTuple::LENGTH_2_BYTES);
    }

    uint16_t getMinimalLength() const {
        return (getUniverse() == Option::V4 ? 6 : 8);
    }

    uint32_t vendor_id_;

    TuplesCollection tuples_;

};

typedef boost::shared_ptr<OptionVendorClass> OptionVendorClassPtr;

}
}

#endif // OPTION_VENDOR_CLASS_H