This repository has been archived by the owner on Jan 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
/
WebSockets_Generic.h
992 lines (730 loc) · 29.3 KB
/
WebSockets_Generic.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
/****************************************************************************************************************************
WebSockets_Generic.h - WebSockets Library for boards
Based on and modified from WebSockets libarary https://github.com/Links2004/arduinoWebSockets
to support other boards such as SAMD21, SAMD51, Adafruit's nRF52 boards, etc.
Built by Khoi Hoang https://github.com/khoih-prog/WebSockets_Generic
Licensed under MIT license
@original file WebSockets.h
@date 20.05.2015
@author Markus Sattler
Copyright (c) 2015 Markus Sattler. All rights reserved.
This file is part of the WebSockets for Arduino.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
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.16.1
Version Modified By Date Comments
------- ----------- ---------- -----------
2.1.3 K Hoang 15/05/2020 Initial porting to support SAMD21, SAMD51, nRF52 boards, such as AdaFruit Feather nRF52832,
nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, etc.
...
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
2.12.0 K Hoang 28/01/2022 Supporting SSL for ESP32-based WT32_ETH01 boards
2.13.0 K Hoang 14/02/2022 Add support to ESP32_S3. Add PING and PONG SocketIO events
2.14.0 K Hoang 17/02/2022 Suppress unnecessary warnings. Optimize code by passing by reference instead of value
2.14.1 K Hoang 18/02/2022 Fix setInsecure() bug for WIO_Terminal. Update Packages_Patches for Seeeduino
2.14.2 K Hoang 27/03/2022 Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
2.15.0 K Hoang 06/04/2022 Use Ethernet_Generic library as default. Sync with arduinoWebSockets v2.3.6
2.16.0 K Hoang 13/10/2022 Add WS and WSS support to RP2040W using CYW43439 WiFi
2.16.1 K Hoang 24/11/2022 Using new WiFi101_Generic library
*****************************************************************************************************************************/
#pragma once
#ifndef WEBSOCKETS_GENERIC_H_
#define WEBSOCKETS_GENERIC_H_
////////////////////////////////////////
#define WEBSOCKETS_GENERIC_VERSION "WebSockets_Generic v2.16.1"
#define WEBSOCKETS_GENERIC_VERSION_MAJOR 2
#define WEBSOCKETS_GENERIC_VERSION_MINOR 16
#define WEBSOCKETS_GENERIC_VERSION_PATCH 1
#define WEBSOCKETS_GENERIC_VERSION_INT 2016001
////////////////////////////////////////
#include "WebSocketsDebug_Generic.h"
////////////////////////////////////////
#ifdef STM32_DEVICE
#include <application.h>
#define bit(b) (1UL << (b)) // Taken directly from Arduino.h
#else
#include <Arduino.h>
#include <IPAddress.h>
#endif
////////////////////////////////////////
#ifdef ARDUINO_ARCH_AVR
#error Version 2.x.x currently does not support Arduino with AVR since there is no support for std namespace of c++.
#error Use Version 1.x.x. (ATmega branch)
#else
#ifdef max
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Undef min/max in WebSockets_Generic
#endif
#undef max
#endif
#ifdef min
#undef min
#endif
#include <functional>
#endif
////////////////////////////////////////
#if defined(TEENSYDUINO)
namespace std
{
//To avoid Teensy linker issue wth STL library
unsigned __exidx_start;
unsigned __exidx_end;
// This is defined so that calling a std::function<void()> can compile when
// size optimization is enabled.
__attribute__((weak))
void __throw_bad_function_call()
{
Serial.println("Library Exception");
while (true)
yield();
}
}
#endif
////////////////////////////////////////
#ifndef NODEBUG_WEBSOCKETS
#ifdef DEBUG_ESP_PORT
#define DEBUG_WEBSOCKETS(...) \
{ \
DEBUG_ESP_PORT.printf(__VA_ARGS__); \
DEBUG_ESP_PORT.flush(); \
}
#else
//#define DEBUG_WEBSOCKETS(...) os_printf( __VA_ARGS__ )
#endif
#endif
#ifndef DEBUG_WEBSOCKETS
#define DEBUG_WEBSOCKETS(...)
#ifndef NODEBUG_WEBSOCKETS
#define NODEBUG_WEBSOCKETS
#endif
#endif
//////////////////////////////////////////////////////////////
#if defined(ESP8266) || defined(ESP32)
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
#define WEBSOCKETS_USE_BIG_MEM
#define GET_FREE_HEAP ESP.getFreeHeap()
// moves all Header strings to Flash (~300 Byte)
//#define WEBSOCKETS_SAVE_RAM
#if defined(ESP8266)
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use ESP8266 in WebSockets_Generic
#endif
#define WEBSOCKETS_YIELD() delay(0)
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif defined(ESP32)
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use ESP32 in WebSockets_Generic
#endif
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#endif
#elif ( defined(STM32F0) || defined(STM32F1) || defined(STM32F2) || defined(STM32F3) ||defined(STM32F4) || defined(STM32F7) || \
defined(STM32L0) || defined(STM32L1) || defined(STM32L4) || defined(STM32H7) ||defined(STM32G0) || defined(STM32G4) || \
defined(STM32WB) || defined(STM32MP1) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use STM32F/L/H/G/WB/MP1 in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// moves all Header strings to Flash (~300 Byte)
//#define WEBSOCKETS_USE_BIG_MEM
#define WEBSOCKETS_SAVE_RAM
//#define GET_FREE_HEAP System.freeMemory()
#define WEBSOCKETS_YIELD()
#define WEBSOCKETS_YIELD_MORE()
#elif defined(STM32_DEVICE)
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use STM32_DEVICE in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
#define WEBSOCKETS_USE_BIG_MEM
#define GET_FREE_HEAP System.freeMemory()
#define WEBSOCKETS_YIELD()
#define WEBSOCKETS_YIELD_MORE()
#elif ( defined(NRF52840_FEATHER) || defined(NRF52832_FEATHER) || defined(NRF52_SERIES) || defined(ARDUINO_NRF52_ADAFRUIT) || \
defined(NRF52840_FEATHER_SENSE) || defined(NRF52840_ITSYBITSY) || defined(NRF52840_CIRCUITPLAY) || defined(NRF52840_CLUE) || \
defined(NRF52840_METRO) || defined(NRF52840_PCA10056) || defined(PARTICLE_XENON) || defined(NINA_B302_ublox) || defined(NINA_B112_ublox) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use nRF52 in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// only for ESP since AVR has less HEAP
// try to send data in one TCP package (only if some free Heap is there)
//#define WEBSOCKETS_USE_BIG_MEM
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif ( defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010) \
|| defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_SAMD_MKRFox1200) || defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310) \
|| defined(ARDUINO_SAMD_MKRGSM1400) || defined(ARDUINO_SAMD_MKRNB1500) || defined(ARDUINO_SAMD_MKRVIDOR4000) || defined(__SAMD21G18A__) \
|| defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(__SAMD21E18A__) || defined(__SAMD51__) || defined(__SAMD51J20A__) || defined(__SAMD51J19A__) \
|| defined(__SAMD51G19A__) || defined(__SAMD51P19A__) || defined(__SAMD21G18A__) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use SAMD21/SAMD51 in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// only for ESP since AVR has less HEAP
// try to send data in one TCP package (only if some free Heap is there)
#if defined(SEEED_WIO_TERMINAL)
//#define WEBSOCKETS_USE_BIG_MEM
//#define GET_FREE_HEAP 10000
#endif
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif ( defined(ARDUINO_SAM_DUE) || defined(__SAM3X8E__) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use SAM DUE in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// only for ESP since AVR has less HEAP
// try to send data in one TCP package (only if some free Heap is there)
//#define WEBSOCKETS_USE_BIG_MEM
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif defined(TEENSYDUINO)
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use Teensy in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// only for ESP since AVR has less HEAP
// try to send data in one TCP package (only if some free Heap is there)
//#define WEBSOCKETS_USE_BIG_MEM
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif ( defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_RASPBERRY_PI_PICO) || defined(ARDUINO_ADAFRUIT_FEATHER_RP2040) || defined(ARDUINO_GENERIC_RP2040) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use RP2040 in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// try to send data in one TCP package (only if some free Heap is there)
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#elif ( ( defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4) ) && defined(ARDUINO_ARCH_MBED) )
// KH
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use Portenta_H7 in WebSockets_Generic
#endif
#define WEBSOCKETS_MAX_DATA_SIZE (15 * 1024)
// Try to use GET_FREE_HEAP and large mem
// try to send data in one TCP package (only if some free Heap is there)
// moves all Header strings to Flash (~300 Byte)
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD() yield()
#define WEBSOCKETS_YIELD_MORE() delay(1)
#else
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Use atmega328p in WebSockets_Generic
#endif
//atmega328p has only 2KB ram!
#define WEBSOCKETS_MAX_DATA_SIZE (1024)
// moves all Header strings to Flash
#define WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_YIELD()
#define WEBSOCKETS_YIELD_MORE()
#endif
//////////////////////////////////////////////////////////////
#ifndef WEBSOCKETS_TCP_TIMEOUT
#define WEBSOCKETS_TCP_TIMEOUT (5000)
#endif
//////////////////////////////////////////////////////////////
#define NETWORK_ESP8266_ASYNC (0)
#define NETWORK_ESP8266 (1)
#define NETWORK_W5100 (2)
#define NETWORK_ENC28J60 (3)
#define NETWORK_ESP32 (4)
#define NETWORK_ESP32_ETH (5)
//KH
#define NETWORK_WIFININA (6)
#define NETWORK_ETHERNET_ENC (7)
#define NETWORK_RTL8720DN (8)
#define NETWORK_NATIVEETHERNET (9)
#define NETWORK_LAN8742A (10)
#define NETWORK_WIFI101 (11)
#define NETWORK_QN_ETHERNET (12)
#define NETWORK_PORTENTA_H7_WIFI (13)
#define NETWORK_PORTENTA_H7_ETHERNET (14)
// KH, For new Async
#define NETWORK_ESP32_ASYNC (15)
#define NETWORK_RP2040W_WIFI (16)
////////////////////////////////////////
#if ( (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266_ASYNC) || (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32_ASYNC) )
// Combined for all Async
#define NETWORK_ASYNC true
#else
#define NETWORK_ASYNC false
#endif
////////////////////////////////////////
// max size of the WS Message Header
#define WEBSOCKETS_MAX_HEADER_SIZE (14)
////////////////////////////////////////
#ifndef WEBSOCKETS_NETWORK_TYPE
// select Network type based
#if defined(ESP8266) || defined(ESP31B)
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP8266
//#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP8266_ASYNC
//#define WEBSOCKETS_NETWORK_TYPE NETWORK_W5100
#elif defined(ESP32)
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP32
//#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP32_ETH
//#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP32_ASYNC
#elif ( defined(NRF52840_FEATHER) || defined(NRF52832_FEATHER) || defined(NRF52_SERIES) || defined(ARDUINO_NRF52_ADAFRUIT) || \
defined(NRF52840_FEATHER_SENSE) || defined(NRF52840_ITSYBITSY) || defined(NRF52840_CIRCUITPLAY) || defined(NRF52840_CLUE) || \
defined(NRF52840_METRO) || defined(NRF52840_PCA10056) || defined(PARTICLE_XENON) || defined(NINA_B302_ublox) || defined(NINA_B112_ublox) )
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_WIFININA
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_WIFININA
#elif ( defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010) \
|| defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_SAMD_MKRFox1200) || defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310) \
|| defined(ARDUINO_SAMD_MKRGSM1400) || defined(ARDUINO_SAMD_MKRNB1500) || defined(ARDUINO_SAMD_MKRVIDOR4000) || defined(__SAMD21G18A__) \
|| defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(__SAMD21E18A__) || defined(__SAMD51__) || defined(__SAMD51J20A__) || defined(__SAMD51J19A__) \
|| defined(__SAMD51G19A__) || defined(__SAMD51P19A__) || defined(__SAMD21G18A__) )
#if defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010)
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_WIFI101
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_WIFI101
#elif defined(SEEED_WIO_TERMINAL)
//KH, from v2.3.2
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_RTL8720DN
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_RTL8720DN
#else
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_WIFININA
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_WIFININA
#endif
#else
//KH
#if(_WEBSOCKETS_LOGLEVEL_>2)
#warning WEBSOCKETS_NETWORK_TYPE == NETWORK_W5100
#endif
#define WEBSOCKETS_NETWORK_TYPE NETWORK_W5100
#endif //#if defined(ESP8266) || defined(ESP31B)
#endif //#ifndef WEBSOCKETS_NETWORK_TYPE
////////////////////////////////////////
// Includes and defined based on Network Type
#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266_ASYNC)
// Note:
// No SSL/WSS support for client in Async mode
// TLS lib need a sync interface!
#if defined(ESP8266)
#include <ESP8266WiFi.h>
#elif defined(ESP32)
#include <WiFi.h>
#include <WiFiClientSecure.h>
// From v2.3.1
#define SSL_AXTLS
//////
#elif defined(ESP31B)
#include <ESP31BWiFi.h>
#else
#error "network type ESP8266 ASYNC only possible on the ESP mcu!"
#endif
#include <ESPAsyncTCP.h>
#include <ESPAsyncTCPbuffer.h>
#define WEBSOCKETS_NETWORK_CLASS AsyncTCPbuffer
#define WEBSOCKETS_NETWORK_SERVER_CLASS AsyncServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266)
#if !defined(ESP8266) && !defined(ESP31B)
#error "network type ESP8266 only possible on the ESP mcu!"
#endif
#ifdef ESP8266
#include <ESP8266WiFi.h>
// From v2.3.1
#if defined(wificlientbearssl_h) && !defined(USING_AXTLS) && !defined(wificlientsecure_h)
#define SSL_BARESSL
#define SSL_BEARSSL
#else
#define SSL_AXTLS
#endif
//////
#else
#include <ESP31BWiFi.h>
#endif
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiClientSecure
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_W5100)
#ifdef STM32_DEVICE
#define WEBSOCKETS_NETWORK_CLASS TCPClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS TCPServer
#else
#include <SPI.h>
// KH, New v2.2.3 to support Ethernet2, Ethernet3, EthernetLarge Lib
#if USE_ETHERNET_GENERIC //(WEBSOCKETS_NETWORK_LIB == _ETHERNET_)
#include <Ethernet_Generic.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using Ethernet_Generic W5x00 Library
#endif
#else
#include <Ethernet_Generic.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using default Ethernet_Generic W5x00 Library
#endif
#endif
//////
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
// KH, test SSL
//#define WEBSOCKETS_NETWORK_SSL_CLASS EthernetSSLClient
#endif
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ENC28J60)
#include <UIPEthernet.h>
#define WEBSOCKETS_NETWORK_CLASS UIPClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS UIPServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32)
#include <WiFi.h>
#include <WiFiClientSecure.h>
// From v2.3.1
#define SSL_AXTLS
//////
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiClientSecure
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32_ASYNC)
#error "Network type NETWORK_ESP32_ASYNC not ready yet"
// Note:
// No SSL/WSS support for client in Async mode
// TLS lib need a sync interface!
#if defined(ESP32)
#include <WiFi.h>
#include <WiFiClientSecure.h>
// From v2.3.1
#define SSL_AXTLS
//////
#else
#error "Network type NETWORK_ESP32_ASYNC only for ESP32"
#endif
#include <AsyncTCP.h>
#define WEBSOCKETS_NETWORK_CLASS AsyncClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS AsyncServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP32_ETH)
#include <ETH.h>
#include <WiFi.h>
#include <WiFiClientSecure.h>
// From v2.3.1
#define SSL_AXTLS
//////
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiClientSecure
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_WIFININA)
//KH
#include <WiFiNINA_Generic.h>
#include <WiFiSSLClient_Generic.h>
#define SSL_AXTLS
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiSSLClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_WIFI101)
//KH
#include <WiFi101.h>
#include <WiFiSSLClient.h>
#define SSL_AXTLS
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiSSLClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_ETHERNET_ENC)
//KH
#include <EthernetENC.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using ENC28J60 EthernetENC Library
#endif
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_RTL8720DN)
//KH, from v2.3.2
#include <rpcWiFi.h>
#include <WiFiClientSecure.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using RTL8720DN Seeed_Arduino_rpcWiFi Library
#endif
#define SSL_AXTLS
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiClientSecure
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_NATIVEETHERNET)
//KH, from v2.4.0
#include <NativeEthernet.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using Teensy 4.1 NativeEthernet Library
#endif
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_QN_ETHERNET)
//KH, from v2.9.0
#include <QNEthernet.h>
using namespace qindesign::network;
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using Teensy 4.1 QNEthernet Library
#endif
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_PORTENTA_H7_WIFI)
//KH, from v2.10.0
#include <WiFi.h>
//#include <WiFiSSLClient.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using Portenta_H7 WiFi Library
#endif
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
//#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiSSLClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_PORTENTA_H7_ETHERNET)
//KH, from v2.10.0
#include <PortentaEthernet.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using Portenta_H7 Ethernet Library
#endif
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
//#define WEBSOCKETS_NETWORK_SSL_CLASS EthernetSSLClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
////////////////////////////////////////
#elif (WEBSOCKETS_NETWORK_TYPE == NETWORK_LAN8742A)
//KH, from v2.4.0
#include <LwIP.h>
#include <STM32Ethernet.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using LAN8742A Ethernet & STM32Ethernet lib
#endif
#define WEBSOCKETS_NETWORK_CLASS EthernetClient
#define WEBSOCKETS_NETWORK_SERVER_CLASS EthernetServer
////////////////////////////////////////
#elif ( defined(ARDUINO_RASPBERRY_PI_PICO_W) && (WEBSOCKETS_NETWORK_TYPE == NETWORK_RP2040W_WIFI) )
//KH, from v2.16.0
#include <WiFi.h>
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning Using RP2040W CYC43439 WiFi
#endif
#define SSL_BARESSL
#define SSL_BEARSSL
#define WEBSOCKETS_NETWORK_CLASS WiFiClient
#define WEBSOCKETS_NETWORK_SSL_CLASS WiFiClientSecure
#define WEBSOCKETS_NETWORK_SERVER_CLASS WiFiServer
////////////////////////////////////////
#else
#error "no network type selected!"
#endif
////////////////////////////////////////
////////////////////////////////////////
#ifdef WEBSOCKETS_NETWORK_SSL_CLASS
#if(_WEBSOCKETS_LOGLEVEL_>3)
#warning This network type Supporting SSL for WebSockets
#endif
#define HAS_SSL
#endif
////////////////////////////////////////
// moves all Header strings to Flash (~300 Byte)
#ifdef WEBSOCKETS_SAVE_RAM
#define WEBSOCKETS_STRING(var) F(var)
#else
#define WEBSOCKETS_STRING(var) var
#endif
////////////////////////////////////////
typedef enum
{
WSC_NOT_CONNECTED,
WSC_HEADER,
WSC_BODY,
WSC_CONNECTED
} WSclientsStatus_t;
////////////////////////////////////////
typedef enum
{
WStype_ERROR,
WStype_DISCONNECTED,
WStype_CONNECTED,
WStype_TEXT,
WStype_BIN,
WStype_FRAGMENT_TEXT_START,
WStype_FRAGMENT_BIN_START,
WStype_FRAGMENT,
WStype_FRAGMENT_FIN,
WStype_PING,
WStype_PONG,
} WStype_t;
////////////////////////////////////////
typedef enum
{
WSop_continuation = 0x00, ///< %x0 denotes a continuation frame
WSop_text = 0x01, ///< %x1 denotes a text frame
WSop_binary = 0x02, ///< %x2 denotes a binary frame
///< %x3-7 are reserved for further non-control frames
WSop_close = 0x08, ///< %x8 denotes a connection close
WSop_ping = 0x09, ///< %x9 denotes a ping
WSop_pong = 0x0A ///< %xA denotes a pong
///< %xB-F are reserved for further control frames
} WSopcode_t;
////////////////////////////////////////
typedef struct
{
bool fin;
bool rsv1;
bool rsv2;
bool rsv3;
WSopcode_t opCode;
bool mask;
size_t payloadLen;
uint8_t * maskKey;
} WSMessageHeader_t;
////////////////////////////////////////
typedef struct
{
void init(const uint8_t& num, const uint32_t& pingInterval, const uint32_t& pongTimeout,
const uint8_t& disconnectTimeoutCount)
{
this->num = num;
this->pingInterval = pingInterval;
this->pongTimeout = pongTimeout;
this->disconnectTimeoutCount = disconnectTimeoutCount;
}
uint8_t num = 0; ///< connection number
WSclientsStatus_t status = WSC_NOT_CONNECTED;
WEBSOCKETS_NETWORK_CLASS * tcp = nullptr;
bool isSocketIO = false; ///< client for socket.io server
#if defined(HAS_SSL)
bool isSSL = false; ///< run in ssl mode
WEBSOCKETS_NETWORK_SSL_CLASS * ssl = nullptr;
#endif
String cUrl; ///< http url
uint16_t cCode = 0; ///< http code
bool cIsClient = false; ///< will be used for masking
bool cIsUpgrade = false; ///< Connection == Upgrade
bool cIsWebsocket = false; ///< Upgrade == websocket
String cSessionId; ///< client Set-Cookie (session id)
String cKey; ///< client Sec-WebSocket-Key
String cAccept; ///< client Sec-WebSocket-Accept
String cProtocol; ///< client Sec-WebSocket-Protocol
String cExtensions; ///< client Sec-WebSocket-Extensions
uint16_t cVersion = 0; ///< client Sec-WebSocket-Version
uint8_t cWsRXsize = 0; ///< State of the RX
uint8_t cWsHeader[WEBSOCKETS_MAX_HEADER_SIZE]; ///< RX WS Message buffer
WSMessageHeader_t cWsHeaderDecode;
String base64Authorization; ///< Base64 encoded Auth request
String plainAuthorization; ///< Base64 encoded Auth request
String extraHeaders;
bool cHttpHeadersValid = false; ///< non-websocket http header validity indicator
size_t cMandatoryHeadersCount; ///< non-websocket mandatory http headers present count
bool pongReceived = false;
uint32_t pingInterval = 0; // how often ping will be sent, 0 means "heartbeat is not active"
uint32_t lastPing = 0; // millis when last pong has been received
uint32_t pongTimeout = 0; // interval in millis after which pong is considered to timeout
uint8_t disconnectTimeoutCount =
0; // after how many subsequent pong timeouts discconnect will happen, 0 means "do not disconnect"
uint8_t pongTimeoutCount = 0; // current pong timeout count
#if (WEBSOCKETS_NETWORK_TYPE == NETWORK_ESP8266_ASYNC)
String cHttpLine; ///< HTTP header lines
#endif
} WSclient_t;
////////////////////////////////////////
////////////////////////////////////////
class WebSockets
{
protected:
#ifdef __AVR__
typedef void (*WSreadWaitCb)(WSclient_t * client, bool ok);
#else
typedef std::function<void(WSclient_t * client, bool ok)> WSreadWaitCb;
#endif
virtual void clientDisconnect(WSclient_t * client) = 0;
virtual bool clientIsConnected(WSclient_t * client) = 0;
void clientDisconnect(WSclient_t * client, uint16_t code, char * reason = NULL, size_t reasonLen = 0);
virtual void messageReceived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload,
size_t length, bool fin) = 0;
uint8_t createHeader(uint8_t * buf, WSopcode_t opcode, size_t length, bool mask,
uint8_t maskKey[4], bool fin);
bool sendFrameHeader(WSclient_t * client, WSopcode_t opcode, size_t length = 0, bool fin = true);
bool sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload = NULL, size_t length = 0,
bool fin = true, bool headerToPayload = false);
void headerDone(WSclient_t * client);
void handleWebsocket(WSclient_t * client);
bool handleWebsocketWaitFor(WSclient_t * client, size_t size);
void handleWebsocketCb(WSclient_t * client);
void handleWebsocketPayloadCb(WSclient_t * client, bool ok, uint8_t * payload);
String acceptKey(String & clientKey);
String base64_encode(uint8_t * data, size_t length);
bool readCb(WSclient_t * client, uint8_t * out, size_t n, WSreadWaitCb cb);
virtual size_t write(WSclient_t * client, uint8_t * out, size_t n);
size_t write(WSclient_t * client, const char * out);
void enableHeartbeat(WSclient_t * client, const uint32_t& pingInterval, const uint32_t& pongTimeout,
const uint8_t& disconnectTimeoutCount);
void handleHBTimeout(WSclient_t * client);
};
////////////////////////////////////////
////////////////////////////////////////
// KH
String WS_IPAddressToString(const IPAddress& _address)
{
String str = String(_address[0]);
str += ".";
str += String(_address[1]);
str += ".";
str += String(_address[2]);
str += ".";
str += String(_address[3]);
return str;
}
////////////////////////////////////////
#ifndef UNUSED
#define UNUSED(var) (void)(var)
#endif
#include "WebSockets_Generic-Impl.h"
#endif // WEBSOCKETS_GENERIC_H_