1bb4895f0991be928b180b4f1785900d78696b2a
[pingcheck] / src / config / configuration.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 CONFIGURATION_H
21 #define CONFIGURATION_H
22
23 #include <stdint.h>
24
25 #include <string>
26 #include <vector>
27
28 #include <logfunc.hpp>
29
30 #include <boost/shared_ptr.hpp>
31 #include <boost/random/linear_congruential.hpp>
32
33 #include "config/host.h"
34 #include "host/loglevel.h"
35 #include "host/logoutput.h"
36
37 //-----------------------------------------------------------------------------
38 // Configuration
39 //-----------------------------------------------------------------------------
40
41 typedef boost::rand48 rand_gen_type;
42
43 /**
44  * @brief This class works like a POD (Plain Old Data) for configuration options.
45  */
46 class Configuration
47 {
48 public:
49     Configuration();
50     virtual ~Configuration();
51
52     bool get_daemon() const;
53     void set_daemon( bool daemon );
54
55     std::string get_config_file_name() const;
56     void set_config_file_name( const std::string &config_file_name );
57
58     I2n::Logger::LogLevel get_log_level() const;
59     void set_log_level( const I2n::Logger::LogLevel &log_level );
60
61     LogOutput get_log_output() const;
62     void set_log_output( const LogOutput &log_output );
63
64     std::string get_nameserver() const;
65     void set_nameserver( const std::string &nameserver );
66
67     std::string get_source_network_interface() const;
68     void set_source_network_interface(
69             const std::string &source_network_interface
70     );
71
72     int get_hosts_down_limit() const;
73     void set_hosts_down_limit( const int hosts_down_limit );
74
75     int get_ping_fail_limit() const;
76     void set_ping_fail_limit( const int ping_fail_limit );
77
78     std::string get_status_notifier_cmd() const;
79     void set_status_notifier_cmd( const std::string &status_notifier_cmd );
80
81     int get_link_up_interval_in_min() const;
82     void set_link_up_interval_in_min( const int link_up_interval_in_min );
83
84     int get_link_down_interval_in_min() const;
85     void set_link_down_interval_in_min( const int link_down_interval_in_min );
86
87     int get_ping_reply_timeout() const;
88     void set_ping_reply_timeout( const int ping_reply_timeout );
89
90     int get_max_address_resolution_attempts() const;
91     void set_max_address_resolution_attempts(
92             const int max_address_resolution_attempts );
93
94     int get_resolved_ip_ttl_threshold() const;
95     void set_resolved_ip_ttl_threshold(
96             const int resolved_ip_ttl_threshold );
97
98     std::string get_dns_cache_file() const;
99     void set_dns_cache_file(const std::string &dns_cache_file);
100
101     float get_ratio_random_hosts() const;
102     void set_ratio_random_hosts( const float ratio );
103
104     HostList get_hosts() const;
105     void set_hosts( const HostList &hosts_list );
106
107     int get_random_number(const int lowest, const int highest);
108
109     void set_print_version( const bool do_print );
110     bool get_print_version();
111
112     bool randomize_hosts();
113
114 private:
115     bool Daemon;
116     I2n::Logger::LogLevel LoggingLevel;
117     LogOutput LoggingOutput;
118     std::string ConfigFileName;
119     std::string SourceNetworkInterface;
120     std::string NameServer;
121     int HostsDownLimit;
122     int MinHostsDownLimit;
123     int MaxHostsDownLimit;
124     int PingFailLimit;
125     int MinPingFailLimit;
126     int MaxPingFailLimit;
127     std::string StatusNotifierCmd;
128     int LinkUpIntervalInMin;
129     int LinkDownIntervalInMin;
130     int MinStableLinkIntervalInMin;
131     int MaxStableLinkIntervalInMin;
132     int PingReplyTimeout;
133     int MaxAddressResolutionAttempts;
134     int ResolvedIpTtlThreshold;
135     std::string DnsCacheFile;
136     HostList Hosts;
137     float RatioRandomHosts;
138     bool PrintVersion;
139     rand_gen_type RandomNumberGenerator;
140 };
141
142 //-----------------------------------------------------------------------------
143 // ConfigurationItem
144 //-----------------------------------------------------------------------------
145
146 typedef boost::shared_ptr<Configuration> ConfigurationItem;
147
148 #endif // CONFIGURATION_H