v2.11.1 to add sticky-session SIO

### Release v2.11.1 1. Add option to use `transport=websocket` with sticky-session SIO server. Check [Run websocket only mode for Socket.IO #16](#16) 2. Add some Sticky_SIO-related examples
khoih-prog · Dec 12, 2021 · 4df06e4 · 4df06e4
1 parent 2952e55
commit 4df06e4
Show file tree

Hide file tree

Showing 16 changed files with 172 additions and 48 deletions.
diff --git a/README.md b/README.md
diff --git a/changelog.md b/changelog.md
@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Release v2.11.1](#release-v2111)
   * [Major Release v2.11.0](#major-release-v2110)
   * [Release v2.10.1](#release-v2101)
   * [Major Release v2.10.0](#major-release-v2100)
@@ -50,6 +51,11 @@
 
 ## Changelog
 
+### Release v2.11.1
+
+1. Add option to use `transport=websocket` with sticky-session SIO server. Check [Run websocket only mode for Socket.IO #16](https://github.com/khoih-prog/WebSockets_Generic/issues/16)
+2. Add some Sticky_SIO-related examples
+
 ### Major Release v2.11.0
 
 1. Auto detect ESP32 core to use for WT32_ETH01

diff --git a/library.json b/library.json
@@ -1,7 +1,7 @@
 {
   "name": "WebSockets_Generic",
-  "version": "2.11.0",
-  "description": "RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet",
+  "version": "2.11.1",
+  "description": "RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet.  Now supporting websocket only mode for Socket.IO",
   "keywords": "wifi, WiFiNINA, websocket, websockets-server, websockets-client, Teensy, SAM DUE, SAMD, STM32, nRF52, QNEthernet, rp2040, Portenta-H7, ESP32, ESP8266, W5x00, Ethernet, Ethernet2, Ethernet3, EthernetLarge, EthernetENC, UIPEthernet, NativeEthernet, ENC28J60, rpi-pico, http, web, server, client, Mega",
   "authors": [
     {
@@ -81,7 +81,7 @@
     {
       "owner": "khoih-prog",
       "name": "SinricPro_Generic",
-      "version": ">=2.8.3",
+      "version": ">=2.8.4",
       "platforms": ["*"]
     },
     {

diff --git a/library.properties b/library.properties
@@ -1,8 +1,8 @@
 name=WebSockets_Generic
-version=2.11.0
+version=2.11.1
 author=Markus Sattler, Khoi Hoang <[email protected]>
 maintainer=Khoi Hoang <[email protected]>
-sentence=RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet.
+sentence=RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet. Now supporting websocket only mode for Socket.IO
 paragraph=Use v2.2.2+ for ESP, nRF52, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, WT32_ETH01, Portenta_H7, etc.
 category=Communication
 url=https://github.com/khoih-prog/WebSockets_Generic

diff --git a/platformio/platformio.ini b/platformio/platformio.ini
@@ -54,7 +54,7 @@ lib_deps =
   STM32duino LwIP@>=2.1.2
   STM32duino STM32Ethernet@>=1.2.0
   DoubleResetDetector_Generic@>=1.7.3
-  SinricPro_Generic@>=2.8.3
+  SinricPro_Generic@>=2.8.4
   FlashStorage_SAMD@>=1.2.1
   FlashStorage_STM32@~1.1.0
   https://github.com/ssilverman/QNEthernet
@@ -74,7 +74,7 @@ lib_deps =
 ; stm32duino/STM32duino LwIP@>=2.1.2
 ; stm32duino/STM32duino STM32Ethernet@>=1.2.0
 ; khoih-prog/DoubleResetDetector_Generic@>=1.7.3
-; khoih-prog/SinricPro_Generic@>=2.8.3
+; khoih-prog/SinricPro_Generic@>=2.8.4
 ; khoih-prog/FlashStorage_SAMD@~1.2.1
 ; khoih-prog/FlashStorage_STM32@~1.1.0
 ; https://github.com/ssilverman/QNEthernet

diff --git a/src/SocketIOclient_Generic-Impl.h b/src/SocketIOclient_Generic-Impl.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/SocketIOclient_Generic.h b/src/SocketIOclient_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,13 +54,18 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once
 
 #ifndef SOCKET_IO_CLIENT_GENERIC_H_
 #define SOCKET_IO_CLIENT_GENERIC_H_
 
+#if !defined(USING_STICKY_SESSION_SIO)
+  #define USING_STICKY_SESSION_SIO          false
+#endif
+
 #include "WebSockets_Generic.h"
 
 #define EIO_HEARTBEAT_INTERVAL 20000

diff --git a/src/WebSockets4WebServer_Generic.h b/src/WebSockets4WebServer_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSocketsClient_Generic-Impl.h b/src/WebSocketsClient_Generic-Impl.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once
@@ -889,7 +890,12 @@ void WebSocketsClient::sendHeader(WSclient_t * client)
   {
     if (client->cSessionId.length() == 0)
     {
+#if USING_STICKY_SESSION_SIO    
+      #warning Using USING_STICKY_SESSION_SIO with transport=websocket
+      url += WEBSOCKETS_STRING("&transport=websocket");
+#else      
       url += WEBSOCKETS_STRING("&transport=polling");
+#endif      
       ws_header = false;
     }
     else

diff --git a/src/WebSocketsClient_Generic.h b/src/WebSocketsClient_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSocketsDebug_Generic.h b/src/WebSocketsDebug_Generic.h
@@ -24,7 +24,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -50,6 +50,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
   *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSocketsServer_Generic-Impl.h b/src/WebSocketsServer_Generic-Impl.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSocketsServer_Generic.h b/src/WebSocketsServer_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSocketsVersion_Generic.h b/src/WebSocketsVersion_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSockets_Generic-Impl.h b/src/WebSockets_Generic-Impl.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,6 +54,7 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once

diff --git a/src/WebSockets_Generic.h b/src/WebSockets_Generic.h
@@ -28,7 +28,7 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.11.0
+  Version: 2.11.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -54,14 +54,15 @@
   2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
   2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
+  2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
  *****************************************************************************************************************************/
 
 #pragma once
 
 #ifndef WEBSOCKETS_GENERIC_H_
 #define WEBSOCKETS_GENERIC_H_
 
-#define WEBSOCKETS_GENERIC_VERSION        "WebSockets_Generic v2.11.0"
+#define WEBSOCKETS_GENERIC_VERSION        "WebSockets_Generic v2.11.1"
 
 #include "WebSocketsDebug_Generic.h"