a063c6cd3294d3e8e1dda97d3d14002d1f7ea172
[pingcheck] / src / dns / resolverbase.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  Christian Herdtweck, Intra2net AG 2015
21  */
22
23 #ifndef RESOLVER_BASE_H
24 #define RESOLVER_BASE_H
25
26 #include <boost/shared_ptr.hpp>
27 #include <boost/function.hpp>
28
29 #include <queue>
30 #include "host/pinger.h"
31 #include "dns/hostaddress.h"
32 #include "dns/dnscache.h"
33
34 typedef boost::function<void(const bool, const int)> callback_type;
35 typedef std::queue<callback_type> callback_list_type;
36
37 /**
38  * @brief: abstract base class for DnsResolver and IpPseudoResolver
39  */
40 class ResolverBase
41 {
42 public:
43     virtual ~ResolverBase();
44
45     /**
46      * callbacks should be of type
47      * void resolve_callback(const bool was_success,
48      *                       const int cname_count)
49      */
50     void async_resolve(const callback_type &callback);
51     virtual void cancel_resolve() = 0;
52     virtual bool is_resolving() = 0;
53
54     virtual HostAddress get_next_ip() = 0;
55     virtual bool have_up_to_date_ip() = 0;
56     virtual int get_resolved_ip_count() = 0;
57
58 protected:
59     ResolverBase(const IoServiceItem &io_serv,
60                  const std::string &hostname,
61                  const DnsCacheItem &cache );
62
63 // variables
64 protected:
65     IoServiceItem IoService;
66     std::string Hostname;
67     DnsCacheItem Cache;
68     callback_list_type CallbackList;
69
70 // functions for subclasses
71 protected:
72     virtual void do_resolve() = 0;
73
74     void update_cache( const HostAddressVec &new_results ) const;
75     void update_cache( const std::string &cname ) const;
76     void update_cache( const std::string &hostname,
77                        const HostAddressVec &new_results ) const;
78     void update_cache( const std::string &hostname,
79                        const std::string &cname ) const;
80     void update_cache_ttl( const uint32_t ttl ) const;
81
82     HostAddressVec& get_cached_ips_recursively(const std::string host="") const;
83
84     void schedule_callbacks(const bool was_success,
85                             const int cname_count);
86
87 };
88
89 typedef boost::shared_ptr<ResolverBase> ResolverItem;
90
91 #endif
92
93 // (created using vim -- the world's best text editor)
94