Kea 2.7.0
isc::ha::HAConfig::StateConfig Class Reference

Configuration specific to a single HA state. More...

#include <ha_config.h>

Public Member Functions

 StateConfig (const int state)
 Constructor.
 
util::StatePausing getPausing () const
 Returns pausing mode for the given state.
 
int getState () const
 Returns identifier of the state.
 
void setPausing (const std::string &pausing)
 Sets pausing mode for the given state.
 

Static Public Member Functions

static std::string pausingToString (const util::StatePausing &pausing)
 Returns pausing mode in the textual form.
 
static util::StatePausing stringToPausing (const std::string &pausing)
 Converts pausing mode from the textual form.
 

Detailed Description

Configuration specific to a single HA state.

Definition at line 248 of file ha_config.h.

Constructor & Destructor Documentation

◆ StateConfig()

isc::ha::HAConfig::StateConfig::StateConfig ( const int state)
explicit

Constructor.

Parameters
statestate identifier.

Definition at line 107 of file ha_config.cc.

Member Function Documentation

◆ getPausing()

util::StatePausing isc::ha::HAConfig::StateConfig::getPausing ( ) const
inline

Returns pausing mode for the given state.

Definition at line 262 of file ha_config.h.

◆ getState()

int isc::ha::HAConfig::StateConfig::getState ( ) const
inline

Returns identifier of the state.

Definition at line 257 of file ha_config.h.

◆ pausingToString()

std::string isc::ha::HAConfig::StateConfig::pausingToString ( const util::StatePausing & pausing)
static

Returns pausing mode in the textual form.

Parameters
pausingpausing mode.

Definition at line 132 of file ha_config.cc.

References isc_throw, isc::util::STATE_PAUSE_ALWAYS, isc::util::STATE_PAUSE_NEVER, and isc::util::STATE_PAUSE_ONCE.

◆ setPausing()

void isc::ha::HAConfig::StateConfig::setPausing ( const std::string & pausing)

Sets pausing mode for the given state.

Parameters
pausingnew pausing mode in the textual form. Supported values are: always, never, once.

Definition at line 112 of file ha_config.cc.

◆ stringToPausing()

StatePausing isc::ha::HAConfig::StateConfig::stringToPausing ( const std::string & pausing)
static

Converts pausing mode from the textual form.

Parameters
pausingpausing mode in the textual form. Supported values are: always, never, once.

Definition at line 117 of file ha_config.cc.

References isc_throw, isc::util::STATE_PAUSE_ALWAYS, isc::util::STATE_PAUSE_NEVER, and isc::util::STATE_PAUSE_ONCE.


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