Holds communication state between DHCPv4 servers. More...

#include <communication_state.h>

Inheritance diagram for isc::ha::CommunicationState4:

Classes
struct	ConnectingClient4
	Structure holding information about the client which has send the packet being analyzed. More...

Public Member Functions
	CommunicationState4 (const asiolink::IOServicePtr &io_service, const HAConfigPtr &config)
	Constructor. More...

virtual void	analyzeMessage (const boost::shared_ptr< dhcp::Pkt > &message)
	Checks if the DHCPv4 message appears to be unanswered. More...

virtual bool	failureDetected () const
	Checks if the partner failure has been detected based on the DHCP traffic analysis. More...

virtual size_t	getConnectingClientsCount () const
	Returns the current number of clients which attempted to get a lease from the partner server. More...

virtual size_t	getUnackedClientsCount () const
	Returns the current number of clients which haven't gotten a lease from the partner server. More...

Public Member Functions inherited from isc::ha::CommunicationState
	CommunicationState (const asiolink::IOServicePtr &io_service, const HAConfigPtr &config)
	Constructor. More...

virtual	~CommunicationState ()
	Destructor. More...

bool	clockSkewShouldTerminate () const
	Indicates whether the HA service should enter "terminated" state as a result of the clock skew exceeding maximum value. More...

bool	clockSkewShouldWarn ()
	Issues a warning about high clock skew between the active servers if one is warranted. More...

size_t	getAnalyzedMessagesCount () const
	Returns the number of analyzed messages while being in the communications interrupted state. More...

int64_t	getDurationInMillisecs () const
	Returns duration between the poke time and current time. More...

std::set< std::string >	getPartnerScopes () const
	Returns scopes served by the partner server. More...

int	getPartnerState () const
	Returns last known state of the partner. More...

data::ElementPtr	getReport () const
	Returns the report about current communication state. More...

bool	isCommunicationInterrupted () const
	Checks if communication with the partner is interrupted. More...

bool	isHeartbeatRunning () const
	Checks if recurring heartbeat is running. More...

std::string	logFormatClockSkew () const
	Returns current clock skew value in the logger friendly format. More...

void	modifyPokeTime (const long secs)
	Modifies poke time by adding seconds to it. More...

void	poke ()
	Pokes the communication state. More...

void	setPartnerScopes (data::ConstElementPtr new_scopes)
	Sets partner scopes. More...

void	setPartnerState (const std::string &state)
	Sets partner state. More...

void	setPartnerTime (const std::string &time_text)
	Provide partner's notion of time so the new clock skew can be calculated. More...

void	startHeartbeat (const long interval, const std::function< void()> &heartbeat_impl)
	Starts recurring heartbeat (public interface). More...

void	stopHeartbeat ()
	Stops recurring heartbeat. More...

Protected Types
typedef boost::multi_index_container< ConnectingClient4, boost::multi_index::indexed_by< boost::multi_index::hashed_unique< boost::multi_index::composite_key< ConnectingClient4, boost::multi_index::member< ConnectingClient4, std::vector< uint8_t >,&ConnectingClient4::hwaddr_ >, boost::multi_index::member< ConnectingClient4, std::vector< uint8_t >,&ConnectingClient4::clientid_ > > >, boost::multi_index::ordered_non_unique< boost::multi_index::member< ConnectingClient4, bool,&ConnectingClient4::unacked_ > > > >	ConnectingClients4
	Multi index container holding information about the clients attempting to get leases from the partner server. More...

Protected Member Functions
virtual void	analyzeMessageInternal (const boost::shared_ptr< dhcp::Pkt > &message)
	Checks if the DHCPv4 message appears to be unanswered. More...

virtual void	clearConnectingClients ()
	Removes information about the clients the partner server should respond to while communication with the partner was interrupted. More...

virtual bool	failureDetectedInternal () const
	Checks if the partner failure has been detected based on the DHCP traffic analysis. More...

Protected Member Functions inherited from isc::ha::CommunicationState
boost::posix_time::time_duration	updatePokeTime ()
	Update the poke time and compute the duration. More...

Protected Attributes
ConnectingClients4	connecting_clients_
	Holds information about the clients attempting to contact the partner server while the servers are in communications interrupted state. More...

Protected Attributes inherited from isc::ha::CommunicationState
size_t	analyzed_messages_count_
	Total number of analyzed messages to be responded by partner. More...

boost::posix_time::time_duration	clock_skew_
	Clock skew between the active servers. More...

HAConfigPtr	config_
	High availability configuration. More...

std::function< void()>	heartbeat_impl_
	Pointer to the function providing heartbeat implementation. More...

long	interval_
	Interval specified for the heartbeat. More...

asiolink::IOServicePtr	io_service_
	Pointer to the common IO service instance. More...

boost::posix_time::ptime	last_clock_skew_warn_
	Holds a time when last warning about too high clock skew was issued. More...

const boost::scoped_ptr< std::mutex >	mutex_
	The mutex used to protect internal state. More...

boost::posix_time::ptime	my_time_at_skew_
	My time when skew was calculated. More...

std::set< std::string >	partner_scopes_
	Last known set of scopes served by the partner server. More...

int	partner_state_
	Last known state of the partner server. More...

boost::posix_time::ptime	partner_time_at_skew_
	Partner reported time when skew was calculated. More...

boost::posix_time::ptime	poke_time_
	Last poke time. More...

asiolink::IntervalTimerPtr	timer_
	Interval timer triggering heartbeat commands. More...

Detailed Description

Holds communication state between DHCPv4 servers.

This class implements DHCPv4 failure detection by monitoring the value of the "secs" field in received DHCPv4 messages as described in CommunicationState::analyzeMessage.

Definition at line 522 of file communication_state.h.

Member Typedef Documentation

typedef boost::multi_index_container< ConnectingClient4, boost::multi_index::indexed_by< boost::multi_index::hashed_unique< boost::multi_index::composite_key< ConnectingClient4, boost::multi_index::member<ConnectingClient4, std::vector<uint8_t>, &ConnectingClient4::hwaddr_>, boost::multi_index::member<ConnectingClient4, std::vector<uint8_t>, &ConnectingClient4::clientid_> > >, boost::multi_index::ordered_non_unique< boost::multi_index::member<ConnectingClient4, bool, &ConnectingClient4::unacked_> > > > isc::ha::CommunicationState4::ConnectingClients4

protected

Multi index container holding information about the clients attempting to get leases from the partner server.

Definition at line 641 of file communication_state.h.

Constructor & Destructor Documentation

isc::ha::CommunicationState4::CommunicationState4	(	const asiolink::IOServicePtr &	io_service,
		const HAConfigPtr &	config
	)

Constructor.

Parameters

io_service	pointer to the common IO service instance.
config	pointer to the HA configuration.

Definition at line 476 of file communication_state.cc.

Member Function Documentation

void isc::ha::CommunicationState4::analyzeMessage ( const boost::shared_ptr< dhcp::Pkt > & message )

virtual

Checks if the DHCPv4 message appears to be unanswered.

This method uses "secs" field value for detecting client communication failures as described in the CommunicationState::analyzeMessage. Some misbehaving Windows clients were reported to swap "secs" field bytes. In this case the first byte is set to non-zero byte and the second byte is set to 0. This method handles such cases and corrects bytes order before comparing against the threshold.

Parameters

message DHCPv4 message to be analyzed. This must be the message which belongs to the partner, i.e. the caller must filter out messages belonging to the partner prior to calling this method.

Implements isc::ha::CommunicationState.

Definition at line 482 of file communication_state.cc.

References analyzeMessageInternal(), and isc::ha::CommunicationState::mutex_.

Here is the call graph for this function:

void isc::ha::CommunicationState4::analyzeMessageInternal ( const boost::shared_ptr< dhcp::Pkt > & message )

protectedvirtual

Checks if the DHCPv4 message appears to be unanswered.

Should be called in a thread safe context.

This method uses "secs" field value for detecting client communication failures as described in the CommunicationState::analyzeMessage. Some misbehaving Windows clients were reported to swap "secs" field bytes. In this case the first byte is set to non-zero byte and the second byte is set to 0. This method handles such cases and corrects bytes order before comparing against the threshold.

Parameters

message DHCPv4 message to be analyzed. This must be the message which belongs to the partner, i.e. the caller must filter out messages belonging to the partner prior to calling this method.

Definition at line 492 of file communication_state.cc.

References isc::ha::CommunicationState::analyzed_messages_count_, isc::ha::CommunicationState::config_, connecting_clients_, isc::dhcp::DHO_DHCP_CLIENT_IDENTIFIER, isc::ha::HA_COMMUNICATION_INTERRUPTED_CLIENT4, isc::ha::HA_COMMUNICATION_INTERRUPTED_CLIENT4_UNACKED, isc::ha::ha_logger, isc::ha::CommunicationState4::ConnectingClient4::hwaddr_, isc_throw, and LOG_INFO.

Referenced by analyzeMessage().

void isc::ha::CommunicationState4::clearConnectingClients ( )

protectedvirtual

Removes information about the clients the partner server should respond to while communication with the partner was interrupted.

See CommunicationState::analyzeMessage for details.

Implements isc::ha::CommunicationState.

Definition at line 610 of file communication_state.cc.

References connecting_clients_.

bool isc::ha::CommunicationState4::failureDetected ( ) const

virtual

Checks if the partner failure has been detected based on the DHCP traffic analysis.

Returns: true if the partner failure has been detected, false otherwise.

Implements isc::ha::CommunicationState.

Definition at line 573 of file communication_state.cc.

References failureDetectedInternal(), and isc::ha::CommunicationState::mutex_.

Here is the call graph for this function:

bool isc::ha::CommunicationState4::failureDetectedInternal ( ) const

protectedvirtual

Checks if the partner failure has been detected based on the DHCP traffic analysis.

Should be called in a thread safe context.

Returns: true if the partner failure has been detected, false otherwise.

Definition at line 583 of file communication_state.cc.

References isc::ha::CommunicationState::config_, and connecting_clients_.

Referenced by failureDetected().

size_t isc::ha::CommunicationState4::getConnectingClientsCount ( ) const

virtual

Returns the current number of clients which attempted to get a lease from the partner server.

The returned number is reset to 0 when the server successfully establishes communication with the partner. The number is incremented only in the communications interrupted case.

Returns: The number of clients including unacked clients.

Implements isc::ha::CommunicationState.

Definition at line 590 of file communication_state.cc.

References connecting_clients_, and isc::ha::CommunicationState::mutex_.

size_t isc::ha::CommunicationState4::getUnackedClientsCount ( ) const

virtual

Returns the current number of clients which haven't gotten a lease from the partner server.

The returned number is reset to 0 when the server successfully establishes communication with the partner. The number is incremented only in the communications interrupted case.

Returns: Number of unacked clients.

Implements isc::ha::CommunicationState.

Definition at line 600 of file communication_state.cc.

References connecting_clients_, and isc::ha::CommunicationState::mutex_.

Member Data Documentation

ConnectingClients4 isc::ha::CommunicationState4::connecting_clients_

protected

Holds information about the clients attempting to contact the partner server while the servers are in communications interrupted state.

Definition at line 646 of file communication_state.h.

Referenced by analyzeMessageInternal(), clearConnectingClients(), failureDetectedInternal(), getConnectingClientsCount(), and getUnackedClientsCount().

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation