packet_queue.h

Go to the documentation of this file.

// Copyright (C) 2018-2022 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 PACKET_QUEUE_H
#define PACKET_QUEUE_H

#include <cc/data.h>
#include <dhcp/socket_info.h>
#include <dhcp/pkt4.h>
#include <dhcp/pkt6.h>

#include <sstream>

namespace isc {

namespace dhcp {

class InvalidQueueParameter : public Exception {
public:
    InvalidQueueParameter(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

enum class QueueEnd {
    FRONT,  // Typically the end packets are read from
    BACK    // Typically the end packets are written to
};

template<typename PacketTypePtr>
class PacketQueue {
public:

    explicit PacketQueue(const std::string& queue_type)
        :  queue_type_(queue_type) {}

    virtual ~PacketQueue(){};

    virtual void enqueuePacket(PacketTypePtr packet, const SocketInfo& source) = 0;

    virtual PacketTypePtr dequeuePacket() = 0;

    virtual bool empty() const = 0;

    virtual size_t getSize() const = 0;

    virtual void clear() = 0;

    virtual data::ElementPtr getInfo() const {
       data::ElementPtr info = data::Element::createMap();
       info->set("queue-type", data::Element::create(queue_type_));
       return(info);
    }

    std::string getInfoStr() const {
       data::ElementPtr info = getInfo();
       std::ostringstream os;
       info->toJSON(os);
       return (os.str());
    }

    std::string getQueueType() {
        return (queue_type_);
    };

private:
    std::string queue_type_;

};

typedef boost::shared_ptr<PacketQueue<Pkt4Ptr>> PacketQueue4Ptr;

typedef boost::shared_ptr<PacketQueue<Pkt6Ptr>> PacketQueue6Ptr;

}; // namespace isc::dhcp
}; // namespace isc

#endif // PACKET_QUEUE_H