blq_msg.h

Go to the documentation of this file.

// Copyright (C) 2022-2025 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 BLQ_MSG_H
#define BLQ_MSG_H
 
#include <config.h>
#include <dhcp/pkt.h>
#include <tcp/tcp_stream_msg.h>
 
namespace isc {
namespace lease_query {

typedef uint32_t Xid;

class BlqMsg {
public:
    BlqMsg(dhcp::PktPtr pkt)
        : pkt_(pkt) {
        if (!pkt) {
            isc_throw(BadValue, "BlqMsg::pkt cannot be empty");
        }
    }

    virtual ~BlqMsg() {
    }

    Xid getXid() const {
        return (pkt_->getTransid());
    }

    void setXid(const Xid& xid) {
        pkt_->setTransid(xid);
    }

    dhcp::PktPtr getPkt() const {
        return (pkt_);
    }

    void pack() {
        // We need the wire form of the query, so pack it.
        pkt_->pack();
        auto buffer = pkt_->getBuffer();
 
        // Prepend the length of the request.
        uint16_t size = static_cast<uint16_t>(buffer.getLength());
        wire_data_.reserve(size + 2);
        wire_data_.push_back(static_cast<uint8_t>((size & 0xff00U) >> 8));
        wire_data_.push_back(static_cast<uint8_t>(size & 0x00ffU));
 
        // Add on the packet data.
        auto const& data = buffer.getVector();
        wire_data_.insert(wire_data_.end(), data.cbegin(), data.cend());
    }

    size_t getWireSize() const {
        return (wire_data_.size());
    }

    tcp::WireData& getWireData() {
        return (wire_data_);
    }
 
protected:
    dhcp::PktPtr pkt_;

    tcp::WireData wire_data_;
};

typedef boost::shared_ptr<BlqMsg> BlqMsgPtr;

class BlqQuery : public BlqMsg {
public:
    BlqQuery(dhcp::PktPtr query)
        : BlqMsg(query) {
    }

    virtual ~BlqQuery() {
    }

    dhcp::PktPtr getQuery() {
        return (getPkt());
    }
};

typedef boost::shared_ptr<BlqQuery> BlqQueryPtr;

typedef std::list<BlqQueryPtr> BlqQueryList;

class BlqResponse : public BlqMsg {
public:
    BlqResponse(dhcp::PktPtr response)
        : BlqMsg(response) {
    }

    virtual ~BlqResponse() {};

    dhcp::PktPtr getResponse() {
        return (getPkt());
    }
};

typedef boost::shared_ptr<BlqResponse> BlqResponsePtr;

typedef std::list<BlqResponsePtr> BlqResponseList;
 
} // end of namespace isc::lease_query
} // end of namespace isc
 
#endif // BLQ_MSG_H