Kea 3.1.1
d2_process.h
Go to the documentation of this file.
1// Copyright (C) 2013-2025 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_PROCESS_H
8#define D2_PROCESS_H
9
10#include <d2/d2_queue_mgr.h>
11#include <d2/d2_update_mgr.h>
12#include <process/d_process.h>
13
14namespace isc {
15namespace d2 {
16
25public:
26
41
48 static const unsigned int QUEUE_RESTART_PERCENT;
49
52 static const unsigned int IO_SERVICE_RUN_TIME_USECS;
53
65 D2Process(const char* name, const asiolink::IOServicePtr& io_service);
66
76 virtual void init();
77
109 virtual void run();
110
137
162 bool check_only = false);
163
165 virtual ~D2Process();
166
167protected:
196 virtual void checkQueueStatus();
197
206 virtual void reconfigureQueueMgr();
207
228 virtual size_t runIO();
229
237 virtual bool canShutdown() const;
238
244 void setReconfQueueFlag(const bool value) {
245 reconf_queue_flag_ = value;
246 }
247
253 void setShutdownType(const ShutdownType& value) {
254 shutdown_type_ = value;
255 }
256
265
266public:
271
274 return (queue_mgr_);
275 }
276
279 return (update_mgr_);
280 }
281
283 bool getReconfQueueFlag() const {
284 return (reconf_queue_flag_);
285 }
286
291 return (shutdown_type_);
292 }
293
300 static const char* getShutdownTypeStr(const ShutdownType& type);
301
302private:
304 D2QueueMgrPtr queue_mgr_;
305
307 D2UpdateMgrPtr update_mgr_;
308
310 bool reconf_queue_flag_;
311
313 ShutdownType shutdown_type_;
314
316 isc::data::ConstElementPtr current_unix_control_socket_;
317
319 isc::data::ConstElementPtr current_http_control_socket_;
320};
321
323typedef boost::shared_ptr<D2Process> D2ProcessPtr;
324
325} // namespace isc::d2
326} // namespace isc
327
328#endif
D2Process(const char *name, const asiolink::IOServicePtr &io_service)
Constructor.
Definition d2_process.cc:62
static const unsigned int IO_SERVICE_RUN_TIME_USECS
Amount of time to allow the main IOSerivce to wait for ready handlers before timimg out in microsecon...
Definition d2_process.h:52
static const unsigned int QUEUE_RESTART_PERCENT
Defines the point at which to resume receiving requests.
Definition d2_process.h:48
void setShutdownType(const ShutdownType &value)
Sets the shutdown type to the given value.
Definition d2_process.h:253
virtual bool canShutdown() const
Indicates whether or not the process can perform a shutdown.
virtual void checkQueueStatus()
Monitors current queue manager state, takes action accordingly.
virtual ~D2Process()
Destructor.
const D2QueueMgrPtr & getD2QueueMgr() const
Returns a reference to the queue manager.
Definition d2_process.h:273
bool getReconfQueueFlag() const
Returns true if the queue manager should be reconfigured.
Definition d2_process.h:283
virtual void run()
Implements the process's event loop.
Definition d2_process.cc:99
const D2UpdateMgrPtr & getD2UpdateMgr() const
Returns a reference to the update manager.
Definition d2_process.h:278
virtual void init()
Called after instantiation to perform initialization unique to D2.
Definition d2_process.cc:84
D2CfgMgrPtr getD2CfgMgr()
Returns a pointer to the configuration manager.
virtual isc::data::ConstElementPtr configure(isc::data::ConstElementPtr config_set, bool check_only=false)
Processes the given configuration.
void setReconfQueueFlag(const bool value)
Sets queue reconfigure indicator to the given value.
Definition d2_process.h:244
ShutdownType getShutdownType() const
Returns the type of shutdown requested.
Definition d2_process.h:290
void reconfigureCommandChannel()
(Re-)Configure the command channel.
virtual void reconfigureQueueMgr()
Initializes then starts the queue manager.
ShutdownType
Defines the shutdown types supported by D2Process.
Definition d2_process.h:36
virtual isc::data::ConstElementPtr shutdown(isc::data::ConstElementPtr args)
Initiates the D2Process shutdown process.
static const char * getShutdownTypeStr(const ShutdownType &type)
Returns a text label for the given shutdown type.
virtual size_t runIO()
Allows IO processing to run until at least callback is invoked.
Application Process Interface.
Definition d_process.h:75
This file defines the class D2QueueMgr.
This file defines the class D2UpdateMgr.
boost::shared_ptr< D2CfgMgr > D2CfgMgrPtr
Defines a shared pointer to D2CfgMgr.
Definition d2_cfg_mgr.h:367
boost::shared_ptr< D2Process > D2ProcessPtr
Defines a shared pointer to D2Process.
Definition d2_process.h:323
boost::shared_ptr< D2UpdateMgr > D2UpdateMgrPtr
Defines a pointer to a D2UpdateMgr instance.
boost::shared_ptr< D2QueueMgr > D2QueueMgrPtr
Defines a pointer for manager instances.
boost::shared_ptr< const Element > ConstElementPtr
Definition data.h:29
Defines the logger used by the top-level component of kea-lfc.