From ab2cb1efa20341886cc82c2da42151ea7237f88d Mon Sep 17 00:00:00 2001
From: Christian Herdtweck <christian.herdtweck@intra2net.com>
Date: Mon, 12 Jan 2015 15:35:48 +0100
Subject: [PATCH] update docu messages for io_service

---
 src/host/pingerfactory.cpp |    2 +-
 src/host/pingrotate.cpp    |    2 +-
 src/host/pingscheduler.cpp |    9 +++++----
 src/icmp/icmppinger.cpp    |    2 +-
 4 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/src/host/pingerfactory.cpp b/src/host/pingerfactory.cpp
index 57d0b44..2ad9fbc 100644
--- a/src/host/pingerfactory.cpp
+++ b/src/host/pingerfactory.cpp
@@ -62,7 +62,7 @@ PingerFactory::~PingerFactory()
  * @brief Create a Pinger object suitable to the given protocol.
  *
  * @param protocol One of the available ping protocols.
- * @param io_serv The @c io_service object.
+ * @param io_serv The one @c io_service object that controls async processing
  * @param network_interface The network interface name from where the ping
  * packet will be sent.
  * @return a Pinger object to able to ping using the given protocol.
diff --git a/src/host/pingrotate.cpp b/src/host/pingrotate.cpp
index 19e2a43..641b58f 100644
--- a/src/host/pingrotate.cpp
+++ b/src/host/pingrotate.cpp
@@ -37,7 +37,7 @@ using boost::shared_ptr;
 /**
  * @brief Parameterized constructor.
  *
- * @param io_serv The @c io_service object.
+ * @param io_serv The one @c io_service object that controls async processing
  * @param network_interface The name of the network interface from where to
  * dispatch the pings.
  * @param destination_address The remote address to ping.
diff --git a/src/host/pingscheduler.cpp b/src/host/pingscheduler.cpp
index b11cbf1..65b5a3e 100644
--- a/src/host/pingscheduler.cpp
+++ b/src/host/pingscheduler.cpp
@@ -49,6 +49,7 @@ using I2n::Logger::GlobalLogger;
 /**
  * @brief Parameterized constructor.
  *
+ * @param io_serv The one @c io_serv object that controls async processing
  * @param network_interface The name of the network interface originating the pings.
  * @param destination_address The remote address to ping.
  * @param destination_port The remote port to ping.
@@ -60,7 +61,7 @@ using I2n::Logger::GlobalLogger;
  * @param first_delay Delay in seconds from start_pinging to first ping attempt
  */
 PingScheduler::PingScheduler(
-        const IoServiceItem io_service,
+        const IoServiceItem io_serv,
         const string &network_interface,
         const string &destination_address,
         const uint16_t destination_port,
@@ -75,8 +76,8 @@ PingScheduler::PingScheduler(
         const int first_delay
 
 ) :
-    NextPingTimer( *io_service ),
-    NextAddressTimer( *io_service ),
+    NextPingTimer( *io_serv ),
+    NextAddressTimer( *io_serv ),
     TimeSentLastPing( microsec_clock::universal_time() ),
     PingIntervalInSec( ping_interval_in_sec ),
     AddressResolveIntervalInSec( ping_interval_in_sec ),
@@ -96,7 +97,7 @@ PingScheduler::PingScheduler(
 
     Ping = PingerFactory::createPinger(
             ping_protocol_list,
-            io_service,
+            io_serv,
             network_interface,
             destination_address,
             destination_port,
diff --git a/src/icmp/icmppinger.cpp b/src/icmp/icmppinger.cpp
index fa76a05..a4e05a6 100644
--- a/src/icmp/icmppinger.cpp
+++ b/src/icmp/icmppinger.cpp
@@ -44,7 +44,7 @@ static const std::size_t SOCKET_BUFFER_SIZE = 65536;   // 64kB
 /**
  * @brief Parameterized constructor.
  *
- * @param io_serv The @c io_service object to control this object.
+ * @param io_serv The one @c io_service object that controls async processing
  * @param protocol The network layer protocol to use.
  * @param source_network_interface The network interface name from where to
  * send the packets.
-- 
1.7.1