Kea 2.5.8
d2_process.h
Go to the documentation of this file.
1// Copyright (C) 2013-2019 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
39 SD_NOW
40 };
41
48 static const unsigned int QUEUE_RESTART_PERCENT;
49
61 D2Process(const char* name, const asiolink::IOServicePtr& io_service);
62
72 virtual void init();
73
105 virtual void run();
106
133
158 bool check_only = false);
159
161 virtual ~D2Process();
162
163protected:
192 virtual void checkQueueStatus();
193
202 virtual void reconfigureQueueMgr();
203
224 virtual size_t runIO();
225
233 virtual bool canShutdown() const;
234
240 void setReconfQueueFlag(const bool value) {
241 reconf_queue_flag_ = value;
242 }
243
249 void setShutdownType(const ShutdownType& value) {
250 shutdown_type_ = value;
251 }
252
261
262public:
267
270 return (queue_mgr_);
271 }
272
275 return (update_mgr_);
276 }
277
279 bool getReconfQueueFlag() const {
280 return (reconf_queue_flag_);
281 }
282
287 return (shutdown_type_);
288 }
289
296 static const char* getShutdownTypeStr(const ShutdownType& type);
297
298private:
300 D2QueueMgrPtr queue_mgr_;
301
303 D2UpdateMgrPtr update_mgr_;
304
306 bool reconf_queue_flag_;
307
309 ShutdownType shutdown_type_;
310
312 isc::data::ConstElementPtr current_control_socket_;
313
314};
315
317typedef boost::shared_ptr<D2Process> D2ProcessPtr;
318
319} // namespace isc::d2
320} // namespace isc
321
322#endif
DHCP-DDNS Application Process.
Definition: d2_process.h:24
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:249
virtual bool canShutdown() const
Indicates whether or not the process can perform a shutdown.
Definition: d2_process.cc:156
virtual void checkQueueStatus()
Monitors current queue manager state, takes action accordingly.
Definition: d2_process.cc:311
virtual ~D2Process()
Destructor.
Definition: d2_process.cc:441
const D2QueueMgrPtr & getD2QueueMgr() const
Returns a reference to the queue manager.
Definition: d2_process.h:269
bool getReconfQueueFlag() const
Returns true if the queue manager should be reconfigured.
Definition: d2_process.h:279
virtual void run()
Implements the process's event loop.
Definition: d2_process.cc:80
const D2UpdateMgrPtr & getD2UpdateMgr() const
Returns a reference to the update manager.
Definition: d2_process.h:274
virtual void init()
Called after instantiation to perform initialization unique to D2.
Definition: d2_process.cc:74
D2CfgMgrPtr getD2CfgMgr()
Returns a pointer to the configuration manager.
Definition: d2_process.cc:453
virtual isc::data::ConstElementPtr configure(isc::data::ConstElementPtr config_set, bool check_only=false)
Processes the given configuration.
Definition: d2_process.cc:238
void setReconfQueueFlag(const bool value)
Sets queue reconfigure indicator to the given value.
Definition: d2_process.h:240
ShutdownType getShutdownType() const
Returns the type of shutdown requested.
Definition: d2_process.h:286
void reconfigureCommandChannel()
(Re-)Configure the command channel.
Definition: d2_process.cc:481
virtual void reconfigureQueueMgr()
Initializes then starts the queue manager.
Definition: d2_process.cc:388
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.
Definition: d2_process.cc:201
static const char * getShutdownTypeStr(const ShutdownType &type)
Returns a text label for the given shutdown type.
Definition: d2_process.cc:460
virtual size_t runIO()
Allows IO processing to run until at least callback is invoked.
Definition: d2_process.cc:131
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:334
boost::shared_ptr< D2Process > D2ProcessPtr
Defines a shared pointer to D2Process.
Definition: d2_process.h:317
boost::shared_ptr< D2UpdateMgr > D2UpdateMgrPtr
Defines a pointer to a D2UpdateMgr instance.
boost::shared_ptr< D2QueueMgr > D2QueueMgrPtr
Defines a pointer for manager instances.
Definition: d2_queue_mgr.h:340
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:29
Defines the logger used by the top-level component of kea-lfc.