Throw on failed connection to server in stream ctor; refactor test deflect servers

Author: dnachbaur

deflect/Observer.cpp

@@ -40,6 +40,7 @@
 /*********************************************************************/
 
 #include "Observer.h"
+#include "NetworkProtocol.h"
 #include "StreamPrivate.h"
 
 #include <QDataStream>
@@ -49,8 +50,10 @@
 
 namespace deflect
 {
-Observer::Observer()
-    : _impl(new StreamPrivate("", "", Socket::defaultPortNumber, true))
+const unsigned short Observer::defaultPortNumber = DEFAULT_PORT_NUMBER;
+
+Observer::Observer(const unsigned short port)
+    : _impl(new StreamPrivate("", "", port, true))
 {
 }
 

deflect/Observer.h

@@ -69,16 +69,21 @@ class StreamPrivate;
 class Observer
 {
 public:
+    /** The default communication port */
+    static const unsigned short defaultPortNumber;
+
     /**
      * Open a new connection to the Server using environment variables.
      *
      * DEFLECT_HOST  The address of the target Server instance (required).
      * DEFLECT_ID    The identifier for the stream. If not provided, a random
      *               unique identifier will be used.
-     * @throw std::runtime_error if DEFLECT_HOST was not provided.
+     * @param port Port of the Server instance, default 1701.
+     * @throw std::runtime_error if DEFLECT_HOST was not provided or no
+     *                           connection to server could be established
      * @version 1.3
      */
-    DEFLECT_API Observer();
+    DEFLECT_API explicit Observer(unsigned short port = defaultPortNumber);
 
     /**
      * Open a new connection to the Server.
@@ -97,7 +102,8 @@ class Observer
      *             "192.168.1.83". If left empty, the environment variable
      *             DEFLECT_HOST will be used instead.
      * @param port Port of the Server instance, default 1701.
-     * @throw std::runtime_error if no host was provided.
+     * @throw std::runtime_error if no host was provided or no
+     *                           connection to server could be established
      * @version 1.0
      */
     DEFLECT_API Observer(const std::string& id, const std::string& host,

deflect/Socket.cpp

@@ -57,8 +57,6 @@ const int RECEIVE_TIMEOUT_MS = 1000;
 
 namespace deflect
 {
-const unsigned short Socket::defaultPortNumber = DEFAULT_PORT_NUMBER;
-
 Socket::Socket(const std::string& host, const unsigned short port)
     : _host(host)
     , _socket(new QTcpSocket(this)) // Ensure that _socket parent is

deflect/Socket.h

@@ -66,16 +66,12 @@ class Socket : public QObject
     Q_OBJECT
 
 public:
-    /** The default communication port */
-    static const unsigned short defaultPortNumber;
-
     /**
      * Construct a Socket and connect to host.
      * @param host The target host (IP address or hostname)
      * @param port The target port
      */
-    DEFLECT_API Socket(const std::string& host,
-                       unsigned short port = defaultPortNumber);
+    DEFLECT_API Socket(const std::string& host, unsigned short port);
 
     /** Destruct a Socket, disconnecting from host. */
     DEFLECT_API ~Socket() = default;

deflect/Stream.cpp

@@ -44,8 +44,8 @@
 
 namespace deflect
 {
-Stream::Stream()
-    : Observer(new StreamPrivate("", "", Socket::defaultPortNumber, false))
+Stream::Stream(const unsigned short port)
+    : Observer(new StreamPrivate("", "", port, false))
 {
 }
 

deflect/Stream.h

@@ -68,10 +68,12 @@ class Stream : public Observer
      * DEFLECT_HOST  The address of the target Server instance (required).
      * DEFLECT_ID    The identifier for the stream. If not provided, a random
      *               unique identifier will be used.
-     * @throw std::runtime_error if DEFLECT_HOST was not provided.
+     * @param port Port of the Server instance, default 1701.
+     * @throw std::runtime_error if DEFLECT_HOST was not provided or no
+     *                           connection to server could be established
      * @version 1.3
      */
-    DEFLECT_API Stream();
+    DEFLECT_API explicit Stream(unsigned short port = defaultPortNumber);
 
     /**
      * Open a new connection to the Server.
@@ -91,7 +93,8 @@ class Stream : public Observer
      *             "192.168.1.83". If left empty, the environment variable
      *             DEFLECT_HOST will be used instead.
      * @param port Port of the Server instance, default 1701.
-     * @throw std::runtime_error if no host was provided.
+     * @throw std::runtime_error if no host was provided or no
+     *                           connection to server could be established
      * @version 1.0
      */
     DEFLECT_API Stream(const std::string& id, const std::string& host,

deflect/StreamPrivate.cpp

@@ -86,7 +86,8 @@ StreamPrivate::StreamPrivate(const std::string& id_, const std::string& host,
     , sendWorker{socket, id}
 {
     if (!socket.isConnected())
-        return;
+        throw std::runtime_error(
+            "Connection to deflect server could not be established");
 
     socket.connect(&socket, &Socket::disconnected, [this]() {
         if (disconnectedCallback)

deflect/StreamSendWorker.cpp

@@ -167,16 +167,15 @@ Stream::Future StreamSendWorker::enqueueImage(const ImageWrapper& image,
 {
     if (_pendingFinish)
     {
-        return make_exception_future<bool>(std::make_exception_ptr(
-            std::invalid_argument("Pending finish, no send allowed")));
+        return make_exception_future<bool>(
+            std::invalid_argument("Pending finish, no send allowed"));
     }
 
     if (image.compressionPolicy != COMPRESSION_ON && image.pixelFormat != RGBA)
     {
-        return make_exception_future<bool>(
-            std::make_exception_ptr(std::invalid_argument(
-                "Currently, RAW images can only be sent in RGBA format. Other "
-                "formats support remain to be implemented.")));
+        return make_exception_future<bool>(std::invalid_argument(
+            "Currently, RAW images can only be sent in RGBA format. Other "
+            "formats support remain to be implemented."));
     }
 
     if (image.compressionPolicy == COMPRESSION_ON)
@@ -187,7 +186,7 @@ Stream::Future StreamSendWorker::enqueueImage(const ImageWrapper& image,
             msg << "JPEG compression quality must be between 1 and 100, got "
                 << image.compressionQuality << std::endl;
             return make_exception_future<bool>(
-                std::make_exception_ptr(std::invalid_argument(msg.str())));
+                std::invalid_argument(msg.str()));
         }
     }
 

deflect/types.h

@@ -82,12 +82,17 @@ std::future<T> make_ready_future(T&& value)
 }
 
 template <typename T>
-std::future<T> make_exception_future(std::exception_ptr exc)
+std::future<T> make_exception_future(std::exception_ptr&& e)
 {
     std::promise<T> promise;
-    promise.set_exception(exc);
+    promise.set_exception(std::move(e));
     return promise.get_future();
 }
+template <typename T, typename Exception>
+std::future<T> make_exception_future(Exception&& e)
+{
+    return make_exception_future<T>(std::make_exception_ptr(std::move(e)));
+}
 
 class EventReceiver;
 class Frame;