Change license from LGPL to GPL version 2 + linking exception. This fixes C++ templat...
[libt2n] / src / socket_client.cpp
index 100ca54..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>
 
 #include "socket_client.hxx"
 #include "t2n_exception.hxx"
+#include "log.hxx"
 
 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)
+            long long _connect_timeout_usec, int _max_retries,
+            std::ostream *_logstream, log_level_values _log_level)
     : client_connection(), socket_handler(0,tcp_s)
 {
     max_retries=_max_retries;
@@ -53,11 +59,28 @@ socket_client_connection::socket_client_connection(int _port, const std::string&
     server=_server;
     port=_port;
 
-    tcp_connect(max_retries);
+    set_logging(_logstream,_log_level);
+
+    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();
+    }
+
+    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)
+            long long _connect_timeout_usec, int _max_retries,
+            std::ostream *_logstream, log_level_values _log_level)
     : client_connection(), socket_handler(0,unix_s)
 {
     max_retries=_max_retries;
@@ -65,9 +88,34 @@ socket_client_connection::socket_client_connection(const std::string& _path,
 
     path=_path;
 
-    unix_connect(max_retries);
+    set_logging(_logstream,_log_level);
+
+    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);
 }
 
+/**
+ * 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;
@@ -98,12 +146,16 @@ void socket_client_connection::tcp_connect(int max_retries)
     {
         // recurse if retries left
         if (max_retries > 0)
+        {
+            LOGSTREAM(debug,"retrying connect after connect error");
             tcp_connect(max_retries-1);
+        }
+        else
+            throw t2n_connect_error("no more retries left after connect error");
     }
-
-    do_callbacks(new_connection);
 }
 
+/// establish a connection via unix-socket
 void socket_client_connection::unix_connect(int max_retries)
 {
     struct sockaddr_un unix_addr;
@@ -123,22 +175,40 @@ void socket_client_connection::unix_connect(int max_retries)
     {
         // recurse if retries left
         if (max_retries > 0)
-            tcp_connect(max_retries-1);
+        {
+            LOGSTREAM(debug,"retrying connect after connect error");
+            unix_connect(max_retries-1);
+        }
+        else
+            throw t2n_connect_error("no more retries left after connect error");
     }
-
-    do_callbacks(new_connection);
 }
 
+/// 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);
 
     if (ret < 0)
     {
         if (errno==EINPROGRESS)
         {
+            LOGSTREAM(debug,"connect_with_timeout(): EINPROGRESS");
+
             /* set timeout */
             struct timeval tval;
             struct timeval *timeout_ptr;
@@ -174,6 +244,8 @@ void socket_client_connection::connect_with_timeout(struct sockaddr *sock_addr,u
         else
             throw t2n_connect_error(string("connect() error: ")+strerror(errno));
     }
+
+    LOGSTREAM(debug,"connect_with_timeout(): success");
 }
 
 void socket_client_connection::close()
@@ -185,4 +257,28 @@ 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()
+{
+    LOGSTREAM(debug,"reconnect()");
+
+    // close the current connection if still open
+    close();
+
+    socket_type_value type=get_type();
+
+    if (type == tcp_s)
+        tcp_connect(max_retries);
+    else if (type == unix_s)
+        unix_connect(max_retries);
+
+    // 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());
+}
+
 }