Storage for High Availability configuration. More...

#include <ha_config.h>

Classes
class	PeerConfig
	HA peer configuration. More...

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

class	StateMachineConfig
	State machine configuration information. More...

Public Types
enum	HAMode { LOAD_BALANCING, HOT_STANDBY }
	Mode of operation. More...

typedef std::map< std::string, PeerConfigPtr >	PeerConfigMap
	Map of the servers' configurations. More...

typedef boost::shared_ptr< PeerConfig >	PeerConfigPtr
	Pointer to the server's configuration. More...

typedef boost::shared_ptr< StateConfig >	StateConfigPtr
	Pointer to the state configuration. More...

typedef boost::shared_ptr< StateMachineConfig >	StateMachineConfigPtr
	Pointer to a state machine configuration. More...

Public Member Functions
	HAConfig ()
	Constructor. More...

bool	amSendingLeaseUpdates () const
	Returns boolean flag indicating whether lease updates should be sent to the partner. More...

bool	amSyncingLeases () const
	Returns boolean flag indicating whether the active servers should synchronize their lease databases upon startup. More...

PeerConfigMap	getAllServersConfig () const
	Returns configurations of all servers. More...

PeerConfigPtr	getFailoverPeerConfig () const
	Returns configuration of the partner which takes part in failover. More...

HAMode	getHAMode () const
	Returns mode of operation. More...

uint32_t	getHeartbeatDelay () const
	Returns heartbeat delay in milliseconds. More...

uint32_t	getMaxAckDelay () const
	Returns maximum time for a client trying to communicate with DHCP server to complete the transaction. More...

uint32_t	getMaxResponseDelay () const
	Returns max response delay. More...

uint32_t	getMaxUnackedClients () const
	Returns maximum number of clients which may fail to communicate with the DHCP server before entering partner down state. More...

PeerConfigMap	getOtherServersConfig () const
	Returns configuration of other servers. More...

PeerConfigPtr	getPeerConfig (const std::string &name) const
	Returns configuration of the specified server. More...

StateMachineConfigPtr	getStateMachineConfig () const
	Returns state machine configuration. More...

uint32_t	getSyncPageLimit () const
	Returns maximum number of leases per page to be fetched during database synchronization. More...

uint32_t	getSyncTimeout () const
	Returns timeout for lease database synchronization. More...

PeerConfigPtr	getThisServerConfig () const
	Returns configuration of this server. More...

std::string	getThisServerName () const
	Returns name of this server. More...

PeerConfigPtr	selectNextPeerConfig (const std::string &name)
	Creates and returns pointer to the new peer's configuration. More...

void	setHAMode (const std::string &ha_mode)
	Sets new mode of operation. More...

void	setHeartbeatDelay (const uint32_t heartbeat_delay)
	Sets new heartbeat delay in milliseconds. More...

void	setMaxAckDelay (const uint32_t max_ack_delay)
	Sets maximum time for a client trying to communicate with DHCP server to completed the transaction. More...

void	setMaxResponseDelay (const uint32_t max_response_delay)
	Sets new max response delay. More...

void	setMaxUnackedClients (const uint32_t max_unacked_clients)
	Set maximum number of clients which may fail to communicate with the DHCP server before entering partner down state. More...

void	setSendLeaseUpdates (const bool send_lease_updates)
	Sets boolean flag indicating whether lease updates should be sent to the partner. More...

void	setSyncLeases (const bool sync_leases)
	Sets boolean flag indicating whether the active servers should synchronize their lease databases upon startup. More...

void	setSyncPageLimit (const uint32_t sync_page_limit)
	Sets new page limit size for leases fetched from the partner during database synchronization. More...

void	setSyncTimeout (const uint32_t sync_timeout)
	Sets new lease database syncing timeout in milliseconds. More...

void	setThisServerName (const std::string &this_server_name)
	Sets name of this server. More...

void	validate () const
	Validates configuration. More...

Static Public Member Functions
static std::string	HAModeToString (const HAMode &ha_mode)
	Returns HA mode name. More...

static HAMode	stringToHAMode (const std::string &ha_mode)
	Decodes HA mode provided as string. More...

Public Attributes
HAMode	ha_mode_
	Mode of operation. More...

uint32_t	heartbeat_delay_
	Heartbeat delay in milliseconds. More...

uint32_t	max_ack_delay_
	Maximum DHCP message ack delay. More...

uint32_t	max_response_delay_
	Max delay in response to heartbeats. More...

uint32_t	max_unacked_clients_
	Maximum number of unacked clients. More...

PeerConfigMap	peers_
	Map of peers' configurations. More...

bool	send_lease_updates_
	Send lease updates to partner? More...

StateMachineConfigPtr	state_machine_
	State machine configuration. More...

bool	sync_leases_
	Synchronize databases on startup? More...

uint32_t	sync_page_limit_
	Page size limit while synchronizing leases. More...

uint32_t	sync_timeout_
	Timeout for syncing lease database (ms) More...

std::string	this_server_name_
	This server name. More...

Detailed Description

Storage for High Availability configuration.

Definition at line 29 of file ha_config.h.

Member Typedef Documentation

◆ PeerConfigMap

typedef std::map<std::string, PeerConfigPtr> isc::ha::HAConfig::PeerConfigMap

Map of the servers' configurations.

Definition at line 162 of file ha_config.h.

◆ PeerConfigPtr

typedef boost::shared_ptr<PeerConfig> isc::ha::HAConfig::PeerConfigPtr

Pointer to the server's configuration.

Definition at line 159 of file ha_config.h.

◆ StateConfigPtr

typedef boost::shared_ptr<StateConfig> isc::ha::HAConfig::StateConfigPtr

Pointer to the state configuration.

Definition at line 211 of file ha_config.h.

◆ StateMachineConfigPtr

typedef boost::shared_ptr<StateMachineConfig> isc::ha::HAConfig::StateMachineConfigPtr

Pointer to a state machine configuration.

Definition at line 243 of file ha_config.h.

Member Enumeration Documentation

◆ HAMode

enum isc::ha::HAConfig::HAMode

Mode of operation.

Currently supported modes are:

load balancing
hot standby

Enumerator
LOAD_BALANCING
HOT_STANDBY

Definition at line 37 of file ha_config.h.

Constructor & Destructor Documentation

◆ HAConfig()

isc::ha::HAConfig::HAConfig ( )

Constructor.

Definition at line 140 of file ha_config.cc.

Member Function Documentation

◆ amSendingLeaseUpdates()

bool isc::ha::HAConfig::amSendingLeaseUpdates ( ) const

inline

Returns boolean flag indicating whether lease updates should be sent to the partner.

Definition at line 301 of file ha_config.h.

References send_lease_updates_.

◆ amSyncingLeases()

bool isc::ha::HAConfig::amSyncingLeases ( ) const

inline

Returns boolean flag indicating whether the active servers should synchronize their lease databases upon startup.

Definition at line 320 of file ha_config.h.

References sync_leases_.

◆ getAllServersConfig()

PeerConfigMap isc::ha::HAConfig::getAllServersConfig ( ) const

inline

Returns configurations of all servers.

Returns: Map of pointers to the servers' configurations.

Definition at line 477 of file ha_config.h.

References peers_.

◆ getFailoverPeerConfig()

HAConfig::PeerConfigPtr isc::ha::HAConfig::getFailoverPeerConfig ( ) const

Returns configuration of the partner which takes part in failover.

The server for which the configuration is returned is a "primary", "secondary" or "standby". This method is typically used to locate the configuration of the server to which heartbeat command is to be sent.

Returns: Pointer to the partner's configuration.

Exceptions

InvalidOperation if there is no suitable configuration found.

Definition at line 218 of file ha_config.cc.

References isc::ha::HAConfig::PeerConfig::BACKUP, getOtherServersConfig(), getThisServerName(), and isc_throw.

Here is the call graph for this function:

◆ getHAMode()

HAMode isc::ha::HAConfig::getHAMode ( ) const

inline

Returns mode of operation.

Definition at line 272 of file ha_config.h.

References ha_mode_.

◆ getHeartbeatDelay()

uint32_t isc::ha::HAConfig::getHeartbeatDelay ( ) const

inline

Returns heartbeat delay in milliseconds.

This value indicates the delay in sending a heartbeat command after last heartbeat or some other command to the partner. A value of zero disables the heartbeat.

Returns: Heartbeat delay in milliseconds.

Definition at line 374 of file ha_config.h.

References heartbeat_delay_.

◆ getMaxAckDelay()

uint32_t isc::ha::HAConfig::getMaxAckDelay ( ) const

inline

Returns maximum time for a client trying to communicate with DHCP server to complete the transaction.

Returns: Maximum delay in milliseconds.

Definition at line 413 of file ha_config.h.

References max_ack_delay_.

◆ getMaxResponseDelay()

uint32_t isc::ha::HAConfig::getMaxResponseDelay ( ) const

inline

Returns max response delay.

Max response delay is the maximum time that the server is waiting for its partner to respond to the heartbeats (and lease updates) before it assumes the communications interrupted state.

Definition at line 394 of file ha_config.h.

References max_response_delay_.

◆ getMaxUnackedClients()

uint32_t isc::ha::HAConfig::getMaxUnackedClients ( ) const

inline

Returns maximum number of clients which may fail to communicate with the DHCP server before entering partner down state.

Returns: Maximum number of clients.

Definition at line 429 of file ha_config.h.

References max_unacked_clients_.

◆ getOtherServersConfig()

HAConfig::PeerConfigMap isc::ha::HAConfig::getOtherServersConfig ( ) const

Returns configuration of other servers.

Returns a map of pointers to the configuration of all servers except this.

Returns: Map of pointers to the servers' configurations.

Definition at line 236 of file ha_config.cc.

References isc::data::copy(), getThisServerName(), and peers_.

Referenced by getFailoverPeerConfig().

Here is the call graph for this function:

◆ getPeerConfig()

HAConfig::PeerConfigPtr isc::ha::HAConfig::getPeerConfig ( const std::string & name ) const

Returns configuration of the specified server.

Parameters

name	Server name.

Returns: Pointer to the partner's configuration.

Exceptions

InvalidOperation if there is no suitable configuration found.

Definition at line 208 of file ha_config.cc.

References isc_throw, and peers_.

Referenced by getThisServerConfig().

◆ getStateMachineConfig()

StateMachineConfigPtr isc::ha::HAConfig::getStateMachineConfig ( ) const

inline

Returns state machine configuration.

Returns: Pointer to the state machine configuration.

Definition at line 484 of file ha_config.h.

References state_machine_.

◆ getSyncPageLimit()

uint32_t isc::ha::HAConfig::getSyncPageLimit ( ) const

inline

Returns maximum number of leases per page to be fetched during database synchronization.

Returns: Maximum number of leases per page.

Definition at line 355 of file ha_config.h.

References sync_page_limit_.

◆ getSyncTimeout()

uint32_t isc::ha::HAConfig::getSyncTimeout ( ) const

inline

Returns timeout for lease database synchronization.

Returns: Timeout in milliseconds.

Definition at line 340 of file ha_config.h.

References sync_timeout_.

◆ getThisServerConfig()

HAConfig::PeerConfigPtr isc::ha::HAConfig::getThisServerConfig ( ) const

Returns configuration of this server.

Returns: Pointer to the configuration of this server.

Definition at line 231 of file ha_config.cc.

References getPeerConfig(), and getThisServerName().

Here is the call graph for this function:

◆ getThisServerName()

std::string isc::ha::HAConfig::getThisServerName ( ) const

inline

Returns name of this server.

Definition at line 261 of file ha_config.h.

References this_server_name_.

Referenced by getFailoverPeerConfig(), getOtherServersConfig(), getThisServerConfig(), and validate().

◆ HAModeToString()

std::string isc::ha::HAConfig::HAModeToString ( const HAMode & ha_mode )

static

Returns HA mode name.

Parameters

ha_mode HA mode which name should be returned.

Returns: HA mode name.

Definition at line 195 of file ha_config.cc.

References HOT_STANDBY, and LOAD_BALANCING.

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

◆ selectNextPeerConfig()

HAConfig::PeerConfigPtr isc::ha::HAConfig::selectNextPeerConfig ( const std::string & name )

Creates and returns pointer to the new peer's configuration.

This method is called during peers configuration parsing, when the parser starts reading configuration of the next peer on the list. It will store parsed values into this object.

Parameters

name	Name of the server for which new configuration should be created.

Exceptions

BadValue if there is already a configuration for the given server name.

Definition at line 148 of file ha_config.cc.

References isc_throw, and peers_.

◆ setHAMode()

void isc::ha::HAConfig::setHAMode ( const std::string & ha_mode )

Sets new mode of operation.

The following modes of operation are supported:

load-balancing
hot-standby

Parameters

ha_mode High Availability mode operation in textual form.

Exceptions

BadValue if non-supported mode of operation has been specified.

Definition at line 178 of file ha_config.cc.

References ha_mode_, and stringToHAMode().

Here is the call graph for this function:

◆ setHeartbeatDelay()

void isc::ha::HAConfig::setHeartbeatDelay ( const uint32_t heartbeat_delay )

inline

Sets new heartbeat delay in milliseconds.

This value indicates the delay in sending a heartbeat command after last heartbeat or some other command to the partner. A value of zero disables the heartbeat.

Parameters

heartbeat_delay new heartbeat delay value.

Definition at line 385 of file ha_config.h.

References heartbeat_delay_.

◆ setMaxAckDelay()

void isc::ha::HAConfig::setMaxAckDelay ( const uint32_t max_ack_delay )

inline

Sets maximum time for a client trying to communicate with DHCP server to completed the transaction.

Parameters

max_ack_delay maximum time in milliseconds.

Definition at line 421 of file ha_config.h.

References max_ack_delay_.

◆ setMaxResponseDelay()

void isc::ha::HAConfig::setMaxResponseDelay ( const uint32_t max_response_delay )

inline

Sets new max response delay.

Max response delay is the maximum time that the server is waiting for its partner to respond to the heartbeats (and lease updates) before it assumes the communications interrupted state.

Parameters

max_response_delay

Definition at line 405 of file ha_config.h.

References max_response_delay_.

◆ setMaxUnackedClients()

void isc::ha::HAConfig::setMaxUnackedClients ( const uint32_t max_unacked_clients )

inline

Set maximum number of clients which may fail to communicate with the DHCP server before entering partner down state.

Parameters

max_unacked_clients maximum number of clients.

Definition at line 437 of file ha_config.h.

References max_unacked_clients_.

◆ setSendLeaseUpdates()

void isc::ha::HAConfig::setSendLeaseUpdates ( const bool send_lease_updates )

inline

Sets boolean flag indicating whether lease updates should be sent to the partner.

Disabling lease updates is useful in cases when lease database replication is enabled, e.g. MySQL database replication. The database itself takes care of updating the backup database with new data. Sending lease updates is enabled by default.

Parameters

send_lease_updates new value for the flag.

Definition at line 314 of file ha_config.h.

References send_lease_updates_.

◆ setSyncLeases()

void isc::ha::HAConfig::setSyncLeases ( const bool sync_leases )

inline

Sets boolean flag indicating whether the active servers should synchronize their lease databases upon startup.

Disabling lease database synchronization is useful in cases when lease database replication is enabled. See the description of the setSendLeaseUpdates. Lease database synchronization is enabled by default on active HA servers.

Parameters

sync_leases new value for the flag.

Definition at line 333 of file ha_config.h.

References sync_leases_.

◆ setSyncPageLimit()

void isc::ha::HAConfig::setSyncPageLimit ( const uint32_t sync_page_limit )

inline

Sets new page limit size for leases fetched from the partner during database synchronization.

Parameters

sync_page_limit New page limit value.

Definition at line 363 of file ha_config.h.

References sync_page_limit_.

◆ setSyncTimeout()

void isc::ha::HAConfig::setSyncTimeout ( const uint32_t sync_timeout )

inline

Sets new lease database syncing timeout in milliseconds.

Parameters

sync_timeout new timeout for lease database synchornization.

Definition at line 347 of file ha_config.h.

References sync_timeout_.

◆ setThisServerName()

void isc::ha::HAConfig::setThisServerName ( const std::string & this_server_name )

Sets name of this server.

Parameters

this_server_name This server name.

Exceptions

BadValue If the provided server name is empty.

Definition at line 166 of file ha_config.cc.

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

Here is the call graph for this function:

◆ stringToHAMode()

HAConfig::HAMode isc::ha::HAConfig::stringToHAMode ( const std::string & ha_mode )

static

Decodes HA mode provided as string.

Parameters

ha_mode HA mode as string.

Returns: HA mode converted from string.

Exceptions

BadValue if specified HA mode name is unsupported.

Definition at line 183 of file ha_config.cc.

References HOT_STANDBY, isc_throw, and LOAD_BALANCING.

Referenced by setHAMode().

◆ validate()

void isc::ha::HAConfig::validate ( ) const

Validates configuration.

Exceptions

HAConfigValidationError if configuration is invalid.

Definition at line 243 of file ha_config.cc.

References getThisServerName(), ha_mode_, HOT_STANDBY, isc_throw, LOAD_BALANCING, peers_, isc::ha::HAConfig::PeerConfig::PRIMARY, isc::ha::HAConfig::PeerConfig::SECONDARY, and isc::ha::HAConfig::PeerConfig::STANDBY.

Here is the call graph for this function:

Member Data Documentation

◆ ha_mode_

HAMode isc::ha::HAConfig::ha_mode_

Mode of operation.

Definition at line 494 of file ha_config.h.

Referenced by getHAMode(), setHAMode(), and validate().

◆ heartbeat_delay_

uint32_t isc::ha::HAConfig::heartbeat_delay_

Heartbeat delay in milliseconds.

Definition at line 500 of file ha_config.h.

Referenced by getHeartbeatDelay(), and setHeartbeatDelay().

◆ max_ack_delay_

uint32_t isc::ha::HAConfig::max_ack_delay_

Maximum DHCP message ack delay.

Definition at line 502 of file ha_config.h.

Referenced by getMaxAckDelay(), and setMaxAckDelay().

◆ max_response_delay_

uint32_t isc::ha::HAConfig::max_response_delay_

Max delay in response to heartbeats.

Definition at line 501 of file ha_config.h.

Referenced by getMaxResponseDelay(), and setMaxResponseDelay().

◆ max_unacked_clients_

uint32_t isc::ha::HAConfig::max_unacked_clients_

Maximum number of unacked clients.

Definition at line 503 of file ha_config.h.

Referenced by getMaxUnackedClients(), and setMaxUnackedClients().

◆ peers_

PeerConfigMap isc::ha::HAConfig::peers_

Map of peers' configurations.

Definition at line 504 of file ha_config.h.

Referenced by getAllServersConfig(), getOtherServersConfig(), getPeerConfig(), selectNextPeerConfig(), and validate().

◆ send_lease_updates_

bool isc::ha::HAConfig::send_lease_updates_

Send lease updates to partner?

Definition at line 495 of file ha_config.h.

Referenced by amSendingLeaseUpdates(), and setSendLeaseUpdates().

◆ state_machine_

StateMachineConfigPtr isc::ha::HAConfig::state_machine_

State machine configuration.

Definition at line 505 of file ha_config.h.

Referenced by getStateMachineConfig().

◆ sync_leases_

bool isc::ha::HAConfig::sync_leases_

Synchronize databases on startup?

Definition at line 496 of file ha_config.h.

Referenced by amSyncingLeases(), and setSyncLeases().

◆ sync_page_limit_

uint32_t isc::ha::HAConfig::sync_page_limit_

Page size limit while synchronizing leases.

Definition at line 498 of file ha_config.h.

Referenced by getSyncPageLimit(), and setSyncPageLimit().

◆ sync_timeout_

uint32_t isc::ha::HAConfig::sync_timeout_

Timeout for syncing lease database (ms)

Definition at line 497 of file ha_config.h.

Referenced by getSyncTimeout(), and setSyncTimeout().

◆ this_server_name_

std::string isc::ha::HAConfig::this_server_name_

This server name.

Definition at line 493 of file ha_config.h.

Referenced by getThisServerName(), and setThisServerName().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ PeerConfigMap

◆ PeerConfigPtr

◆ StateConfigPtr

◆ StateMachineConfigPtr

Member Enumeration Documentation

◆ HAMode

Constructor & Destructor Documentation

◆ HAConfig()

Member Function Documentation

◆ amSendingLeaseUpdates()

◆ amSyncingLeases()

◆ getAllServersConfig()

◆ getFailoverPeerConfig()

◆ getHAMode()

◆ getHeartbeatDelay()

◆ getMaxAckDelay()

◆ getMaxResponseDelay()

◆ getMaxUnackedClients()

◆ getOtherServersConfig()

◆ getPeerConfig()

◆ getStateMachineConfig()

◆ getSyncPageLimit()

◆ getSyncTimeout()

◆ getThisServerConfig()

◆ getThisServerName()

◆ HAModeToString()

◆ selectNextPeerConfig()

◆ setHAMode()

◆ setHeartbeatDelay()

◆ setMaxAckDelay()

◆ setMaxResponseDelay()

◆ setMaxUnackedClients()

◆ setSendLeaseUpdates()

◆ setSyncLeases()

◆ setSyncPageLimit()

◆ setSyncTimeout()

◆ setThisServerName()

◆ stringToHAMode()

◆ validate()

Member Data Documentation

◆ ha_mode_

◆ heartbeat_delay_

◆ max_ack_delay_

◆ max_response_delay_

◆ max_unacked_clients_

◆ peers_

◆ send_lease_updates_

◆ state_machine_

◆ sync_leases_

◆ sync_page_limit_

◆ sync_timeout_

◆ this_server_name_