(ixwebsocket server) change legacy api with 2 nested callbacks, so that the first api takes a weak_ptr<WebSocket> as its first argument

docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [10.0.0] - 2020-07-25
+
+(ixwebsocket server) change legacy api with 2 nested callbacks, so that the first api takes a weak_ptr<WebSocket> as its first argument
+
 ## [9.10.7] - 2020-07-25
 
 (ixwebsocket) add WebSocketProxyServer, from ws. Still need to make the interface better.

docs/usage.md

@@ -248,6 +248,8 @@ uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
 
 ### Legacy api
 
+This api was actually changed to take a weak_ptr<WebSocket> as the first argument to setOnConnectionCallback ; previously it would take a shared_ptr<WebSocket> which was creating cycles and then memory leaks problems.
+
 ```cpp
 #include <ixwebsocket/IXWebSocketServer.h>
 
@@ -258,13 +260,16 @@ uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
 ix::WebSocketServer server(port);
 
 server.setOnConnectionCallback(
-    [&server](std::shared_ptr<WebSocket> webSocket,
+    [&server](std::weak_ptr<WebSocket> webSocket,
               std::shared_ptr<ConnectionState> connectionState,
               std::unique_ptr<ConnectionInfo> connectionInfo)
     {
         std::cout << "Remote ip: " << connectionInfo->remoteIp << std::endl;
 
-        webSocket->setOnMessageCallback(
+        auto ws = webSocket.lock();
+        if (ws)
+        {
+            ws->setOnMessageCallback(
                 [webSocket, connectionState, &server](const ix::WebSocketMessagePtr msg)
                 {
                     if (msg->type == ix::WebSocketMessageType::Open)
@@ -292,7 +297,12 @@ server.setOnConnectionCallback(
                         // All connected clients are available in an std::set. See the broadcast cpp example.
                         // Second parameter tells whether we are sending the message in binary or text mode.
                         // Here we send it in the same mode as it was received.
-                    webSocket->send(msg->str, msg->binary);
+                        auto ws = webSocket.lock();
+                        if (ws)
+                        {
+                            ws->send(msg->str, msg->binary);
+                        }
+                    }
                 }
             }
         );

ixwebsocket/IXWebSocketProxyServer.cpp

@@ -53,8 +53,8 @@ namespace ix
         };
         server.setConnectionStateFactory(factory);
 
-        server.setOnConnectionCallback(
-            [remoteUrl, verbose](std::shared_ptr<ix::WebSocket> webSocket,
+        server.setOnConnectionCallback([remoteUrl,
+                                        verbose](std::weak_ptr<ix::WebSocket> webSocket,
                                                  std::shared_ptr<ConnectionState> connectionState,
                                                  std::unique_ptr<ConnectionInfo> connectionInfo) {
             auto state = std::dynamic_pointer_cast<ProxyConnectionState>(connectionState);
@@ -69,12 +69,19 @@ namespace ix
                     }
                     else if (msg->type == ix::WebSocketMessageType::Message)
                     {
-                            webSocket->send(msg->str, msg->binary);
+                        auto ws = webSocket.lock();
+                        if (ws)
+                        {
+                            ws->send(msg->str, msg->binary);
+                        }
                     }
                 });
 
             // Client connection
-                webSocket->setOnMessageCallback(
+            auto ws = webSocket.lock();
+            if (ws)
+            {
+                ws->setOnMessageCallback(
                     [state, remoteUrl, verbose](const WebSocketMessagePtr& msg) {
                         if (msg->type == ix::WebSocketMessageType::Open)
                         {
@@ -101,6 +108,7 @@ namespace ix
                             state->webSocket().send(msg->str, msg->binary);
                         }
                     });
+            }
         });
 
         auto res = server.listen();

ixwebsocket/IXWebSocketServer.h

@@ -23,7 +23,7 @@ namespace ix
     {
     public:
         using OnConnectionCallback =
-            std::function<void(std::shared_ptr<WebSocket>,
+            std::function<void(std::weak_ptr<WebSocket>,
                                std::shared_ptr<ConnectionState>,
                                std::unique_ptr<ConnectionInfo> connectionInfo)>;
 

ixwebsocket/IXWebSocketVersion.h

@@ -6,4 +6,4 @@
 
 #pragma once
 
-#define IX_WEBSOCKET_VERSION "9.10.7"
+#define IX_WEBSOCKET_VERSION "10.0.0"