X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=src%2Fsocket_handler.cpp;h=11acc81790422af2eb9a0374c0ffb8e9e0114609;hp=f2ddcb6a4b6abd9ccabc1f2645b6af9da133738b;hb=d535333ffe637c9e547e68b792f334c229641520;hpb=07e98688a1a8c3e915ce923f79261a88251a9edd

diff --git a/src/socket_handler.cpp b/src/socket_handler.cpp
index f2ddcb6..11acc81 100644
--- a/src/socket_handler.cpp
+++ b/src/socket_handler.cpp
@@ -38,73 +38,49 @@
 
 #include "socket_handler.hxx"
 #include "t2n_exception.hxx"
+#include "log.hxx"
 
 using namespace std;
 
 namespace libt2n
 {
 
+/// set options like fast reuse and keepalive every socket should have
 void socket_handler::set_socket_options(int sock)
 {
     int i=1;
 
     /* fast reuse enable */
     if (setsockopt(sock,SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i)) < 0)
-    {
-        string err="error setting socket option: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"error setting socket option: " << strerror(errno));
 
     /* keepalive enable */
     if (setsockopt(sock,SOL_SOCKET, SO_KEEPALIVE, &i, sizeof(i)) < 0)
-    {
-        string err="error setting socket option: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"error setting socket option: " << strerror(errno));
 
     /* close on exec */
     int fdflags;
     fdflags=fcntl(sock,F_GETFD, 0);
     if (fdflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
+
     fdflags |= FD_CLOEXEC;
     if (fcntl(sock,F_SETFD,fdflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
 
     /* non-blocking mode */
     int flflags;
     flflags=fcntl(sock,F_GETFL,0);
     if (flflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
+
     flflags |= O_NONBLOCK;
     if (fcntl(sock,F_SETFL,flflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_communication_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
 }
 
+/// close the underlying socket connection. Don't call directly, use the version provided
+/// by the connection class you are using.
 void socket_handler::close()
 {
     // graceful shutdown
@@ -112,6 +88,7 @@ void socket_handler::close()
     ::close(sock);
 }
 
+/// is the underlying socket connection still open?
 bool socket_handler::is_closed()
 {
     int r=fcntl(sock,F_GETFL);
@@ -119,6 +96,11 @@ bool socket_handler::is_closed()
     return !(r & O_ACCMODE);
 }
 
+/** @brief check if new data is waiting on the raw socket
+    @param usec_timeout wait until new data is found, max timeout usecs.
+            -1: wait endless
+            NULL: no timeout
+*/
 bool socket_handler::data_waiting(long long usec_timeout)
 {
     // just our socket
@@ -147,6 +129,12 @@ bool socket_handler::data_waiting(long long usec_timeout)
         return false;
 }
 
+/** @brief read data from the raw socket and copy it into the provided buffer
+    @param buffer the buffer where to append the new data
+    @param usec_timeout wait until new data is found, max timeout usecs.
+            -1: wait endless
+            NULL: no timeout
+*/
 bool socket_handler::fill_buffer(std::string& buffer, long long usec_timeout)
 {
     // fast path for timeout==0
@@ -156,6 +144,10 @@ bool socket_handler::fill_buffer(std::string& buffer, long long usec_timeout)
         return false;
 }
 
+/** @brief read data from the raw socket and copy it into the provided buffer. Returns
+           instantly if no data is waiting.
+    @param buffer the buffer where to append the new data
+*/
 bool socket_handler::fill_buffer(std::string& buffer)
 {
     bool try_again=false;
@@ -170,11 +162,12 @@ bool socket_handler::fill_buffer(std::string& buffer)
         else if (errno == EINTR)
         {
             // interrupted, try again
+            LOGSTREAM(debug,"EINTR received on read(), trying again");
             try_again=true;
         }
         else
         {
-            log(error,string("error reading from socket : ")+strerror(errno));
+            LOGSTREAM(error,"error reading from socket : " << strerror(errno));
             // TODO: exception?
             return false;
         }
@@ -183,13 +176,17 @@ bool socket_handler::fill_buffer(std::string& buffer)
     // End-of-file
     if (nbytes == 0 && !try_again)
     {
+        LOGSTREAM(debug,"0 bytes received on read(), closing connection");
         close();
         return false;
     }
 
     // Data read -> store it
     if (nbytes > 0)
+    {
         buffer.assign(socket_buffer,nbytes);
+        LOGSTREAM(debug,nbytes << " bytes read");
+    }
 
     // more data waiting -> recurse
     if (data_waiting(0))
@@ -201,6 +198,8 @@ bool socket_handler::fill_buffer(std::string& buffer)
         return false;
 }
 
+/// writes raw data to the socket. Don't use directly, use the write() function provided by the 
+/// connection because it encapsulates the data.
 void socket_handler::socket_write(const std::string& data)
 {
     int offset = 0;
@@ -216,22 +215,19 @@ void socket_handler::socket_write(const std::string& data)
                rtn == -1 && (errno == EAGAIN || errno == EINTR))
         {
             usleep (80000);
-            log(debug,"resuming write() call after EAGAIN or EINTR");
+            LOGSTREAM(debug,"resuming write() call after EAGAIN or EINTR");
         }
 
         if (rtn == -1)
         {
-            log(error,string("write() returned ")+strerror(errno));
+            LOGSTREAM(error,"write() returned " << strerror(errno));
             // TODO: exception?
             return;
         }
         else if (rtn != write_size)
         {
-            ostringstream msg;
-            msg << "write() wrote " << rtn << " bytes, should have been " 
-                << write_size << " (complete: " << data.size() << ")";
-
-            log(error,msg.str());
+            LOGSTREAM(error,"write() wrote " << rtn << " bytes, should have been " 
+                << write_size << " (complete: " << data.size() << ")");
 
             // TODO: exception?
             return;
@@ -240,6 +236,8 @@ void socket_handler::socket_write(const std::string& data)
         offset += write_size;
     }
 
+    LOGSTREAM(debug,"wrote " << data.size() << " bytes");
+
     return;
 }