update canSend with current links2004/arduinoWebSockets 2024-04-17

.github/workflows/main.yml

@@ -37,13 +37,13 @@ jobs:
           echo -en "matrix=" >> $GITHUB_OUTPUT
           echo -en "[" >> $GITHUB_OUTPUT
 
-          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp8266_pico esp8266 1.8.19 esp8266com:esp8266:generic:xtal=80,vt=flash,exception=disabled,stacksmash=disabled,ssl=all,mmu=3232,non32xfer=fast,ResetMethod=nodemcu,CrystalFreq=26,FlashFreq=80,FlashMode=qio,eesz=4M2M,led=2,sdk=nonosdk_190703,ip=lm2f,dbg=Serial1,lvl=SSL,wipe=none,baud=115200 >> $GITHUB_OUTPUT
+          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp8266_pico esp8266 0.35.0 esp8266:esp8266:generic:xtal=80,vt=flash,exception=disabled,stacksmash=disabled,ssl=all,mmu=3232,non32xfer=fast,ResetMethod=nodemcu,CrystalFreq=26,FlashFreq=80,FlashMode=qio,eesz=4M2M,led=2,sdk=nonosdk_190703,ip=lm2f,dbg=Serial1,lvl=SSL,wipe=none,baud=115200 >> $GITHUB_OUTPUT
           echo -en "," >> $GITHUB_OUTPUT
 
-          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp8266_pico esp8266 1.8.19 esp8266com:esp8266:generic:xtal=80,vt=flash,exception=disabled,stacksmash=disabled,ssl=all,mmu=3232,non32xfer=fast,ResetMethod=nodemcu,CrystalFreq=26,FlashFreq=80,FlashMode=qio,eesz=4M2M,led=2,sdk=nonosdk_190703,ip=lm2f,dbg=Disabled,lvl=None____,wipe=none,baud=115200 >> $GITHUB_OUTPUT
+          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp8266_pico esp8266 0.35.0 esp8266:esp8266:generic:xtal=80,vt=flash,exception=disabled,stacksmash=disabled,ssl=all,mmu=3232,non32xfer=fast,ResetMethod=nodemcu,CrystalFreq=26,FlashFreq=80,FlashMode=qio,eesz=4M2M,led=2,sdk=nonosdk_190703,ip=lm2f,dbg=Disabled,lvl=None____,wipe=none,baud=115200 >> $GITHUB_OUTPUT
           echo -en "," >> $GITHUB_OUTPUT
 
-          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp32 esp32 1.8.19 espressif:esp32:esp32:FlashFreq=80 >> $GITHUB_OUTPUT
+          get_sketches_json_matrix arduino $GITHUB_WORKSPACE/examples/esp32 esp32 0.35.0 esp32:esp32:esp32:FlashFreq=80 >> $GITHUB_OUTPUT
 
           echo -en "]" >> $GITHUB_OUTPUT
           echo >> $GITHUB_OUTPUT
@@ -55,9 +55,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        IDE_VERSION: [1.8.19]
+        CLI_VERSION: [0.35.0]
     env:
-      IDE_VERSION: ${{ matrix.IDE_VERSION }}
+      CLI_VERSION: ${{ matrix.CLI_VERSION }}
+      ARDUINO_DIRECTORIES_DATA: /home/runner/arduino_ide
 
     steps:
       - uses: actions/checkout@v2
@@ -68,20 +69,21 @@ jobs:
           echo "date=$(/bin/date -u "+%Y%m%d")" >> $GITHUB_OUTPUT
         shell: bash
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: cache_all
         with:
           path: |
             /home/runner/arduino_ide
             /home/runner/Arduino
-          key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ matrix.IDE_VERSION }}
+          key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ matrix.CLI_VERSION }}-cli
 
       - name: download IDE
         if: steps.cache_all.outputs.cache-hit != 'true'
         run: |
-          wget http://downloads.arduino.cc/arduino-$IDE_VERSION-linux64.tar.xz -q
-          tar xf arduino-$IDE_VERSION-linux64.tar.xz
-          mv arduino-$IDE_VERSION $HOME/arduino_ide
+          wget https://github.com/arduino/arduino-cli/releases/download/v${CLI_VERSION}/arduino-cli_${CLI_VERSION}_Linux_64bit.tar.gz -q
+          tar xf arduino-cli_${CLI_VERSION}_Linux_64bit.tar.gz
+          mkdir -p $ARDUINO_DIRECTORIES_DATA
+          mv arduino-cli $ARDUINO_DIRECTORIES_DATA/
 
       - name: download ArduinoJson
         if: steps.cache_all.outputs.cache-hit != 'true'
@@ -91,17 +93,12 @@ jobs:
           unzip 6.x.zip
           mv ArduinoJson-6.x $HOME/Arduino/libraries/ArduinoJson
 
-      - name: download esp8266
+      - name: download cores
         if: steps.cache_all.outputs.cache-hit != 'true'
         run: |
+          export PATH="$ARDUINO_DIRECTORIES_DATA:$PATH"
           source $GITHUB_WORKSPACE/travis/common.sh
-          get_core esp8266
-
-      - name: download esp32
-        if: steps.cache_all.outputs.cache-hit != 'true'
-        run: |
-          source $GITHUB_WORKSPACE/travis/common.sh
-          get_core esp32
+          get_core_cli
 
   build:
     needs: [prepare_ide, prepare_example_json]
@@ -113,8 +110,9 @@ jobs:
     env:
       CPU: ${{ matrix.cpu }}
       BOARD: ${{ matrix.board }}
-      IDE_VERSION: ${{ matrix.ideversion }}
+      CLI_VERSION: ${{ matrix.cliversion }}
       SKETCH: ${{ matrix.sketch }}
+      ARDUINO_DIRECTORIES_DATA: /home/runner/arduino_ide
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -130,13 +128,13 @@ jobs:
           echo "date=$(/bin/date -u "+%Y%m%d")" >> $GITHUB_OUTPUT
         shell: bash
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: cache_all
         with:
           path: |
             /home/runner/arduino_ide
             /home/runner/Arduino
-          key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ matrix.ideversion }}
+          key: ${{ runner.os }}-${{ steps.get-date.outputs.date }}-${{ matrix.cliversion }}-cli
 
       - name: install python serial
         if: matrix.cpu == 'esp32'
@@ -145,41 +143,24 @@ jobs:
           sudo pip install pyserial
 #          sudo apt install python-is-python3
 
-      - name: start DISPLAY
-        run: |
-          /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16
-          export DISPLAY=:1.0
-          sleep 3
-
       - name: test IDE
         run: |
-          export PATH="$HOME/arduino_ide:$PATH"
-          which arduino
+          export PATH="$ARDUINO_DIRECTORIES_DATA:$PATH"
+          which arduino-cli
 
       - name: copy code
         run: |
           mkdir -p $HOME/Arduino/libraries/
           cp -r $GITHUB_WORKSPACE $HOME/Arduino/libraries/arduinoWebSockets
 
-      - name: config IDE
-        run: |
-          set +x
-          export DISPLAY=:1.0
-          export PATH="$HOME/arduino_ide:$PATH"
-          arduino --board $BOARD --save-prefs
-          arduino --pref update.check=false --pref build.verbose=false --pref cache.enable=true --pref compiler.cache_core=true --pref compiler.warning_level=default --save-prefs
-          arduino --get-pref sketchbook.path
-          arduino --get-pref
-
       - name: build example
         timeout-minutes: 20
         run: |
           set -ex
-          export DISPLAY=:1.0
           export PATH="$HOME/arduino_ide:$PATH"
           source $GITHUB_WORKSPACE/travis/common.sh
           cd $GITHUB_WORKSPACE
-          build_sketch arduino $SKETCH
+          build_sketch_cli "$SKETCH" "$BOARD"
 
   done:
     needs: [prepare_ide, prepare_example_json, build, check_version_files]

src/SocketIOclient.cpp

@@ -15,39 +15,39 @@ SocketIOclient::SocketIOclient() {
 SocketIOclient::~SocketIOclient() {
 }
 
-void SocketIOclient::begin(const char * host, uint16_t port, const char * url, const char * protocol) {
+void SocketIOclient::begin(const char * host, uint16_t port, const char * url, const char * protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIO(host, port, url, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 
-void SocketIOclient::begin(String host, uint16_t port, String url, String protocol) {
+void SocketIOclient::begin(String host, uint16_t port, String url, String protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIO(host, port, url, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 #if defined(HAS_SSL)
-void SocketIOclient::beginSSL(const char * host, uint16_t port, const char * url, const char * protocol) {
+void SocketIOclient::beginSSL(const char * host, uint16_t port, const char * url, const char * protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIOSSL(host, port, url, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 
-void SocketIOclient::beginSSL(String host, uint16_t port, String url, String protocol) {
+void SocketIOclient::beginSSL(String host, uint16_t port, String url, String protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIOSSL(host, port, url, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 #if defined(SSL_BARESSL)
-void SocketIOclient::beginSSLWithCA(const char * host, uint16_t port, const char * url, const char * CA_cert, const char * protocol) {
+void SocketIOclient::beginSSLWithCA(const char * host, uint16_t port, const char * url, const char * CA_cert, const char * protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIOSSLWithCA(host, port, url, CA_cert, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 
-void SocketIOclient::beginSSLWithCA(const char * host, uint16_t port, const char * url, BearSSL::X509List * CA_cert, const char * protocol) {
+void SocketIOclient::beginSSLWithCA(const char * host, uint16_t port, const char * url, BearSSL::X509List * CA_cert, const char * protocol, uint32_t pingInterval, uint32_t pongTimeout, uint8_t disconnectTimeoutCount) {
     WebSocketsClient::beginSocketIOSSLWithCA(host, port, url, CA_cert, protocol);
-    WebSocketsClient::enableHeartbeat(60 * 1000, 90 * 1000, 5);
+    WebSocketsClient::enableHeartbeat(pingInterval, pongTimeout, disconnectTimeoutCount);
     initClient();
 }
 

src/SocketIOclient.h

@@ -47,21 +47,21 @@ class SocketIOclient : protected WebSocketsClient {
     SocketIOclient(void);
     virtual ~SocketIOclient(void);
 
-    void begin(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino");
-    void begin(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino");
+    void begin(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
+    void begin(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
 
 #ifdef HAS_SSL
-    void beginSSL(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino");
-    void beginSSL(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino");
+    void beginSSL(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
+    void beginSSL(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
 #ifndef SSL_AXTLS
-    void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * CA_cert = NULL, const char * protocol = "arduino");
-    void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", BearSSL::X509List * CA_cert = NULL, const char * protocol = "arduino");
+    void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * CA_cert = NULL, const char * protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
+    void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", BearSSL::X509List * CA_cert = NULL, const char * protocol = "arduino", uint32_t pingInterval = 60 * 1000, uint32_t pongTimeout = 90 * 1000, uint8_t disconnectTimeoutCount = 5);
     void setSSLClientCertKey(const char * clientCert = NULL, const char * clientPrivateKey = NULL);
     void setSSLClientCertKey(BearSSL::X509List * clientCert = NULL, BearSSL::PrivateKey * clientPrivateKey = NULL);
 #endif
 #endif
     bool isConnected(void);
-    
+
     void onEvent(SocketIOclientEvent cbEvent);
     void disconnect(void);
 

src/WebSockets.cpp

@@ -571,6 +571,7 @@ String WebSockets::acceptKey(String & clientKey) {
  */
 String WebSockets::base64_encode(uint8_t * data, size_t length) {
     size_t size   = ((length * 1.6f) + 1);
+    size          = std::max(size, (size_t)5);    // minimum buffer size
     char * buffer = (char *)malloc(size);
     if(buffer) {
         base64_encodestate _state;
@@ -749,7 +750,7 @@ void WebSockets::handleHBTimeout(WSclient_t * client) {
                 client->pongTimeoutCount++;
                 client->lastPing = millis() - client->pingInterval - 500;    // force ping on the next run
 
-                DEBUG_WEBSOCKETS("[HBtimeout] pong TIMEOUT! lp=%d millis=%d pi=%d count=%d\n", client->lastPing, millis(), pi, client->pongTimeoutCount);
+                DEBUG_WEBSOCKETS("[HBtimeout] pong TIMEOUT! lp=%d millis=%lu pi=%d count=%d\n", client->lastPing, millis(), pi, client->pongTimeoutCount);
 
                 if(client->disconnectTimeoutCount && client->pongTimeoutCount >= client->disconnectTimeoutCount) {
                     DEBUG_WEBSOCKETS("[HBtimeout] count=%d, DISCONNECTING\n", client->pongTimeoutCount);

src/WebSocketsServer.cpp

@@ -65,6 +65,7 @@ WebSocketsServerCore::~WebSocketsServerCore() {
 }
 
 WebSocketsServer::~WebSocketsServer() {
+    delete _server;
 }
 
 /**
@@ -428,8 +429,16 @@ WSclient_t * WebSocketsServerCore::newClient(WEBSOCKETS_NETWORK_CLASS * TCPclien
     for(uint8_t i = 0; i < WEBSOCKETS_SERVER_CLIENT_MAX; i++) {
         client = &_clients[i];
 
-        // state is not connected or tcp connection is lost
-        if(!clientIsConnected(client)) {
+        // look for match to existing socket before creating a new one
+        if(clientIsConnected(client)) {
+#if(WEBSOCKETS_NETWORK_TYPE == NETWORK_W5100)
+            // Check to see if it is the same socket - if so, return it
+            if(client->tcp->getSocketNumber() == TCPclient->getSocketNumber()) {
+                return client;
+            }
+#endif
+        } else {
+            // state is not connected or tcp connection is lost
             client->tcp = TCPclient;
 
 #if(WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266) || (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32)
@@ -646,7 +655,7 @@ void WebSocketsServer::handleNewClients(void) {
 #endif
 
         // store new connection
-        WEBSOCKETS_NETWORK_CLASS * tcpClient = new WEBSOCKETS_NETWORK_CLASS(_server->available());
+        WEBSOCKETS_NETWORK_CLASS * tcpClient = new WEBSOCKETS_NETWORK_CLASS(_server->accept());
         if(!tcpClient) {
             DEBUG_WEBSOCKETS("[WS-Client] creating Network class failed!");
             return;

travis/common.sh

@@ -29,6 +29,23 @@ function build_sketches()
     done
 }
 
+function build_sketch_cli()
+{
+    local sketch=$1
+    local board=$2
+    arduino-cli --log --log-level info compile -b "$board" "$sketch"
+    result=$?
+    if [ $result -ne 0 ]; then
+        echo "Build failed ($sketch) build verbose..."
+        arduino-cli --log --log-level debug compile -b "$board" "$sketch"
+        result=$?
+    fi
+    if [ $result -ne 0 ]; then
+        echo "Build failed ($1) $sketch"
+        return $result
+    fi
+}
+
 function build_sketch()
 {
     local arduino=$1
@@ -72,7 +89,7 @@ function get_sketches_json_matrix()
     local arduino=$1
     local srcpath=$2
     local platform=$3
-    local ideversion=$4
+    local cliversion=$4
     local board=$5
     local sketches=($(find $srcpath -name *.ino))
     for sketch in "${sketches[@]}" ; do
@@ -81,18 +98,27 @@ function get_sketches_json_matrix()
         if [[ -f "$sketchdir/.$platform.skip" ]]; then
             continue
         fi
-        echo -en "{\"name\":\"$sketchname\",\"board\":\"$board\",\"ideversion\":\"$ideversion\",\"cpu\":\"$platform\",\"sketch\":\"$sketch\"}"
+        echo -en "{\"name\":\"$sketchname\",\"board\":\"$board\",\"cliversion\":\"$cliversion\",\"cpu\":\"$platform\",\"sketch\":\"$sketch\"}"
         if [[ $sketch != ${sketches[-1]} ]] ; then
             echo -en ","
         fi
     done
 }
 
+function get_core_cli() {
+    export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS="https://arduino.esp8266.com/stable/package_esp8266com_index.json https://espressif.github.io/arduino-esp32/package_esp32_index.json https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json"
+    arduino-cli core update-index
+    arduino-cli core install esp8266:esp8266
+    arduino-cli core install esp32:esp32
+    arduino-cli core install arduino:mbed_rp2040
+}
+
 function get_core()
 {
     echo Setup core for $1
 
-    cd $HOME/arduino_ide/hardware
+    mkdir -p $HOME/arduino_ide/packages/hardware
+    cd $HOME/arduino_ide/packages/hardware
 
     if [ "$1" = "esp8266" ] ; then
         mkdir esp8266com