Kea  1.5.0
Classes | Typedefs | Enumerations | Functions | Variables
isc::ha Namespace Reference

Classes

class  CommandCreator
 Holds a collection of functions which generate commands used for High Availability. More...
 
class  CommunicationState
 Holds communication state between the two HA peers. More...
 
class  CommunicationState4
 Holds communication state between DHCPv4 servers. More...
 
class  CommunicationState6
 Holds communication state between DHCPv6 servers. More...
 
class  HAConfig
 Storage for High Availability configuration. More...
 
class  HAConfigParser
 Configuration parser for High Availability. More...
 
class  HAConfigValidationError
 Exception thrown when configuration validation fails. More...
 
class  HAImpl
 High Availability hooks library implementation. More...
 
class  HAService
 High availability service. More...
 
class  QueryFilter
 DHCP query filtering class. More...
 

Typedefs

typedef boost::shared_ptr< CommunicationState4 > CommunicationState4Ptr
 Pointer to the CommunicationState4 object. More...
 
typedef boost::shared_ptr< CommunicationState6 > CommunicationState6Ptr
 Pointer to the CommunicationState6 object. More...
 
typedef boost::shared_ptr< CommunicationState > CommunicationStatePtr
 Type of the pointer to the CommunicationState object. More...
 
typedef boost::shared_ptr< HAConfig > HAConfigPtr
 Pointer to the High Availability configuration structure. More...
 
typedef boost::shared_ptr< HAImpl > HAImplPtr
 Pointer to the High Availability hooks library implementation. More...
 
typedef boost::shared_ptr< HAService > HAServicePtr
 Pointer to the HAService class. More...
 

Enumerations

enum  HAServerType { HAServerType::DHCPv4, HAServerType::DHCPv6 }
 Lists possible server types for which HA service is created. More...
 

Functions

std::string stateToString (int state)
 Returns state name. More...
 
int stringToState (const std::string &state_name)
 Returns state for a given name. More...
 

Variables

const int HA_BACKUP_ST = util::StateModel::SM_DERIVED_STATE_MIN + 1
 Backup state. More...
 
const int HA_HOT_STANDBY_ST = util::StateModel::SM_DERIVED_STATE_MIN + 2
 Hot standby state. More...
 
const int HA_LOAD_BALANCING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 3
 Load balancing state. More...
 
isc::log::Logger ha_logger ("ha-hooks")
 
const int HA_PARTNER_DOWN_ST = util::StateModel::SM_DERIVED_STATE_MIN + 4
 Partner down state. More...
 
const int HA_READY_ST = util::StateModel::SM_DERIVED_STATE_MIN + 5
 Server ready state, i.e. synchronized database, can enable DHCP service. More...
 
const int HA_SYNCING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 6
 Synchronizing database state. More...
 
const int HA_TERMINATED_ST = util::StateModel::SM_DERIVED_STATE_MIN + 7
 HA service terminated state. More...
 
const int HA_UNAVAILABLE_ST = util::StateModel::SM_DERIVED_STATE_MIN + 1000
 Special state indicating that this server is unable to communicate with the partner. More...
 
const int HA_WAITING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 8
 Server waiting state, i.e. waiting for another server to be ready. More...
 
HAImplPtr impl
 

Typedef Documentation

◆ CommunicationState4Ptr

typedef boost::shared_ptr<CommunicationState4> isc::ha::CommunicationState4Ptr

Pointer to the CommunicationState4 object.

Definition at line 382 of file communication_state.h.

◆ CommunicationState6Ptr

typedef boost::shared_ptr<CommunicationState6> isc::ha::CommunicationState6Ptr

Pointer to the CommunicationState6 object.

Definition at line 432 of file communication_state.h.

◆ CommunicationStatePtr

typedef boost::shared_ptr<CommunicationState> isc::ha::CommunicationStatePtr

Type of the pointer to the CommunicationState object.

Definition at line 323 of file communication_state.h.

◆ HAConfigPtr

typedef boost::shared_ptr<HAConfig> isc::ha::HAConfigPtr

Pointer to the High Availability configuration structure.

Definition at line 509 of file ha_config.h.

◆ HAImplPtr

typedef boost::shared_ptr<HAImpl> isc::ha::HAImplPtr

Pointer to the High Availability hooks library implementation.

Definition at line 156 of file ha_impl.h.

◆ HAServicePtr

typedef boost::shared_ptr<HAService> isc::ha::HAServicePtr

Pointer to the HAService class.

Definition at line 752 of file ha_service.h.

Enumeration Type Documentation

◆ HAServerType

enum isc::ha::HAServerType
strong

Lists possible server types for which HA service is created.

Enumerator
DHCPv4 
DHCPv6 

Definition at line 14 of file ha_server_type.h.

Function Documentation

◆ stateToString()

std::string isc::ha::stateToString ( int  state)

Returns state name.

Parameters
statestate identifier for which name should be returned.
Exceptions
BadValueif the state identifier is unsupported.

Definition at line 12 of file ha_service_states.cc.

References HA_BACKUP_ST, HA_HOT_STANDBY_ST, HA_LOAD_BALANCING_ST, HA_PARTNER_DOWN_ST, HA_READY_ST, HA_SYNCING_ST, HA_TERMINATED_ST, HA_UNAVAILABLE_ST, HA_WAITING_ST, and isc_throw.

Referenced by isc::ha::HAService::conditionalLogPausedState(), and isc::ha::HAService::defineStates().

◆ stringToState()

int isc::ha::stringToState ( const std::string &  state_name)

Returns state for a given name.

Parameters
state_namename of the state to be returned.
Exceptions
BadValueif the state name is unsupported.

Definition at line 39 of file ha_service_states.cc.

References HA_BACKUP_ST, HA_HOT_STANDBY_ST, HA_LOAD_BALANCING_ST, HA_PARTNER_DOWN_ST, HA_READY_ST, HA_SYNCING_ST, HA_TERMINATED_ST, HA_UNAVAILABLE_ST, HA_WAITING_ST, and isc_throw.

Variable Documentation

◆ HA_BACKUP_ST

const int isc::ha::HA_BACKUP_ST = util::StateModel::SM_DERIVED_STATE_MIN + 1

Backup state.

Definition at line 17 of file ha_service_states.h.

Referenced by isc::ha::HAService::defineStates(), stateToString(), stringToState(), and isc::ha::HAService::waitingStateHandler().

◆ HA_HOT_STANDBY_ST

const int isc::ha::HA_HOT_STANDBY_ST = util::StateModel::SM_DERIVED_STATE_MIN + 2

Hot standby state.

Definition at line 20 of file ha_service_states.h.

Referenced by isc::ha::HAService::adjustNetworkState(), isc::ha::HAService::defineStates(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), isc::ha::HAService::shouldSendLeaseUpdates(), stateToString(), stringToState(), and isc::ha::HAService::waitingStateHandler().

◆ HA_LOAD_BALANCING_ST

const int isc::ha::HA_LOAD_BALANCING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 3

Load balancing state.

Definition at line 23 of file ha_service_states.h.

Referenced by isc::ha::HAService::adjustNetworkState(), isc::ha::HAService::defineStates(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), isc::ha::HAService::shouldSendLeaseUpdates(), stateToString(), stringToState(), and isc::ha::HAService::waitingStateHandler().

◆ ha_logger

isc::log::Logger isc::ha::ha_logger

Definition at line 17 of file ha_log.h.

Referenced by isc::ha::HAService::adjustNetworkState(), isc::ha::HAService::asyncDisableDHCPService(), isc::ha::HAService::asyncEnableDHCPService(), isc::ha::HAService::asyncSendHeartbeat(), isc::ha::HAService::asyncSendLeaseUpdate(), isc::ha::HAService::asyncSyncLeasesInternal(), buffer4_receive(), isc::ha::HAImpl::buffer4Receive(), buffer6_receive(), isc::ha::HAImpl::buffer6Receive(), command_processed(), isc::ha::HAService::conditionalLogPausedState(), continue_command(), dhcp4_srv_configured(), dhcp6_srv_configured(), isc::ha::HAService::HAService(), heartbeat_command(), leases4_committed(), isc::ha::HAImpl::leases4Committed(), leases6_committed(), isc::ha::HAImpl::leases6Committed(), load(), isc::ha::QueryFilter::loadBalance(), scopes_command(), isc::ha::HAService::shouldTerminate(), sync_command(), isc::ha::HAService::synchronize(), isc::ha::HAService::terminatedStateHandler(), unload(), isc::ha::HAService::unpause(), and isc::ha::HAService::verboseTransition().

◆ HA_PARTNER_DOWN_ST

const int isc::ha::HA_PARTNER_DOWN_ST = util::StateModel::SM_DERIVED_STATE_MIN + 4

Partner down state.

Definition at line 26 of file ha_service_states.h.

Referenced by isc::ha::HAService::adjustNetworkState(), isc::ha::HAService::defineStates(), isc::ha::HAService::normalStateHandler(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), isc::ha::HAService::syncingStateHandler(), and isc::ha::HAService::waitingStateHandler().

◆ HA_READY_ST

const int isc::ha::HA_READY_ST = util::StateModel::SM_DERIVED_STATE_MIN + 5

Server ready state, i.e. synchronized database, can enable DHCP service.

Definition at line 29 of file ha_service_states.h.

Referenced by isc::ha::HAService::defineStates(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), isc::ha::HAService::syncingStateHandler(), isc::ha::HAService::verboseTransition(), and isc::ha::HAService::waitingStateHandler().

◆ HA_SYNCING_ST

const int isc::ha::HA_SYNCING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 6

Synchronizing database state.

Definition at line 32 of file ha_service_states.h.

Referenced by isc::ha::HAService::defineStates(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), and isc::ha::HAService::waitingStateHandler().

◆ HA_TERMINATED_ST

const int isc::ha::HA_TERMINATED_ST = util::StateModel::SM_DERIVED_STATE_MIN + 7

HA service terminated state.

Definition at line 35 of file ha_service_states.h.

Referenced by isc::ha::HAService::adjustNetworkState(), isc::ha::HAService::defineStates(), isc::ha::HAService::normalStateHandler(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), isc::ha::HAService::syncingStateHandler(), and isc::ha::HAService::waitingStateHandler().

◆ HA_UNAVAILABLE_ST

const int isc::ha::HA_UNAVAILABLE_ST = util::StateModel::SM_DERIVED_STATE_MIN + 1000

Special state indicating that this server is unable to communicate with the partner.

Definition at line 42 of file ha_service_states.h.

Referenced by isc::ha::HAService::normalStateHandler(), isc::ha::HAService::readyStateHandler(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), isc::ha::HAService::syncingStateHandler(), and isc::ha::HAService::waitingStateHandler().

◆ HA_WAITING_ST

const int isc::ha::HA_WAITING_ST = util::StateModel::SM_DERIVED_STATE_MIN + 8

Server waiting state, i.e. waiting for another server to be ready.

Definition at line 38 of file ha_service_states.h.

Referenced by isc::ha::HAService::defineStates(), isc::ha::HAService::HAService(), isc::ha::HAService::normalStateHandler(), isc::ha::HAService::partnerDownStateHandler(), isc::ha::CommunicationState::setPartnerState(), stateToString(), stringToState(), isc::ha::HAService::verboseTransition(), and isc::ha::HAService::waitingStateHandler().

◆ impl

HAImplPtr isc::ha::impl

Definition at line 23 of file ha_callouts.cc.

Referenced by buffer4_receive(), buffer6_receive(), command_processed(), continue_command(), dhcp4_srv_configured(), dhcp6_srv_configured(), isc::util::thread::Thread::Impl::done(), heartbeat_command(), leases4_committed(), leases6_committed(), load(), isc::dns::MasterLoader::MasterLoader(), isc::util::thread::Mutex::Mutex(), isc::util::thread::Thread::Impl::run(), scopes_command(), isc::dns::SectionIterator< T >::SectionIterator(), isc::util::io::SocketSessionForwarder::SocketSessionForwarder(), isc::stat_cmds::StatCmds::statLease4GetHandler(), isc::stat_cmds::StatCmds::statLease6GetHandler(), sync_command(), and isc::util::thread::Thread::Thread().