Kea 2.7.7
isc::config::HttpCommandMgr Class Reference

HTTP Commands Manager implementation for the Kea servers. More...

#include <http_command_mgr.h>

+ Inheritance diagram for isc::config::HttpCommandMgr:

Public Member Functions

void addExternalSockets (bool use_external=true)
 Use external sockets flag.
 
void closeCommandSocket (HttpSocketInfoPtr info=HttpSocketInfoPtr(), bool remove=true)
 Close http control socket.
 
void closeCommandSockets ()
 Close http control sockets.
 
isc::http::ConstHttpListenerPtr getHttpListener (HttpSocketInfoPtr info=HttpSocketInfoPtr()) const
 Returns a const pointer to the HTTP listener.
 
void openCommandSocket (const isc::data::ConstElementPtr config)
 Open http control socket using configuration.
 
void openCommandSockets (const isc::data::ConstElementPtr config)
 Open http control sockets using configuration.
 
void setConnectionTimeout (const long timeout)
 Override default connection timeout.
 
void setIdleConnectionTimeout (const long timeout)
 Override default idle connection timeout.
 
void setIOService (const asiolink::IOServicePtr &io_service)
 Sets IO service to be used by the http command manager.
 

Static Public Member Functions

static HttpCommandMgrinstance ()
 HttpCommandMgr is a singleton class.
 

Detailed Description

HTTP Commands Manager implementation for the Kea servers.

Similar to UnixCommandMgr but using HTTP/HTTPS instead of UNIX sockets.

Definition at line 23 of file http_command_mgr.h.

Member Function Documentation

◆ addExternalSockets()

void isc::config::HttpCommandMgr::addExternalSockets ( bool use_external = true)

Use external sockets flag.

Add sockets as external sockets of the interface manager so available I/O on them makes a waiting select to return.

Parameters
use_externalTrue (default) add external sockets.

Definition at line 300 of file http_command_mgr.cc.

Referenced by isc::d2::D2Process::init().

◆ closeCommandSocket()

void isc::config::HttpCommandMgr::closeCommandSocket ( HttpSocketInfoPtr info = HttpSocketInfoPtr(),
bool remove = true )

Close http control socket.

Parameters
infoConfiguration information for the http control socket.
removeWhen true remove the listeners immediately.

Definition at line 315 of file http_command_mgr.cc.

References isc::db::info.

◆ closeCommandSockets()

◆ getHttpListener()

ConstHttpListenerPtr isc::config::HttpCommandMgr::getHttpListener ( HttpSocketInfoPtr info = HttpSocketInfoPtr()) const

Returns a const pointer to the HTTP listener.

Parameters
infoConfiguration information for the http control socket.
Returns
Const pointer to the currently used listener or null pointer if there is no listener.

Definition at line 325 of file http_command_mgr.cc.

References isc::db::info.

◆ instance()

◆ openCommandSocket()

void isc::config::HttpCommandMgr::openCommandSocket ( const isc::data::ConstElementPtr config)

Open http control socket using configuration.

Creates http/https listener, or reuses the existing one reapplying changes.

Parameters
configConfiguration information for the http control socket.

Definition at line 305 of file http_command_mgr.cc.

◆ openCommandSockets()

void isc::config::HttpCommandMgr::openCommandSockets ( const isc::data::ConstElementPtr config)

Open http control sockets using configuration.

Parameters
configConfiguration information for the http control sockets.

Definition at line 310 of file http_command_mgr.cc.

Referenced by isc::dhcp::configureCommandChannel(), and isc::d2::D2Process::reconfigureCommandChannel().

◆ setConnectionTimeout()

void isc::config::HttpCommandMgr::setConnectionTimeout ( const long timeout)

Override default connection timeout.

Parameters
timeoutNew connection timeout in milliseconds.

Definition at line 290 of file http_command_mgr.cc.

◆ setIdleConnectionTimeout()

void isc::config::HttpCommandMgr::setIdleConnectionTimeout ( const long timeout)

Override default idle connection timeout.

Parameters
timeoutNew connection timeout in milliseconds.

Definition at line 295 of file http_command_mgr.cc.

◆ setIOService()

void isc::config::HttpCommandMgr::setIOService ( const asiolink::IOServicePtr & io_service)

Sets IO service to be used by the http command manager.

The server should use this method to provide the Command Manager with the common IO service used by the server.

Parameters
io_servicePointer to the IO service.

Definition at line 285 of file http_command_mgr.cc.

Referenced by isc::dhcp::ControlledDhcpv4Srv::ControlledDhcpv4Srv(), isc::dhcp::ControlledDhcpv6Srv::ControlledDhcpv6Srv(), and isc::d2::D2Process::init().


The documentation for this class was generated from the following files: