Commit | Line | Data |
---|---|---|
91fcc471 TJ |
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 | */ | |
a9c88e1c GMF |
20 | #ifndef PING_SCHEDULER_H |
21 | #define PING_SCHEDULER_H | |
ced28dc7 | 22 | |
238da857 GMF |
23 | #include <stdint.h> |
24 | ||
9c55ecd3 | 25 | #include <string> |
5624490d | 26 | #include <vector> |
9c55ecd3 | 27 | |
e39cc3da GMF |
28 | #include <boost/asio.hpp> |
29 | #include <boost/shared_ptr.hpp> | |
ced28dc7 | 30 | |
72e54d1c | 31 | #include "link/linkstatus.h" |
6c14bbee | 32 | #include "host/hoststatus.h" |
96c4e7a4 | 33 | #include "host/pingstatus.h" |
51cbc790 | 34 | #include "host/pinger.h" |
8f66f529 | 35 | #include "host/pinginterval.h" |
242e5fb3 | 36 | #include "host/pingnumber.h" |
3fd74a53 | 37 | #include "host/pingprotocol.h" |
26b0f687 | 38 | #include "dns/resolverbase.h" |
ced28dc7 | 39 | |
89f153af | 40 | typedef std::vector<PingerItem> pinger_vec; |
91aa83f9 | 41 | |
4c2a5ab5 | 42 | //----------------------------------------------------------------------------- |
4bb97b45 | 43 | // PingScheduler |
4c2a5ab5 GMF |
44 | //----------------------------------------------------------------------------- |
45 | ||
c5e4bfa1 GMF |
46 | /** |
47 | * @brief This class is responsible to control whether to ping a host. It | |
48 | * schedules periodic pings to a host. | |
49 | * Scope: one object per host. | |
50 | */ | |
4bb97b45 | 51 | class PingScheduler |
ced28dc7 GMF |
52 | { |
53 | public: | |
4bb97b45 | 54 | PingScheduler( |
365036be | 55 | const IoServiceItem io_service, |
2bf8720f GMF |
56 | const std::string &network_interface, |
57 | const std::string &destination_address, | |
238da857 | 58 | const uint16_t destination_port, |
fe6a2f80 | 59 | const PingProtocolList &ping_protocol_list, |
c15a722d | 60 | const long ping_interval_in_sec, |
a341119a | 61 | const int ping_fail_percentage_limit, |
a7b15639 CH |
62 | const int ping_congestion_percentage_limit, |
63 | const int ping_congestion_duration_thresh, | |
079d19ab | 64 | const int ping_reply_timeout, |
59733431 | 65 | LinkStatusItem link_analyzer, |
91aa83f9 CH |
66 | const int first_delay, |
67 | const int n_parallel_pings, | |
68 | const int parallel_ping_delay | |
e39cc3da | 69 | ); |
a86e8ddc | 70 | ~PingScheduler(); |
ced28dc7 | 71 | |
365036be CH |
72 | void start_pinging(); |
73 | void stop_pinging(); | |
88714861 GMF |
74 | |
75 | private: | |
010b8519 GMF |
76 | // |
77 | // Methods | |
78 | // | |
79 | ||
26b0f687 | 80 | void ping(const boost::system::error_code &error); |
9c0dcf33 CH |
81 | void ping_done_handler(const PingStatus &result, |
82 | const long ping_duration_us); | |
d8a91bd6 | 83 | void update_ping_interval(); |
242e5fb3 | 84 | void update_ping_number(); |
ced28dc7 | 85 | |
23f51766 CH |
86 | void init_ping_protocol(); |
87 | void update_ping_protocol(); | |
88 | void get_next_ping_protocol(); | |
89 | bool can_change_ping_protocol() const; | |
90 | ||
91aa83f9 | 91 | void prepare_next_ping(); |
242e5fb3 | 92 | void update_dns_resolver(); |
23f51766 | 93 | |
8d26221d | 94 | void ping_when_ready(); |
89f153af | 95 | void delayed_ping( const boost::system::error_code &error, |
242e5fb3 | 96 | const boost::asio::ip::address ip, |
89f153af | 97 | const int pinger_index ); |
cd71d095 CH |
98 | void dns_resolve_callback(const bool was_success, |
99 | const int recursion_count); | |
26b0f687 CH |
100 | void start_resolving_ping_address(); |
101 | ||
102 | void update_log_prefix(); | |
72be9e7d | 103 | void cancel_resolve(const bool force_cancel); |
91aa83f9 | 104 | void clear_pingers(); |
23f51766 | 105 | |
010b8519 GMF |
106 | // |
107 | // Attributes | |
108 | // | |
109 | ||
23f51766 CH |
110 | /// The IO service object, which has the loop event |
111 | IoServiceItem IoService; | |
112 | /// The network interface name | |
113 | std::string NetworkInterfaceName; | |
23f51766 CH |
114 | /// The address to ping |
115 | std::string DestinationAddress; | |
26b0f687 | 116 | /// The port to ping at destination host (same for all protocols) |
23f51766 | 117 | uint16_t DestinationPort; |
26b0f687 CH |
118 | /// The list of protocols to ping and iterator over them |
119 | PingProtocolList Protocols; | |
120 | PingProtocolList::const_iterator ProtocolIter; | |
121 | /// Interval between each ping to the same host | |
122 | PingInterval PingIntervalInSec; | |
242e5fb3 CH |
123 | /// number of pingers that work in parallel |
124 | PingNumber NPingers; | |
26b0f687 CH |
125 | /// delay for very first ping to avoid lots of simultaneous pings at startup |
126 | int FirstDelay; | |
127 | /// Timer to trigger the next ping | |
128 | boost::asio::deadline_timer NextPingTimer; | |
129 | /// Keeps track of the time when the last ping was send | |
130 | boost::posix_time::ptime TimeSentLastPing; | |
131 | /// time threshold for ping | |
23f51766 | 132 | const int PingReplyTimeout; |
26b0f687 CH |
133 | /// Object responsible to evaluate the status of the host |
134 | HostStatus HostAnalyzer; | |
135 | /// The Dns resolver | |
136 | ResolverItem Resolver; | |
91aa83f9 | 137 | /// vector of pingers |
89f153af | 138 | pinger_vec Pingers; |
91aa83f9 CH |
139 | /// number of results from pingers |
140 | int NPingersDone; | |
141 | /// delay (in ms) between pings to same IP | |
142 | int ParallelPingDelay; | |
89f153af CH |
143 | /// timers for delayed pings |
144 | boost::asio::deadline_timer DelayedPingTimer; | |
23f51766 CH |
145 | /// a flag whether we should ping as soon as dns is ready |
146 | bool WantToPing; | |
26b0f687 CH |
147 | /// Prefix to log messages for quicker analysis/debugging |
148 | std::string LogPrefix; | |
149 | /// Flag whether DNS resolution has failed so we have to run on outdated IPs | |
150 | bool ContinueOnOutdatedIps; | |
ced28dc7 GMF |
151 | }; |
152 | ||
e39cc3da | 153 | //----------------------------------------------------------------------------- |
4bb97b45 | 154 | // PingSchedulerItem |
e39cc3da GMF |
155 | //----------------------------------------------------------------------------- |
156 | ||
4bb97b45 | 157 | typedef boost::shared_ptr<PingScheduler> PingSchedulerItem; |
e39cc3da | 158 | |
5624490d GMF |
159 | //----------------------------------------------------------------------------- |
160 | // PingSchedulerList | |
161 | //----------------------------------------------------------------------------- | |
162 | ||
163 | typedef std::vector< PingSchedulerItem > PingSchedulerList; | |
164 | ||
a9c88e1c | 165 | #endif // PING_SCHEDULER_H |