2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
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.
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.
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.
20 #ifndef PING_SCHEDULER_H
21 #define PING_SCHEDULER_H
28 #include <boost/asio.hpp>
29 #include <boost/shared_ptr.hpp>
31 #include "link/linkstatus.h"
32 #include "host/hoststatus.h"
33 #include "host/pingstatus.h"
34 #include "host/pinger.h"
35 #include "host/pinginterval.h"
36 #include "host/pingprotocol.h"
37 #include "dns/resolverbase.h"
39 //-----------------------------------------------------------------------------
41 //-----------------------------------------------------------------------------
44 * @brief This class is responsible to control whether to ping a host. It
45 * schedules periodic pings to a host.
46 * Scope: one object per host.
52 const IoServiceItem io_service,
53 const std::string &network_interface,
54 const std::string &destination_address,
55 const uint16_t destination_port,
56 const PingProtocolList &ping_protocol_list,
57 const long ping_interval_in_sec,
58 const int ping_fail_percentage_limit,
59 const int ping_reply_timeout,
60 LinkStatusItem link_analyzer,
73 void ping(const boost::system::error_code &error);
74 void ping_done_handler(const PingStatus &result);
75 void update_ping_interval();
77 void init_ping_protocol();
78 void update_ping_protocol();
79 void get_next_ping_protocol();
80 bool can_change_ping_protocol() const;
82 void update_dns_resolver( PingProtocol current_protocol );
84 void ping_when_ready();
85 void dns_resolve_callback(const bool was_success,
86 const int recursion_count);
87 void start_resolving_ping_address();
89 void update_log_prefix();
90 void cancel_resolve(const bool force_cancel);
96 /// The IO service object, which has the loop event
97 IoServiceItem IoService;
98 /// The network interface name
99 std::string NetworkInterfaceName;
100 /// The address to ping
101 std::string DestinationAddress;
102 /// The port to ping at destination host (same for all protocols)
103 uint16_t DestinationPort;
104 /// The list of protocols to ping and iterator over them
105 PingProtocolList Protocols;
106 PingProtocolList::const_iterator ProtocolIter;
107 /// Interval between each ping to the same host
108 PingInterval PingIntervalInSec;
109 /// delay for very first ping to avoid lots of simultaneous pings at startup
111 /// Timer to trigger the next ping
112 boost::asio::deadline_timer NextPingTimer;
113 /// Keeps track of the time when the last ping was send
114 boost::posix_time::ptime TimeSentLastPing;
115 /// time threshold for ping
116 const int PingReplyTimeout;
117 /// Object responsible to evaluate the status of the host
118 HostStatus HostAnalyzer;
120 ResolverItem Resolver;
121 /// The actual pinger
123 /// a flag whether we should ping as soon as dns is ready
125 /// Prefix to log messages for quicker analysis/debugging
126 std::string LogPrefix;
127 /// Flag whether DNS resolution has failed so we have to run on outdated IPs
128 bool ContinueOnOutdatedIps;
131 //-----------------------------------------------------------------------------
133 //-----------------------------------------------------------------------------
135 typedef boost::shared_ptr<PingScheduler> PingSchedulerItem;
137 //-----------------------------------------------------------------------------
139 //-----------------------------------------------------------------------------
141 typedef std::vector< PingSchedulerItem > PingSchedulerList;
143 #endif // PING_SCHEDULER_H