Included doxygen comments to member variables.
authorGuilherme Maciel Ferreira <guilherme.maciel.ferreira@intra2net.com>
Thu, 28 Apr 2011 14:24:01 +0000 (16:24 +0200)
committerGuilherme Maciel Ferreira <guilherme.maciel.ferreira@intra2net.com>
Thu, 28 Apr 2011 14:24:01 +0000 (16:24 +0200)
16 files changed:
src/config/host.h
src/dns/dnsresolver.h
src/dns/hostaddress.h
src/dns/timetolive.h
src/host/boostpinger.h
src/host/hoststatusanalyzer.h
src/host/pinginterval.h
src/host/pingscheduler.h
src/icmp/icmpdestinationunreachablemessage.h
src/icmp/icmpechoreplymessage.h
src/icmp/icmpechorequestmessage.h
src/icmp/icmpheader.h
src/icmp/icmpmessagepayload.h
src/icmp/icmppacket.h
src/link/linkstatusanalyzer.h
src/link/statusnotifiercommand.h

index ef0adf0..c6f7ff7 100644 (file)
@@ -31,9 +31,13 @@ public:
     void set_options( const std::vector<std::string> &options );
 
 private:
+    /// the address of the host
     std::string Address;
+    /// the port of the host
     uint16_t Port;
+    /// the interval between each ping to the host
     int IntervalInSec;
+    /// options
     std::vector<std::string> Options;
 
 };
index 4b61f18..6c46218 100644 (file)
@@ -38,8 +38,11 @@ private:
     );
 
 private:
+    /// the list of IPs available to the host DNS
     std::list<HostAddress> ResolvedHostAddressList;
+    /// the DNS of the host
     const std::string HostDnsAddress;
+    /// the address of the server which can resolve the host address
     const std::string NameServer;
 
 };
index 7ffd031..8dd8967 100644 (file)
@@ -26,7 +26,9 @@ public:
     void set_ttl( const TimeToLive &ttl );
 
 private:
+    /// IP address of the host
     std::string Ip;
+    /// time-to-live of the host IP
     TimeToLive Ttl;
 
 };
index 4f17302..e82f40c 100644 (file)
@@ -19,7 +19,10 @@ public:
     int get_updated_value() const;
 
 private:
+    /// the numeric time-to-live
     int Ttl;
+    /// the time when the time-to-live was set, so it is possible to know the
+    /// elapsed time
     boost::posix_time::ptime TtlSetTime;
 };
 
index 1ed7233..d5b902a 100644 (file)
@@ -66,15 +66,26 @@ private:
     );
 
 private:
+    /// io service object, which has the loop event
     boost::asio::io_service &IoService;
+    /// the destination host
     boost::asio::ip::icmp::endpoint DestinationEndpoint;
+    /// the socket object
     boost::asio::ip::icmp::socket Socket;
+    /// the timer of ICMP packet receive, triggers the timeout to avoid infinite
+    /// wait
     boost::asio::deadline_timer IcmpPacketReceiveTimer;
+    /// ICMP packet sequence_number
     uint16_t SequenceNumber;
+    /// the time when the last ICMP packet was sent
     boost::posix_time::ptime TimeSent;
+    /// the buffer where the data received will be placed
     boost::asio::streambuf ReplyBuffer;
+    /// number of replies to the ICMP echo request
     int RepliesCount;
+    /// the amount of time to wait for the reply
     int EchoReplyTimeoutInSec;
+    /// the status of the pinger
     BoostPinger::PingStatus PingerStatus;
 
 };
index 884a8b5..6de848a 100644 (file)
@@ -39,12 +39,20 @@ private:
     void analyze_ping_failed_count();
 
 private:
+    /// the DNS address of the host to analyze
     std::string HostAddress;
+    /// the object responsible to analyze the link
     const boost::shared_ptr<LinkStatusAnalyzer> LinkAnalyzer;
+    /// the maximum amount of pings that can fail without warning
     int PingFailPercentageLimit;
+    /// the amount of IPs that are aliases to the host DNS
     int ResolvedIpCount;
+    /// the amount of pings sent until now
     int PingsPerformedCount;
+    /// the amount of pings sent that failed until now
     int PingsFailedCount;
+    /// boolean flag that indicate if the last set of failed pings exceed the
+    /// limit
     bool ExceededPingFailedLimit;
 
 };
index 1fe84e0..badf77f 100644 (file)
@@ -31,7 +31,9 @@ private:
     bool can_speed_up() const;
 
 private:
+    /// the original interval to ping, unchangeable
     const PingIntervalType OriginalInterval;
+    /// the actual interval exported by this object
     PingIntervalType Interval;
 
 };
index 345e995..5ca1a0b 100644 (file)
@@ -46,12 +46,19 @@ private:
     void update_ping_elapsed_time();
 
 private:
+    /// service object, which has the event loop
     boost::asio::io_service &IoService;
+    /// name of the network device used to send the packets
     std::string LocalNetworkInterfaceName;
+    /// timer to trigger the next ping
     boost::asio::deadline_timer NextPingTimer;
+    /// keeps track of the time when the last ping was send
     boost::posix_time::ptime TimeSentLastPing;
+    /// interval between each ping to the same host
     PingInterval PingIntervalInSec;
+    /// the list of IPs which are aliases to the host DNS
     DnsResolver IpList;
+    /// object responsible to evaluate the status of the host
     HostStatusAnalyzer HostAnalyzer;
 
 };
index cc7ef09..093b97c 100644 (file)
@@ -61,6 +61,7 @@ public:
     std::ostream& write( std::ostream &os ) const;
 
 private:
+    /// packet payload object
     IcmpMessagePayload Payload;
 
 };
index d136de9..880d580 100644 (file)
@@ -57,6 +57,7 @@ public:
     std::ostream& write( std::ostream &os ) const;
 
 private:
+    /// packet payload object
     IcmpMessagePayload Payload;
 
 };
index 4e96fe9..92f2f4a 100644 (file)
@@ -57,6 +57,7 @@ public:
     std::ostream& write( std::ostream &os ) const;
 
 private:
+    /// packet payload object
     IcmpMessagePayload Payload;
 
 };
index 035b736..43203a5 100644 (file)
@@ -71,6 +71,7 @@ public:
     );
 
 private:
+    /// changeable pointer to different ICMP messages types
     boost::shared_ptr<IcmpMessage> MessageFormat;
 
 };
index eed2e52..3e77fa4 100644 (file)
@@ -41,7 +41,9 @@ public:
     std::ostream& write( std::ostream &os ) const;
 
 private:
+    /// the size of the payload buffer
     const std::size_t PayloadSizeInBytes;
+    /// the payload buffer
     boost::scoped_array<uint8_t> Payload;
 
     NONCOPYABLE( IcmpMessagePayload )
index 43e470b..b232fee 100644 (file)
@@ -83,8 +83,11 @@ public:
     );
 
 private:
+    /// the IP header object
     Ipv4Header IpHeader;
+    /// the ICMP header
     IcmpHeader IcmpPayloadHeader;
+    /// the ICMP data
     IcmpData IcmpPayloadData;
 };
 
index 3414bc7..b08f376 100644 (file)
@@ -62,17 +62,17 @@ private:
 private:
     /// the maximum amount of hosts which can be down before sound the alarm
     const int HostsDownLimit;
-    /// list of host down (obvious isn't it?)
+    /// list of hosts down (obvious isn't it?)
     std::set<std::string> HostsDownList;
     /// interval the link have to be stable in order to consider it is functional
     const int LinkUpIntervalInMin;
     /// keep track of the actual link status
     LinkStatusAnalyzer::LinkStatus CurrentLinkStatus;
-    /// indicates if was notified the last link status change
+    /// indicates if the last link status change was notified
     LinkStatusAnalyzer::NotificationStatus CurrentNotificationStatus;
     /// when was the last time the status changed
     boost::posix_time::ptime TimeLinkStatusChanged;
-    ///
+    /// command used to notify the status of the link
     StatusNotifierCommand StatusNotifierCmd;
 
 
index 06e0870..ac7d34b 100644 (file)
@@ -32,6 +32,7 @@ private:
     std::string get_arguments_string() const;
 
 private:
+    /// the command string used to notify the status
     std::string CommandStr;
 
 };