Change license from LGPL to GPL version 2 + linking exception. This fixes C++ templat...
[libt2n] / src / socket_client.cpp
index 1f5dccf..9f0064b 100644 (file)
@@ -1,21 +1,24 @@
-/***************************************************************************
- *   Copyright (C) 2006 by Gerd v. Egidy                                   *
- *   gve@intra2net.com                                                     *
- *                                                                         *
- *   This library is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU Lesser General Public License version   *
- *   2.1 as published by the Free Software Foundation.                     *
- *                                                                         *
- *   This library is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU Lesser General Public License for more details.                   *
- *                                                                         *
- *   You should have received a copy of the GNU Lesser General Public      *
- *   License along with this program; if not, write to the                 *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
- ***************************************************************************/
+/*
+Copyright (C) 2006 by Intra2net AG - Gerd v. Egidy
+
+The software in this package is distributed under the GNU General
+Public License version 2 (with a special exception described below).
+
+A copy of GNU General Public License (GPL) is included in this distribution,
+in the file COPYING.GPL.
+
+As a special exception, if other files instantiate templates or use macros
+or inline functions from this file, or you compile this file and link it
+with other works to produce a work based on this file, this file
+does not by itself cause the resulting work to be covered
+by the GNU General Public License.
+
+However the source code for this file must still be made available
+in accordance with section (3) of the GNU General Public License.
+
+This exception does not invalidate any other reasons why a work based
+on this file might be covered by the GNU General Public License.
+*/
 
 #include <stdio.h>
 #include <errno.h>
@@ -44,6 +47,7 @@ using namespace std;
 namespace libt2n
 {
 
+/// returns a closed connection if connection could not be established, call get_last_error_msg() for details
 socket_client_connection::socket_client_connection(int _port, const std::string& _server, 
             long long _connect_timeout_usec, int _max_retries,
             std::ostream *_logstream, log_level_values _log_level)
@@ -57,11 +61,23 @@ socket_client_connection::socket_client_connection(int _port, const std::string&
 
     set_logging(_logstream,_log_level);
 
-    tcp_connect(max_retries);
+    try
+    {
+        tcp_connect(max_retries);
+    }
+    catch (t2n_communication_error &e)
+    {
+        lastErrorMsg=e.what();
+        LOGSTREAM(debug,"tcp connect error: " << lastErrorMsg);
+        // FIXME: Don't call virtual function in constructor. Currently not dangerous but bad design.
+        close();
+    }
 
-    do_callbacks(new_connection);
+    if (!connection::is_closed())
+        do_callbacks(new_connection);
 }
 
+/// returns a closed connection if connection could not be established, call get_last_error_msg() for details
 socket_client_connection::socket_client_connection(const std::string& _path,
             long long _connect_timeout_usec, int _max_retries,
             std::ostream *_logstream, log_level_values _log_level)
@@ -74,11 +90,32 @@ socket_client_connection::socket_client_connection(const std::string& _path,
 
     set_logging(_logstream,_log_level);
 
-    unix_connect(max_retries);
+    try
+    {
+        unix_connect(max_retries);
+    }
+    catch (t2n_communication_error &e)
+    {
+        lastErrorMsg=e.what();
+        LOGSTREAM(debug,"unix connect error: " << lastErrorMsg);
+        // FIXME: Don't call virtual function in constructor. Currently not dangerous
+        close();
+    }
+
+    if (!connection::is_closed())
+        do_callbacks(new_connection);
+}
 
-    do_callbacks(new_connection);
+/**
+ * Destructor. Closes an open connection.
+ */
+socket_client_connection::~socket_client_connection()
+{
+    // Destructor of socket_handler will close the socket!
 }
 
+
+/// establish a connection via tcp
 void socket_client_connection::tcp_connect(int max_retries)
 {
     struct sockaddr_in sock_addr;
@@ -114,10 +151,11 @@ void socket_client_connection::tcp_connect(int max_retries)
             tcp_connect(max_retries-1);
         }
         else
-            LOGSTREAM(debug,"no more retries left after connect error");
+            throw t2n_connect_error("no more retries left after connect error");
     }
 }
 
+/// establish a connection via unix-socket
 void socket_client_connection::unix_connect(int max_retries)
 {
     struct sockaddr_un unix_addr;
@@ -142,14 +180,26 @@ void socket_client_connection::unix_connect(int max_retries)
             unix_connect(max_retries-1);
         }
         else
-            LOGSTREAM(debug,"no more retries left after connect error");
+            throw t2n_connect_error("no more retries left after connect error");
     }
 }
 
+/// execute a connect on a prepared socket (tcp or unix) respecting timeouts
 void socket_client_connection::connect_with_timeout(struct sockaddr *sock_addr,unsigned int sockaddr_size)
 {
     set_socket_options(sock);
 
+   /* non-blocking mode */
+    int flflags;
+    flflags=fcntl(sock,F_GETFL,0);
+    if (flflags < 0)
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
+
+    flflags &= (O_NONBLOCK ^ 0xFFFF);
+    if (fcntl(sock,F_SETFL,flflags) < 0)
+        EXCEPTIONSTREAM(error,t2n_communication_error,"fcntl error on socket: " << strerror(errno));
+
+
     LOGSTREAM(debug,"connect_with_timeout()");
     int ret=::connect(sock,sock_addr, sockaddr_size);
 
@@ -183,25 +233,16 @@ void socket_client_connection::connect_with_timeout(struct sockaddr *sock_addr,u
                     ret < 0 && errno==EINTR);
 
             if (ret < 0)
-            {
-                LOGSTREAM(debug,"connect_with_timeout(): select error: " << strerror(errno));
                 throw t2n_connect_error(string("connect() error (select): ")+strerror(errno));
-            }
 
             socklen_t sopt=sizeof(int);
             int valopt;
             ret=getsockopt(sock, SOL_SOCKET, SO_ERROR, (void*)(&valopt), &sopt);
             if (ret < 0 || valopt)
-            {
-                LOGSTREAM(debug,"connect_with_timeout(): getsockopt error: " << strerror(errno));
                 throw t2n_connect_error(string("connect() error (getsockopt): ")+strerror(errno));
-            }
         }
         else
-        {
-            LOGSTREAM(debug,"connect_with_timeout(): error: " << strerror(errno));
             throw t2n_connect_error(string("connect() error: ")+strerror(errno));
-        }
     }
 
     LOGSTREAM(debug,"connect_with_timeout(): success");
@@ -217,6 +258,8 @@ void socket_client_connection::close()
 }
 
 /** @brief try to reconnect the current connection with the same connection credentials (host and port or path)
+
+    @note will throw an exeption if reconnecting not possible
 */
 void socket_client_connection::reconnect()
 {
@@ -232,12 +275,10 @@ void socket_client_connection::reconnect()
     else if (type == unix_s)
         unix_connect(max_retries);
 
-    LOGSTREAM(debug,"reconnect(): basic connection established");
-
+    // connection is open now, otherwise an execption would have been thrown
     reopen();
 
     LOGSTREAM(debug,"reconnect() done, client_connection::is_closed() now " << client_connection::is_closed());
-
 }
 
 }