Kea 2.7.7
isc::config::UnixCommandConfig Class Reference

UNIX command config aka UNIX control socket info class. More...

#include <unix_command_config.h>

+ Inheritance diagram for isc::config::UnixCommandConfig:

Public Member Functions

 UnixCommandConfig (isc::data::ConstElementPtr config)
 Constructor.
 
 ~UnixCommandConfig ()=default
 Virtual destructor.
 
std::string getLockName ()
 Returns the lock file name.
 
std::string getSocketName () const
 Returns socket name.
 
std::string getSocketType () const
 Returns socket type.
 
void setSocketName (const std::string &socket_name)
 Sets socket name.
 
void setSocketType (const std::string &socket_type)
 Sets socket type.
 
virtual isc::data::ElementPtr toElement () const
 Unparse a configuration object.
 
- Public Member Functions inherited from isc::data::UserContext
void contextToElement (data::ElementPtr map) const
 Merge unparse a user_context object.
 
data::ConstElementPtr getContext () const
 Returns const pointer to the user context.
 
void setContext (const data::ConstElementPtr &ctx)
 Sets user context.
 
- Public Member Functions inherited from isc::data::CfgToElement
virtual ~CfgToElement ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr toElement (data::ConstElementPtr map)
 Copy an Element map.
 
- Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr user_context_
 Pointer to the user context (may be NULL)
 

Detailed Description

UNIX command config aka UNIX control socket info class.

Definition at line 21 of file unix_command_config.h.

Constructor & Destructor Documentation

◆ UnixCommandConfig()

isc::config::UnixCommandConfig::UnixCommandConfig ( isc::data::ConstElementPtr config)

Constructor.

Parameters
configPointer to the configuration to parse.

Definition at line 25 of file unix_command_config.cc.

References if(), isc_throw, isc::data::Element::map, isc::data::UserContext::setContext(), and isc::data::Element::string.

+ Here is the call graph for this function:

◆ ~UnixCommandConfig()

isc::config::UnixCommandConfig::~UnixCommandConfig ( )
default

Virtual destructor.

Member Function Documentation

◆ getLockName()

std::string isc::config::UnixCommandConfig::getLockName ( )
inline

Returns the lock file name.

Definition at line 61 of file unix_command_config.h.

◆ getSocketName()

std::string isc::config::UnixCommandConfig::getSocketName ( ) const
inline

Returns socket name.

Returns
The socket name.

Definition at line 49 of file unix_command_config.h.

◆ getSocketType()

std::string isc::config::UnixCommandConfig::getSocketType ( ) const
inline

Returns socket type.

Returns
The socket type ("unix").

Definition at line 35 of file unix_command_config.h.

◆ setSocketName()

void isc::config::UnixCommandConfig::setSocketName ( const std::string & socket_name)
inline

Sets socket name.

Parameters
socket_nameThe new socket name.

Definition at line 56 of file unix_command_config.h.

◆ setSocketType()

void isc::config::UnixCommandConfig::setSocketType ( const std::string & socket_type)
inline

Sets socket type.

Parameters
socket_typeThe new socket type (should be "unix").

Definition at line 42 of file unix_command_config.h.

◆ toElement()

ElementPtr isc::config::UnixCommandConfig::toElement ( ) const
virtual

Unparse a configuration object.

Returns
A pointer to configuration.

Implements isc::data::CfgToElement.

Definition at line 72 of file unix_command_config.cc.

References isc::data::UserContext::contextToElement(), isc::data::Element::create(), and isc::data::Element::createMap().

+ Here is the call graph for this function:

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