Kea: d2_queue_mgr.h Source File

| Kea 3.0.3-git

d2_queue_mgr.h
Go to the documentation of this file.
1// Copyright (C) 2013-2024 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 D2_QUEUE_MGR_H
8#define D2_QUEUE_MGR_H
9
11
12#include <asiolink/io_service.h>
13#include <exceptions/exceptions.h>
14#include <dhcp_ddns/ncr_msg.h>
15#include <dhcp_ddns/ncr_io.h>
16
17#include <boost/noncopyable.hpp>
18#include <deque>
19
20namespace isc {
21namespace d2 {
22
25 typedef std::deque<dhcp_ddns::NameChangeRequestPtr> RequestQueue;
26
28 class D2QueueMgrError : public isc::Exception {
29public:
30 D2QueueMgrError(const char* file, size_t line, const char* what) :
31 isc::Exception(file, line, what) { }
32};
33
37 class D2QueueMgrReceiveError : public isc::Exception {
38public:
39 D2QueueMgrReceiveError(const char* file, size_t line, const char* what) :
40 isc::Exception(file, line, what) { }
41};
42
45 class D2QueueMgrQueueFull : public isc::Exception {
46public:
47 D2QueueMgrQueueFull(const char* file, size_t line, const char* what) :
48 isc::Exception(file, line, what) { }
49};
50
52 class D2QueueMgrQueueEmpty : public isc::Exception {
53public:
54 D2QueueMgrQueueEmpty(const char* file, size_t line, const char* what) :
55 isc::Exception(file, line, what) { }
56};
57
59 class D2QueueMgrInvalidIndex : public isc::Exception {
60public:
61 D2QueueMgrInvalidIndex(const char* file, size_t line, const char* what) :
62 isc::Exception(file, line, what) { }
63};
64
129 class D2QueueMgr : public dhcp_ddns::NameChangeListener::RequestReceiveHandler,
130 boost::noncopyable {
131public:
135 static const size_t MAX_QUEUE_DEFAULT = 1024;
136
138 enum State {
139 NOT_INITTED,
140 INITTED,
141 RUNNING,
142 STOPPING,
143 STOPPED_QUEUE_FULL,
144 STOPPED_RECV_ERROR,
145 STOPPED,
146 };
147
160 D2QueueMgr(asiolink::IOServicePtr& io_service,
161 const size_t max_queue_size = MAX_QUEUE_DEFAULT);
162
164 virtual ~D2QueueMgr();
165
177 void initUDPListener(const isc::asiolink::IOAddress& ip_address,
178 const uint32_t port,
179 const dhcp_ddns::NameChangeFormat format,
180 const bool reuse_address = false);
181
189 void startListening();
190
218 virtual void operator()(const dhcp_ddns::NameChangeListener::Result result,
219 dhcp_ddns::NameChangeRequestPtr& ncr);
220
233 void stopListening(const State target_stop_state = STOPPED);
234
242 void removeListener();
243
245 size_t getQueueSize() const {
246 return (ncr_queue_.size());
247 };
248
250 size_t getMaxQueueSize() const {
251 return (max_queue_size_);
252 }
253
261 void setMaxQueueSize(const size_t max_queue_size);
262
264 State getMgrState() const {
265 return (mgr_state_);
266 }
267
277 const dhcp_ddns::NameChangeRequestPtr& peek() const;
278
289 const dhcp_ddns::NameChangeRequestPtr& peekAt(const size_t index) const;
290
298 void dequeueAt(const size_t index);
299
303 void dequeue();
304
308 void enqueue(dhcp_ddns::NameChangeRequestPtr& ncr);
309
311 void clearQueue();
312
313 private:
318 void updateStopState();
319
321 asiolink::IOServicePtr io_service_;
322
324 size_t max_queue_size_;
325
327 RequestQueue ncr_queue_;
328
330 boost::shared_ptr<dhcp_ddns::NameChangeListener> listener_;
331
333 State mgr_state_;
334
336 State target_stop_state_;
337};
338
340 typedef boost::shared_ptr<D2QueueMgr> D2QueueMgrPtr;
341
342} // namespace isc::d2
343} // namespace isc
344
345#endif
isc::Exception
This is a base class for exceptions thrown from the DNS library module.
Definition exceptions/exceptions.h:23
isc::Exception::Exception
Exception(const char *file, size_t line, const char *what)
Constructor for a given type for exceptions with file name and file line number.
Definition exceptions/exceptions.cc:17
isc::Exception::what
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Definition exceptions/exceptions.cc:32
isc::asiolink::IOAddress
The IOAddress class represents an IP addresses (version agnostic).
Definition io_address.h:45
isc::d2::D2QueueMgrError::D2QueueMgrError
D2QueueMgrError(const char *file, size_t line, const char *what)
Definition d2_queue_mgr.h:30
isc::d2::D2QueueMgrInvalidIndex::D2QueueMgrInvalidIndex
D2QueueMgrInvalidIndex(const char *file, size_t line, const char *what)
Definition d2_queue_mgr.h:61
isc::d2::D2QueueMgrQueueEmpty::D2QueueMgrQueueEmpty
D2QueueMgrQueueEmpty(const char *file, size_t line, const char *what)
Definition d2_queue_mgr.h:54
isc::d2::D2QueueMgrQueueFull::D2QueueMgrQueueFull
D2QueueMgrQueueFull(const char *file, size_t line, const char *what)
Definition d2_queue_mgr.h:47
isc::d2::D2QueueMgrReceiveError::D2QueueMgrReceiveError
D2QueueMgrReceiveError(const char *file, size_t line, const char *what)
Definition d2_queue_mgr.h:39
isc::d2::D2QueueMgr::peek
const dhcp_ddns::NameChangeRequestPtr & peek() const
Returns the entry at the front of the queue.
Definition d2_queue_mgr.cc:197
isc::d2::D2QueueMgr::D2QueueMgr
D2QueueMgr(asiolink::IOServicePtr &io_service, const size_t max_queue_size=MAX_QUEUE_DEFAULT)
Constructor.
Definition d2_queue_mgr.cc:21
isc::d2::D2QueueMgr::~D2QueueMgr
virtual ~D2QueueMgr()
Destructor.
Definition d2_queue_mgr.cc:32
isc::d2::D2QueueMgr::getMaxQueueSize
size_t getMaxQueueSize() const
Returns the maximum number of entries allowed in the queue.
Definition d2_queue_mgr.h:250
isc::d2::D2QueueMgr::getMgrState
State getMgrState() const
Returns the current state.
Definition d2_queue_mgr.h:264
isc::d2::D2QueueMgr::MAX_QUEUE_DEFAULT
static const size_t MAX_QUEUE_DEFAULT
Maximum number of entries allowed in the request queue.
Definition d2_queue_mgr.h:135
isc::d2::D2QueueMgr::dequeue
void dequeue()
Removes the entry at the front of the queue.
Definition d2_queue_mgr.cc:230
isc::d2::D2QueueMgr::State
State
Defines the list of possible states for D2QueueMgr.
Definition d2_queue_mgr.h:138
isc::d2::D2QueueMgr::STOPPED_QUEUE_FULL
@ STOPPED_QUEUE_FULL
Definition d2_queue_mgr.h:143
isc::d2::D2QueueMgr::NOT_INITTED
@ NOT_INITTED
Definition d2_queue_mgr.h:139
isc::d2::D2QueueMgr::STOPPED_RECV_ERROR
@ STOPPED_RECV_ERROR
Definition d2_queue_mgr.h:144
isc::d2::D2QueueMgr::RUNNING
@ RUNNING
Definition d2_queue_mgr.h:141
isc::d2::D2QueueMgr::STOPPED
@ STOPPED
Definition d2_queue_mgr.h:145
isc::d2::D2QueueMgr::STOPPING
@ STOPPING
Definition d2_queue_mgr.h:142
isc::d2::D2QueueMgr::INITTED
@ INITTED
Definition d2_queue_mgr.h:140
isc::d2::D2QueueMgr::peekAt
const dhcp_ddns::NameChangeRequestPtr & peekAt(const size_t index) const
Returns the entry at a given position in the queue.
Definition d2_queue_mgr.cc:207
isc::d2::D2QueueMgr::removeListener
void removeListener()
Deletes the current listener.
Definition d2_queue_mgr.cc:185
isc::d2::D2QueueMgr::enqueue
void enqueue(dhcp_ddns::NameChangeRequestPtr &ncr)
Adds a request to the end of the queue.
Definition d2_queue_mgr.cc:240
isc::d2::D2QueueMgr::startListening
void startListening()
Starts actively listening for requests.
Definition d2_queue_mgr.cc:121
isc::d2::D2QueueMgr::setMaxQueueSize
void setMaxQueueSize(const size_t max_queue_size)
Sets the maximum number of entries allowed in the queue.
Definition d2_queue_mgr.cc:250
isc::d2::D2QueueMgr::getQueueSize
size_t getQueueSize() const
Returns the number of entries in the queue.
Definition d2_queue_mgr.h:245
isc::d2::D2QueueMgr::operator()
virtual void operator()(const dhcp_ddns::NameChangeListener::Result result, dhcp_ddns::NameChangeRequestPtr &ncr)
Function operator implementing the NCR receive callback.
Definition d2_queue_mgr.cc:36
isc::d2::D2QueueMgr::clearQueue
void clearQueue()
Removes all entries from the queue.
Definition d2_queue_mgr.cc:245
isc::d2::D2QueueMgr::initUDPListener
void initUDPListener(const isc::asiolink::IOAddress &ip_address, const uint32_t port, const dhcp_ddns::NameChangeFormat format, const bool reuse_address=false)
Initializes the listener as a UDP listener.
Definition d2_queue_mgr.cc:103
isc::d2::D2QueueMgr::dequeueAt
void dequeueAt(const size_t index)
Removes the entry at a given position in the queue.
Definition d2_queue_mgr.cc:218
isc::d2::D2QueueMgr::stopListening
void stopListening(const State target_stop_state=STOPPED)
Stops listening for requests.
Definition d2_queue_mgr.cc:149
isc::dhcp_ddns::NameChangeListener::RequestReceiveHandler
Abstract class for defining application layer receive callbacks.
Definition ncr_io.h:183
isc::dhcp_ddns::NameChangeListener::Result
Result
Defines the outcome of an asynchronous NCR receive.
Definition ncr_io.h:171
isc::util::State
Defines a State within the State Model.
Definition state_model.h:61
exceptions.h
io_service.h
isc::asiolink::IOServicePtr
boost::shared_ptr< IOService > IOServicePtr
Defines a smart pointer to an IOService instance.
Definition io_service.h:28
isc::d2
Definition check_exists_add.cc:19
isc::d2::RequestQueue
std::deque< dhcp_ddns::NameChangeRequestPtr > RequestQueue
Defines a queue of requests.
Definition d2_queue_mgr.h:25
isc::d2::D2QueueMgrPtr
boost::shared_ptr< D2QueueMgr > D2QueueMgrPtr
Defines a pointer for manager instances.
Definition d2_queue_mgr.h:340
isc::dhcp_ddns::NameChangeFormat
NameChangeFormat
Defines the list of data wire formats supported.
Definition ncr_msg.h:59
isc::dhcp_ddns::NameChangeRequestPtr
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition ncr_msg.h:241
isc::util::file
Definition filesystem.cc:28
isc
Defines the logger used by the top-level component of kea-lfc.
Definition agent_parser.cc:148
ncr_io.h
This file defines abstract classes for exchanging NameChangeRequests.
ncr_msg.h
This file provides the classes needed to embody, compose, and decompose DNS update requests that are ...