isc::ping_check::PingCheckConfig Class Reference

Houses the Ping check configuration parameters for a single scope (e.g. More...

#include <ping_check_config.h>

Public Member Functions
	PingCheckConfig ()
	Constructor.
	~PingCheckConfig ()=default
	Destructor.
bool	getEnablePingCheck () const
	Fetches the value of enable-ping-check.
uint32_t	getMinPingRequests () const
	Fetches the value of min-ping-requests.
uint32_t	getPingChannelThreads () const
	Fetches the value of ping-channel-threads.
uint32_t	getPingClttSecs () const
	Fetches the value of ping-cltt-secs.
uint32_t	getReplyTimeout () const
	Fetches the value of reply-timeout.
void	parse (data::ConstElementPtr config)
	Extracts member values from an Element::map.
void	setEnablePingCheck (bool value)
	Sets the value of enable-ping-check.
void	setMinPingRequests (uint32_t value)
	Sets the value of min-ping-requests.
void	setPingChannelThreads (uint32_t value)
	Sets the value of ping-channel-threads.
void	setPingClttSecs (uint32_t value)
	Sets the value of ping-cltt-secs.
void	setReplyTimeout (uint32_t value)
	Sets the value of reply-timeout.

Static Public Attributes
static const data::SimpleKeywords	CONFIG_KEYWORDS
	List of valid parameters and expected types.

Detailed Description

Houses the Ping check configuration parameters for a single scope (e.g.

global, subnet...);

Definition at line 18 of file ping_check_config.h.

Constructor & Destructor Documentation

PingCheckConfig()

isc::ping_check::PingCheckConfig::PingCheckConfig

(

)

Constructor.

Definition at line 28 of file ping_check_config.cc.

Referenced by isc::ping_check::PingCheckMgr::PingCheckMgr(), isc::ping_check::PingCheckMgr::configure(), parse(), and isc::ping_check::ConfigCache::parseAndCacheConfig().

~PingCheckConfig()

isc::ping_check::PingCheckConfig::~PingCheckConfig ( )

default

Destructor.

References parse().

Here is the call graph for this function:

Member Function Documentation

getEnablePingCheck()

bool isc::ping_check::PingCheckConfig::getEnablePingCheck ( ) const

inline

Fetches the value of enable-ping-check.

Returns

boolean value of enable-ping-check

Definition at line 39 of file ping_check_config.h.

getMinPingRequests()

uint32_t isc::ping_check::PingCheckConfig::getMinPingRequests ( ) const

inline

Fetches the value of min-ping-requests.

Returns

integer value of min-ping-requests

Definition at line 53 of file ping_check_config.h.

getPingChannelThreads()

uint32_t isc::ping_check::PingCheckConfig::getPingChannelThreads ( ) const

inline

Fetches the value of ping-channel-threads.

Returns

integer value of ping-channel-threads

Definition at line 95 of file ping_check_config.h.

getPingClttSecs()

uint32_t isc::ping_check::PingCheckConfig::getPingClttSecs ( ) const

inline

Fetches the value of ping-cltt-secs.

Returns

integer value of ping-cltt-secs

Definition at line 81 of file ping_check_config.h.

getReplyTimeout()

uint32_t isc::ping_check::PingCheckConfig::getReplyTimeout ( ) const

inline

Fetches the value of reply-timeout.

Returns

integer value of reply-timeout

Definition at line 67 of file ping_check_config.h.

parse()

void isc::ping_check::PingCheckConfig::parse

(

data::ConstElementPtr

config

)

Extracts member values from an Element::map.

Parameters

config

map of configuration parameters

Exceptions

BadValue

if invalid values are detected.

Definition at line 37 of file ping_check_config.cc.

References PingCheckConfig(), isc::data::SimpleParser::checkKeywords(), CONFIG_KEYWORDS, and isc_throw.

Referenced by ~PingCheckConfig().

Here is the call graph for this function:

setEnablePingCheck()

void isc::ping_check::PingCheckConfig::setEnablePingCheck ( bool value )

inline

Sets the value of enable-ping-check.

Parameters

value

new value for enable-ping-check

Definition at line 46 of file ping_check_config.h.

setMinPingRequests()

void isc::ping_check::PingCheckConfig::setMinPingRequests ( uint32_t value )

inline

Sets the value of min-ping-requests.

Parameters

value

new value for min-ping-requests

Definition at line 60 of file ping_check_config.h.

setPingChannelThreads()

void isc::ping_check::PingCheckConfig::setPingChannelThreads ( uint32_t value )

inline

Sets the value of ping-channel-threads.

Parameters

value

new value for ping-channel-threads

Definition at line 102 of file ping_check_config.h.

setPingClttSecs()

void isc::ping_check::PingCheckConfig::setPingClttSecs ( uint32_t value )

inline

Sets the value of ping-cltt-secs.

Parameters

value

new value for ping-cltt-secs

Definition at line 88 of file ping_check_config.h.

setReplyTimeout()

void isc::ping_check::PingCheckConfig::setReplyTimeout ( uint32_t value )

inline

Sets the value of reply-timeout.

Parameters

value

new value for reply-timeout

Definition at line 74 of file ping_check_config.h.

Member Data Documentation

CONFIG_KEYWORDS

const data::SimpleKeywords isc::ping_check::PingCheckConfig::CONFIG_KEYWORDS

static

Initial value:

                                 =
{
    { "enable-ping-check",      Element::boolean },
    { "min-ping-requests",      Element::integer },
    { "reply-timeout",          Element::integer },
    { "ping-cltt-secs",         Element::integer},
    { "ping-channel-threads",   Element::integer}
}

List of valid parameters and expected types.

Definition at line 21 of file ping_check_config.h.

Referenced by parse().

---

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

• ping_check_config.h
• ping_check_config.cc