5aa99119540df920e9f8ed6b9eb722c3d07db454
[pingcheck] / src / host / hoststatus.h
1 /*
2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
4
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
7
8 As a special exception, if other files instantiate templates or use macros
9 or inline functions from this file, or you compile this file and link it
10 with other works to produce a work based on this file, this file
11 does not by itself cause the resulting work to be covered
12 by the GNU General Public License.
13
14 However the source code for this file must still be made available
15 in accordance with section (3) of the GNU General Public License.
16
17 This exception does not invalidate any other reasons why a work based
18 on this file might be covered by the GNU General Public License.
19 */
20 #ifndef HOST_STATUS_H
21 #define HOST_STATUS_H
22
23 #include <string>
24
25 #include "host/pingstatus.h"
26 #include "link/linkstatus.h"
27
28 //-----------------------------------------------------------------------------
29 // HostStatus
30 //-----------------------------------------------------------------------------
31
32 /**
33  * @brief This class analyze the host status (up or down) based on the pings
34  * responses (success or failure). And notifies its status.
35  * Scope: one object per host.
36  */
37 class HostStatus
38 {
39 public:
40     HostStatus(
41             const std::string &host_address,
42             const int ping_fail_limit_percentage,
43             const int ping_congestion_limit_percentage,
44             const int ping_duration_congestion_thresh,
45             const int n_parallel_pings,
46             const LinkStatusItem link_analyzer
47     );
48     ~HostStatus();
49
50     void set_resolved_ip_count( const int resolved_ip_count );
51     bool exceeded_ping_failed_limit() const;
52     bool exceeded_ping_congestion_limit() const;
53     void update_ping_statistics( const PingStatus &ping_success,
54                                  const long ping_duration_us );
55     void set_n_parallel_pings(const int n_parallel_pings);
56
57 private:
58     void update_fail_stats( const PingStatus &ping_success,
59                             const bool failed_because_congested );
60     bool update_congestion_stats( const PingStatus &ping_success,
61                                   const long ping_duration_us );
62     bool tried_all_resolved_ip() const;
63     void analyze_ping_statistics();
64     void reset_ping_counters();
65     void increase_ping_performed_count();
66     void increase_ping_failed_count();
67     void increase_ping_congestion_count();
68     void analyze_ping_failed_count();
69     void analyze_ping_congestion_count();
70
71     std::string log_prefix();
72
73 private:
74     /// the DNS address of the host to analyze
75     std::string HostAddress;
76     /// the object responsible to analyze the link
77     const LinkStatusItem LinkAnalyzer;
78     /// the maximum amount of pings that can fail without warning
79     int PingFailLimitPercentage;
80     /// the maximum amount of pings that can be congested without warning
81     int PingCongestionLimitPercentage;
82     /// the threshold in micro seconds that ping can take with/out congestion
83     long PingDurationCongestionsThresh;
84     /// the amount of IPs that are aliases to the host DNS
85     int ResolvedIpCount;
86     /// the amount of pings sent until now
87     int PingsPerformedCount;
88     /// the amount of pings sent that failed until now
89     int PingsFailedCount;
90     /// the amount of pings sent that indicate congestion until now
91     int PingCongestionCount;
92     /// boolean flag that indicate if the last set of failed pings exceed the
93     /// limit
94     bool ExceededPingFailedLimit;
95     /// boolean flag that indicate if the last set of congested pings exceed the
96     /// limit
97     bool ExceededPingCongestionLimit;
98     /// number of pingers that ping the same IP in parallel
99     int NParallelPingers;
100     /// flag whether we performed a greater number of pings because line seems
101     /// congested
102     bool InBurstMode;
103
104 };
105
106 #endif // HOST_STATUS_H