isc::ha::HAConfig::PeerConfig Class Reference

HA peer configuration. More...

#include <ha_config.h>

Public Types
enum	Role { PRIMARY, SECONDARY, STANDBY, BACKUP }
	Server's role in the High Availability setup. More...

Public Member Functions
	PeerConfig ()
	Constructor. More...
std::string	getLogLabel () const
	Returns a string identifying a server used in logging. More...
std::string	getName () const
	Returns server name. More...
Role	getRole () const
	Returns server's role. More...
http::Url	getUrl () const
	Returns URL of the server's control channel. More...
bool	isAutoFailover () const
	Checks if the auto-failover function is enabled for the server. More...
void	setAutoFailover (const bool auto_failover)
	Enables/disables auto-failover function for the server. More...
void	setName (const std::string &name)
	Sets server name. More...
void	setRole (const std::string &role)
	Sets servers role. More...
void	setUrl (const http::Url &url)
	Sets server's URL. More...

Static Public Member Functions
static std::string	roleToString (const HAConfig::PeerConfig::Role &role)
	Returns role name. More...
static Role	stringToRole (const std::string &role)
	Decodes role provided as a string. More...

Detailed Description

HA peer configuration.

It holds configuration of one of the servers participating in the high availability configuration. It may represent configuration of this server or its partner.

Definition at line 47 of file ha_config.h.

Member Enumeration Documentation

Role

enum isc::ha::HAConfig::PeerConfig::Role

Server's role in the High Availability setup.

The following roles are supported:

• primary - server taking part in load balancing or hot standby setup, taking leadership over other servers. There must be exactly one primary server.
• secondary - server taking part in the load balancing setup. It is a slave server to primary. There must be exactly one secondary server in the load balancing setup.
• standby - standby server taking part in the hot standby operation. It doesn't run DHCP function until primary server crashes. There must be exactly one standby server in the hot standby setup.
• backup server - server receiving updates from other servers, but not performing any DHCP function until explicitly enabled to do so.

Enumerator
PRIMARY
SECONDARY
STANDBY
BACKUP

Definition at line 64 of file ha_config.h.

Constructor & Destructor Documentation

PeerConfig()

isc::ha::HAConfig::PeerConfig::PeerConfig

(

)

Constructor.

Definition at line 18 of file ha_config.cc.

Member Function Documentation

getLogLabel()

std::string isc::ha::HAConfig::PeerConfig::getLogLabel

(

)

const

Returns a string identifying a server used in logging.

The label is constructed from server name and server URL.

Returns

String identifying a server.

Definition at line 39 of file ha_config.cc.

getName()

std::string isc::ha::HAConfig::PeerConfig::getName ( ) const

inline

Returns server name.

Definition at line 75 of file ha_config.h.

getRole()

Role isc::ha::HAConfig::PeerConfig::getRole ( ) const

inline

Returns server's role.

Definition at line 105 of file ha_config.h.

getUrl()

http::Url isc::ha::HAConfig::PeerConfig::getUrl ( ) const

inline

Returns URL of the server's control channel.

Definition at line 86 of file ha_config.h.

isAutoFailover()

bool isc::ha::HAConfig::PeerConfig::isAutoFailover ( ) const

inline

Checks if the auto-failover function is enabled for the server.

Returns

true if auto failover function has been enabled for the server.

Definition at line 137 of file ha_config.h.

roleToString()

std::string isc::ha::HAConfig::PeerConfig::roleToString ( const HAConfig::PeerConfig::Role &  role )

static

Returns role name.

Parameters

role	Role which name should be returned.

Returns

Role name.

Definition at line 66 of file ha_config.cc.

References BACKUP, PRIMARY, SECONDARY, and STANDBY.

Referenced by isc::ha::HAService::HAService().

setAutoFailover()

void isc::ha::HAConfig::PeerConfig::setAutoFailover ( const bool  auto_failover )

inline

Enables/disables auto-failover function for the server.

Parameters

auto_failover

Boolean value indicating if auto-failover function should be enabled/disabled for the server.

Definition at line 145 of file ha_config.h.

setName()

void isc::ha::HAConfig::PeerConfig::setName

(

const std::string &

name

)

Sets server name.

Parameters

name	Server name.

Exceptions

BadValue

if the server name is empty.

Definition at line 23 of file ha_config.cc.

References isc_throw, name_, and isc::util::str::trim().

Here is the call graph for this function:

setRole()

void isc::ha::HAConfig::PeerConfig::setRole

(

const std::string &

role

)

Sets servers role.

The following are the supported roles in the textual form:

• primary,
• secondary,
• standby
• backup

Parameters

role	Server role in the textual form.

Definition at line 34 of file ha_config.cc.

setUrl()

void isc::ha::HAConfig::PeerConfig::setUrl ( const http::Url &  url )

inline

Sets server's URL.

Parameters

url	URL value.

Definition at line 93 of file ha_config.h.

stringToRole()

HAConfig::PeerConfig::Role isc::ha::HAConfig::PeerConfig::stringToRole ( const std::string &  role )

static

Decodes role provided as a string.

Parameters

role	Role as string.

Returns

Server role converted from string.

Exceptions

BadValue

if the specified role is unsupported.

Definition at line 46 of file ha_config.cc.

References BACKUP, isc_throw, PRIMARY, SECONDARY, and STANDBY.

---

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

• ha_config.h
• ha_config.cc