add an option to easily disable per message deflate compression

DOCKER_VERSION

@@ -1 +1 @@
-2.2.1
+3.1.1

README.md

@@ -28,6 +28,9 @@ webSocket.setUrl(url);
 // to make sure that load balancers do not kill an idle connection.
 webSocket.setHeartBeatPeriod(45);
 
+// Per message deflate connection is enabled by default. You can tweak its parameters or disable it
+webSocket.disablePerMessageDeflate();
+
 // Setup a callback to be fired when a message or an event (open, close, error) is received
 webSocket.setOnMessageCallback(
     [](ix::WebSocketMessageType messageType,
@@ -255,7 +258,7 @@ No manual polling to fetch data is required. Data is sent and received instantly
 
 ### Automatic reconnection
 
-If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds.
+If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds. This behavior can be disabled.
 
 ### Large messages
 

ixwebsocket/IXWebSocket.cpp

@@ -135,6 +135,13 @@ namespace ix
         _enablePong = false;
     }
 
+    void WebSocket::disablePerMessageDeflate()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        WebSocketPerMessageDeflateOptions perMessageDeflateOptions(false);
+        _perMessageDeflateOptions = perMessageDeflateOptions;
+    }
+
     void WebSocket::start()
     {
         if (_thread.joinable()) return; // we've already been started

ixwebsocket/IXWebSocket.h

@@ -95,6 +95,7 @@ namespace ix
         void setPingTimeout(int pingTimeoutSecs);
         void enablePong();
         void disablePong();
+        void disablePerMessageDeflate();
 
         // Run asynchronously, by calling start and stop.
         void start();

makefile

@@ -9,7 +9,7 @@ install: brew
 # on osx it is good practice to make /usr/local user writable
 # sudo chown -R `whoami`/staff /usr/local
 brew:
-	mkdir -p build && (cd build ; cmake -DUSE_TLS=1 -DUSE_WS=1 -DUSE_MBED_TLS=1 .. ; make -j install)
+	mkdir -p build && (cd build ; cmake -DUSE_TLS=1 -DUSE_WS=1 .. ; make -j install)
 
 ws:
 	mkdir -p build && (cd build ; cmake -DUSE_TLS=1 -DUSE_WS=1 -DUSE_MBED_TLS=1 .. ; make -j)
@@ -44,7 +44,7 @@ trail:
 	sh third_party/remote_trailing_whitespaces.sh
 
 format:
-	find ixwebsocket ws -name '*.cpp' -o -name '*.h' -exec clang-format -i {} \;
+	find test ixwebsocket ws -name '*.cpp' -o -name '*.h' -exec clang-format -i {} \;
 
 # That target is used to start a node server, but isn't required as we have 
 # a builtin C++ server started in the unittest now

test/IXTest.h

@@ -6,13 +6,13 @@
 
 #pragma once
 
-#include <string>
-#include <vector>
-#include <sstream>
 #include <iostream>
+#include <ixwebsocket/IXWebSocketServer.h>
 #include <mutex>
 #include <spdlog/spdlog.h>
-#include <ixwebsocket/IXWebSocketServer.h>
+#include <sstream>
+#include <string>
+#include <vector>
 
 namespace ix
 {
@@ -29,7 +29,7 @@ namespace ix
     struct Logger
     {
     public:
-            template <typename T>
+        template<typename T>
         Logger& operator<<(T const& obj)
         {
             std::lock_guard<std::mutex> lock(_mutex);
@@ -49,4 +49,4 @@ namespace ix
     int getFreePort();
 
     bool startWebSocketEchoServer(ix::WebSocketServer& server);
-}
+} // namespace ix

ws/IXSentryClient.h

@@ -6,10 +6,10 @@
 
 #pragma once
 
+#include <algorithm>
 #include <ixwebsocket/IXHttpClient.h>
 #include <jsoncpp/json/json.h>
 #include <regex>
-#include <algorithm>
 
 namespace ix
 {

ws/ws.cpp

@@ -80,6 +80,7 @@ int main(int argc, char** argv)
     bool strict = false;
     bool stress = false;
     bool disableAutomaticReconnection = false;
+    bool disablePerMessageDeflate = false;
     int port = 8008;
     int redisPort = 6379;
     int statsdPort = 8125;
@@ -110,6 +111,7 @@ int main(int argc, char** argv)
     CLI::App* connectApp = app.add_subcommand("connect", "Connect to a remote server");
     connectApp->add_option("url", url, "Connection url")->required();
     connectApp->add_flag("-d", disableAutomaticReconnection, "Disable Automatic Reconnection");
+    connectApp->add_flag("-x", disablePerMessageDeflate, "Disable per message deflate");
 
     CLI::App* chatApp = app.add_subcommand("chat", "Group chat");
     chatApp->add_option("url", url, "Connection url")->required();
@@ -241,7 +243,8 @@ int main(int argc, char** argv)
     }
     else if (app.got_subcommand("connect"))
     {
-        ret = ix::ws_connect_main(url, disableAutomaticReconnection);
+        ret = ix::ws_connect_main(url, disableAutomaticReconnection,
+                                  disablePerMessageDeflate);
     }
     else if (app.got_subcommand("chat"))
     {

ws/ws.h

@@ -30,7 +30,9 @@ namespace ix
 
     int ws_chat_main(const std::string& url, const std::string& user);
 
-    int ws_connect_main(const std::string& url, bool disableAutomaticReconnection);
+    int ws_connect_main(const std::string& url,
+                        bool disableAutomaticReconnection,
+                        bool disablePerMessageDeflate);
 
     int ws_receive_main(const std::string& url, bool enablePerMessageDeflate, int delayMs);
 

ws/ws_connect.cpp

@@ -15,7 +15,8 @@ namespace ix
     {
         public:
             WebSocketConnect(const std::string& _url,
-                             bool disableAutomaticReconnection);
+                             bool disableAutomaticReconnection,
+                             bool disablePerMessageDeflate);
 
             void subscribe(const std::string& channel);
             void start();
@@ -26,13 +27,16 @@ namespace ix
         private:
             std::string _url;
             ix::WebSocket _webSocket;
+            bool _disablePerMessageDeflate;
 
             void log(const std::string& msg);
     };
 
     WebSocketConnect::WebSocketConnect(const std::string& url,
-                                       bool disableAutomaticReconnection) :
+                                       bool disableAutomaticReconnection,
-        _url(url)
+                                       bool disablePerMessageDeflate) :
+        _url(url),
+        _disablePerMessageDeflate(disablePerMessageDeflate)
     {
         if (disableAutomaticReconnection)
         {
@@ -54,9 +58,16 @@ namespace ix
     {
         _webSocket.setUrl(_url);
 
+        if (_disablePerMessageDeflate)
+        {
+            _webSocket.disablePerMessageDeflate();
+        }
+        else
+        {
             ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(
                 true, false, false, 15, 15);
             _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
+        }
 
         std::stringstream ss;
         log(std::string("Connecting to url: ") + _url);
@@ -130,10 +141,14 @@ namespace ix
         _webSocket.send(text);
     }
 
-    int ws_connect_main(const std::string& url, bool disableAutomaticReconnection)
+    int ws_connect_main(const std::string& url,
+                        bool disableAutomaticReconnection,
+                        bool disablePerMessageDeflate)
     {
         std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
-        WebSocketConnect webSocketChat(url, disableAutomaticReconnection);
+        WebSocketConnect webSocketChat(url,
+                                       disableAutomaticReconnection,
+                                       disablePerMessageDeflate);
         webSocketChat.start();
 
         while (true)