libt2n: (gerd) more documentation-polishing

[libt2n] / src / socket_handler.cpp

diff --git a/src/socket_handler.cpp b/src/socket_handler.cpp
index 7740780..b2bbcd1 100644 (file)
--- a/src/socket_handler.cpp
+++ b/src/socket_handler.cpp
@@ -159,6 +159,7 @@ void socket_handler::set_write_timeout(long long new_write_timeout)
     @param[in,out] usec_timeout wait until new data is found, max timeout usecs.
             -1: wait endless
             0: return instantly
+    @param[out] usec_timeout_remaining microseconds from the timeout that were not used
 */
 bool socket_handler::data_waiting(long long usec_timeout,long long* usec_timeout_remaining)
 {
@@ -200,11 +201,12 @@ bool socket_handler::data_waiting(long long usec_timeout,long long* usec_timeout
     @param[in,out] usec_timeout wait until new data is found, max timeout usecs.
             -1: wait endless
             0: return instantly
+    @param[out] usec_timeout_remaining microseconds from the timeout that were not used
 */
-bool socket_handler::fill_buffer(std::string& buffer, long long usec_timeout, long long *timeout_remaining)
+bool socket_handler::fill_buffer(std::string& buffer, long long usec_timeout, long long *usec_timeout_remaining)
 {
     // fast path for timeout==0
-    if (usec_timeout==0 || data_waiting(usec_timeout,timeout_remaining))
+    if (usec_timeout==0 || data_waiting(usec_timeout,usec_timeout_remaining))
         return fill_buffer(buffer);
     else
         return false;
@@ -221,6 +223,7 @@ bool socket_handler::fill_buffer(std::string& buffer)
     char socket_buffer[recv_buffer_size];
 
     int nbytes = read (sock, socket_buffer, recv_buffer_size);
+
     if (nbytes < 0)
     {
         if (errno == EAGAIN)