Kea  2.3.4-git
packet_queue.h
Go to the documentation of this file.
1 // Copyright (C) 2018-2022 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 PACKET_QUEUE_H
8 #define PACKET_QUEUE_H
9 
10 #include <cc/data.h>
11 #include <dhcp/socket_info.h>
12 #include <dhcp/pkt4.h>
13 #include <dhcp/pkt6.h>
14 
15 #include <sstream>
16 
17 namespace isc {
18 
19 namespace dhcp {
20 
25 public:
26  InvalidQueueParameter(const char* file, size_t line, const char* what) :
27  isc::Exception(file, line, what) {}
28 };
29 
31 enum class QueueEnd {
32  FRONT, // Typically the end packets are read from
33  BACK // Typically the end packets are written to
34 };
35 
46 template<typename PacketTypePtr>
47 class PacketQueue {
48 public:
49 
56  explicit PacketQueue(const std::string& queue_type)
57  : queue_type_(queue_type) {}
58 
60  virtual ~PacketQueue(){};
61 
69  virtual void enqueuePacket(PacketTypePtr packet, const SocketInfo& source) = 0;
70 
78  virtual PacketTypePtr dequeuePacket() = 0;
79 
81  virtual bool empty() const = 0;
82 
84  virtual size_t getSize() const = 0;
85 
87  virtual void clear() = 0;
88 
99  virtual data::ElementPtr getInfo() const {
101  info->set("queue-type", data::Element::create(queue_type_));
102  return (info);
103  }
104 
110  std::string getInfoStr() const {
111  data::ElementPtr info = getInfo();
112  std::ostringstream os;
113  info->toJSON(os);
114  return (os.str());
115  }
116 
118  std::string getQueueType() {
119  return (queue_type_);
120  };
121 
122 private:
124  std::string queue_type_;
125 
126 };
127 
131 typedef boost::shared_ptr<PacketQueue<Pkt4Ptr>> PacketQueue4Ptr;
132 
136 typedef boost::shared_ptr<PacketQueue<Pkt6Ptr>> PacketQueue6Ptr;
137 
138 }; // namespace isc::dhcp
139 }; // namespace isc
140 
141 #endif // PACKET_QUEUE_H
std::string getQueueType()
Definition: packet_queue.h:118
std::string getInfoStr() const
Fetches a JSON string representation of queue operational info.
Definition: packet_queue.h:110
virtual data::ElementPtr getInfo() const
Fetches operational information about the current state of the queue.
Definition: packet_queue.h:99
Interface for managing a queue of inbound DHCP packets.
Definition: packet_queue.h:47
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
QueueEnd
Enumerates choices between the two ends of the queue.
Definition: packet_queue.h:31
static ElementPtr createMap(const Position &pos=ZERO_POSITION())
Creates an empty MapElement type ElementPtr.
Definition: data.cc:291
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
boost::shared_ptr< PacketQueue< Pkt4Ptr > > PacketQueue4Ptr
Defines pointer to the DHCPv4 queue interface used at the application level.
Definition: packet_queue.h:131
InvalidQueueParameter(const char *file, size_t line, const char *what)
Definition: packet_queue.h:26
boost::shared_ptr< PacketQueue< Pkt6Ptr > > PacketQueue6Ptr
Defines pointer to the DHCPv6 queue interface used at the application level.
Definition: packet_queue.h:136
This is a base class for exceptions thrown from the DNS library module.
Defines the logger used by the top-level component of kea-lfc.
static ElementPtr create(const Position &pos=ZERO_POSITION())
Definition: data.cc:241
virtual ~PacketQueue()
Virtual destructor.
Definition: packet_queue.h:60
PacketQueue(const std::string &queue_type)
Constructor.
Definition: packet_queue.h:56
Invalid queue parameter exception.
Definition: packet_queue.h:24
Holds information about socket.
Definition: socket_info.h:19