Outline ![]()
Files ![]()
loading...
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
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Multiple TCP Socket/TLS Session support module */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_TCPSERVER_SOURCE_CODE
#include "nx_api.h"
#include "nx_tcpserver.h"
/* Define internal function prototypes. */
static UINT _nx_tcpserver_session_allocate(NX_TCPSERVER *server_ptr, NX_TCP_SESSION **session_pptr);
static UINT _nx_tcpserver_relisten(NX_TCPSERVER *server_ptr);
static VOID _nx_tcpserver_connect_present(NX_TCP_SOCKET *socket_ptr, UINT port);
static VOID _nx_tcpserver_data_present(NX_TCP_SOCKET *socket_ptr);
static VOID _nx_tcpserver_disconnect_present(NX_TCP_SOCKET *socket_ptr);
static VOID _nx_tcpserver_timeout(ULONG tcpserver_address);
static VOID _nx_tcpserver_connect_process(NX_TCPSERVER *server_ptr);
static VOID _nx_tcpserver_data_process(NX_TCPSERVER *server_ptr);
static VOID _nx_tcpserver_disconnect_process(NX_TCPSERVER *server_ptr);
static VOID _nx_tcpserver_timeout_process(NX_TCPSERVER *server_ptr);
static VOID _nx_tcpserver_thread_entry(ULONG tcpserver_address);
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_session_allocate PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function allocates a free socket (and TLS session, if */
/* TLS is enabled) for an incoming client request. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to server structure */
/* session_pptr Pointer to allocated socket */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_relisten */
/* _nx_tcpserver_start */
/* _nx_tcpserver_connect_process */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* fixed packet leak issue, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static UINT _nx_tcpserver_session_allocate(NX_TCPSERVER *server_ptr, NX_TCP_SESSION **session_pptr)
{
UINT i;
NX_TCP_SOCKET *socket_ptr;
/* Reset. */
*session_pptr = NX_NULL;
/* Loop to find unused session. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
/* Skip the listen session. */
if(&server_ptr -> nx_tcpserver_sessions[i] == server_ptr -> nx_tcpserver_listen_session)
continue;
socket_ptr = &(server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket);
/* A closed or listening socket is available. */
if((socket_ptr -> nx_tcp_socket_state == NX_TCP_CLOSED) &&
(socket_ptr -> nx_tcp_socket_bound_next == NX_NULL) &&
(socket_ptr -> nx_tcp_socket_bind_in_progress == NX_NULL))
{
/* Reset expiration to zero. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_expiration = 0;
/* Set connection flag to false. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_connected = NX_FALSE;
/* Return the socket. */
*session_pptr = &server_ptr -> nx_tcpserver_sessions[i];
return NX_SUCCESS;
}
}
return NX_TCPSERVER_FAIL;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_relisten PORTABLE C */
/* 6.1.9 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked whenever a connection is closed */
/* to re-enable listening on that closed socket/session. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to server structure */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_tcpserver_session_allocate Allocate socket for listening */
/* nx_tcp_server_socket_relisten Re-listen on free socket */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_connect_process */
/* _nx_tcpserver_disconnect_process */
/* _nx_tcpserver_timeout_process */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* 10-15-2021 Yuxin Zhou Modified comment(s), and */
/* removed debug output, */
/* resulting in version 6.1.9 */
/* */
/**************************************************************************/
static UINT _nx_tcpserver_relisten(NX_TCPSERVER *server_ptr)
{
UINT status;
NX_TCP_SESSION *session_ptr;
/* Is any socket listening? */
if(server_ptr -> nx_tcpserver_listen_session == NX_NULL)
{
/* Get a socket to listen. */
status = _nx_tcpserver_session_allocate(server_ptr, &session_ptr);
if(status)
{
return NX_TCPSERVER_FAIL;
}
status = nx_tcp_server_socket_relisten(server_ptr -> nx_tcpserver_ip,
server_ptr -> nx_tcpserver_listen_port,
&session_ptr -> nx_tcp_session_socket);
if((status != NX_SUCCESS) && (status != NX_CONNECTION_PENDING))
{
return NX_TCPSERVER_FAIL;
}
/* Store listen socket. */
server_ptr -> nx_tcpserver_listen_session = session_ptr;
}
else if(server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket.nx_tcp_socket_state == NX_TCP_CLOSED)
{
status = nx_tcp_server_socket_relisten(server_ptr -> nx_tcpserver_ip,
server_ptr -> nx_tcpserver_listen_port,
&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket);
if((status != NX_SUCCESS) && (status != NX_CONNECTION_PENDING))
{
return NX_TCPSERVER_FAIL;
}
}
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* nx_tcpserver_create PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function creates a socket server instance to handle multiple */
/* incoming TCP or TLS client connections. The server utilizes an */
/* internal thread and manages a queue of TCP sockets (and TLS */
/* sessions if enabled) that are used to handle incoming requests. */
/* The callback routines are used to handle individual requests. Each */
/* socket (and TLS session) receives identical state so that each */
/* incoming request is handled consistently. */
/* */
/* The number of available sockets and TLS sessions is determined by */
/* the size of the sessions buffer and can be found by dividing the */
/* buffer size by the size of the NX_TCP_SESSION structure. */
/* */
/* INPUT */
/* */
/* ip_ptr IP instance for this server */
/* server_ptr Pointer to server structure */
/* name Name string for this server */
/* type_of_service Type of service for TCP */
/* sockets */
/* fragment Flag to enable IP fragmenting */
/* time_to_live Time to live value for socket */
/* window_size Size of socket's receive */
/* window */
/* new_connection Callback invoked for new */
/* client connections */
/* receive_data Callback invoked when data is */
/* received from the client */
/* connection_end Callback invoked when a */
/* connection is closed */
/* connection_timeout Callback invoked when a */
/* connection times out */
/* timeout Timeout value for all sockets */
/* stack_ptr Stack buffer for internal */
/* server thread */
/* stack_size Size of thread stack buffer */
/* sessions_buffer Buffer for per-session data */
/* buffer_size Size of per-session buffer, */
/* determines session number */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_thread_create Create server thread */
/* tx_event_flags_create Create thread event flags */
/* tx_timer_create Create timeout timer */
/* nx_tcp_socket_create Create TCP sockets */
/* nx_tcp_socket_receive_notify Set TCP notification callback */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_tcpserver_create(NX_IP *ip_ptr, NX_TCPSERVER *server_ptr, CHAR *name,
ULONG type_of_service, ULONG fragment, UINT time_to_live, ULONG window_size,
VOID (*new_connection)(NX_TCPSERVER *server_ptr, NX_TCP_SESSION *session_ptr),
VOID (*receive_data)(NX_TCPSERVER *server_ptr, NX_TCP_SESSION *session_ptr),
VOID (*connection_end)(NX_TCPSERVER *server_ptr, NX_TCP_SESSION *session_ptr),
VOID (*connection_timeout)(NX_TCPSERVER *server_ptr, NX_TCP_SESSION *session_ptr),
ULONG timeout, VOID *stack_ptr, UINT stack_size,
VOID *sessions_buffer, UINT buffer_size, UINT thread_priority, ULONG accept_wait_option)
{
UINT i;
UINT status;
/* Initialize server struct. */
server_ptr -> nx_tcpserver_ip = ip_ptr;
server_ptr -> nx_tcpserver_sessions = sessions_buffer;
server_ptr -> nx_tcpserver_sessions_count = buffer_size / sizeof(NX_TCP_SESSION);
server_ptr -> nx_tcpserver_listen_port = 0;
server_ptr -> nx_tcpserver_listen_session = NX_NULL;
server_ptr -> nx_tcpserver_new_connection = new_connection;
server_ptr -> nx_tcpserver_receive_data = receive_data;
server_ptr -> nx_tcpserver_connection_end = connection_end;
server_ptr -> nx_tcpserver_connection_timeout = connection_timeout;
server_ptr -> nx_tcpserver_timeout = timeout;
server_ptr -> nx_tcpserver_accept_wait_option = accept_wait_option;
/* Create the tcpserver thread. */
status = tx_thread_create(&server_ptr -> nx_tcpserver_thread, "TCPSERVER Thread",
_nx_tcpserver_thread_entry, (ULONG)server_ptr, stack_ptr,
stack_size, thread_priority, thread_priority,
TX_NO_TIME_SLICE, TX_DONT_START);
/* Create the tcpserver event flags. */
status += tx_event_flags_create(&server_ptr -> nx_tcpserver_event_flags, "TCPSERVER Events");
/* Create the timeout timer. */
status += tx_timer_create(&server_ptr -> nx_tcpserver_timer, "TCPSERVER Timer",
_nx_tcpserver_timeout, (ULONG)server_ptr,
(NX_IP_PERIODIC_RATE * NX_TCPSERVER_TIMEOUT_PERIOD),
(NX_IP_PERIODIC_RATE * NX_TCPSERVER_TIMEOUT_PERIOD), TX_NO_ACTIVATE);
/* Initialize buffer. */
memset(sessions_buffer, 0, buffer_size);
/* Initialize TCP sockets. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
status += nx_tcp_socket_create(ip_ptr, &server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket, name, type_of_service, fragment, time_to_live,
window_size, NX_NULL, _nx_tcpserver_disconnect_present);
status += nx_tcp_socket_receive_notify(&server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket, _nx_tcpserver_data_present);
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket.nx_tcp_socket_reserved_ptr = server_ptr;
}
return status;
}
#ifdef NX_TCPSERVER_ENABLE_TLS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_tls_setup PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function configures a previously created NetX socket server */
/* instance to use TLS. The parameters are used to configure all the */
/* TLS sessions in the server with identical state so that each */
/* incoming TLS client experiences consistent behavior. The number of */
/* TLS sessions and TCP sockets is determined by the size of the */
/* sessions buffer passed into nx_tcpserver_create. */
/* */
/* The cryptographic routine table (ciphersuite table) is shared */
/* between all TLS sessions as it just contains function pointers. */
/* */
/* The metadata buffer and packet reassembly buffer are divided */
/* equally between all TLS sessions. If the buffer size is not evenly */
/* divisible by the number of sessions the remainder will be unused. */
/* */
/* The passed-in identity certificate is used by all sessions. During */
/* TLS operation the server identity certificate is only read from so */
/* copies are not needed for each session. */
/* */
/* The trusted certificates are added to the trusted store for each */
/* TLS session in the server. This is used for client certificate */
/* verification which is enabled if remote certificates are provided. */
/* */
/* The remote certificate array and buffer is shared by default */
/* between all TLS sessions. This does mean that some sessions may */
/* block during certificate validation. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to control block */
/* crypto_table TLS cryptographic routines */
/* metadata_buffer Cryptographic metadata buffer */
/* metadata_size Size of metadata buffer */
/* packet_buffer TLS packet buffer */
/* packet_size Size of packet buffer */
/* identity_certificate TLS server certificate */
/* trusted_certificates TLS trusted certificates */
/* trusted_certs_num Number of trusted certs */
/* remote_certificates Remote certificates array */
/* remote_certs_num Number of remote certificates */
/* remote_certificate_buffer Buffer for remote certs */
/* remote_cert_buffer_size Size of remote cert buffer */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* nx_secure_tls_session_create Create TLS Session */
/* */
/* nx_secure_tls_session_packet_buffer_set */
/* Set TLS packet buffer */
/* */
/* nx_secure_tls_local_certificate_add */
/* Add local TLS identity cert */
/* */
/* nx_secure_tls_session_client_verify_enable */
/* Enable client cert verify */
/* */
/* nx_secure_tls_trusted_certificate_add Add a trusted TLS cert */
/* */
/* nx_secure_tls_remote_certificate_allocate */
/* Allocate space for incoming */
/* client certificates */
/* */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
/* Setup TLS state per server session. */
UINT _nx_tcpserver_tls_setup(NX_TCPSERVER *server_ptr, const NX_SECURE_TLS_CRYPTO *crypto_table,
VOID *metadata_buffer, ULONG metadata_size, UCHAR* packet_buffer, UINT packet_buffer_size, NX_SECURE_X509_CERT *identity_certificate,
NX_SECURE_X509_CERT *trusted_certificates[], UINT trusted_certs_num, NX_SECURE_X509_CERT *remote_certificates[], UINT remote_certs_num, UCHAR *remote_certificate_buffer, UINT remote_cert_buffer_size)
{
NX_SECURE_TLS_SESSION *tls_session;
ULONG session_metadata_size;
UCHAR *session_metadata;
UCHAR *session_cert_buffer;
UINT session_cert_buffer_size = 0;
UINT session_pkt_buffer_size;
UINT num_sessions;
UINT i;
UINT cert_count;
UINT status;
/* Get the number of sessions in the TCP server. */
num_sessions = server_ptr -> nx_tcpserver_sessions_count;
/* Get our per-session packet buffer size. */
session_pkt_buffer_size = packet_buffer_size / num_sessions;
/* Get our per-session metadata. */
session_metadata = metadata_buffer;
session_metadata_size = metadata_size / num_sessions;
/* It's OK to have zero remote certs allocated. */
if(remote_certs_num > 0)
{
/* Divide the remote certificate buffer size by the total number of
remote certificates to get per-certificate size. */
session_cert_buffer_size = remote_cert_buffer_size / remote_certs_num;
}
/* Loop through all sessions, initialize each one. */
for(i = 0; i < num_sessions; ++i)
{
/* This server instance is using TLS so mark as such. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_using_tls = NX_TRUE;
/* Setup per-session data. Get the session from the server structure, then initialize it. */
tls_session = &(server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_tls_session);
status = nx_secure_tls_session_create(tls_session, crypto_table, session_metadata, session_metadata_size);
if(status != NX_SUCCESS)
{
return(status);
}
/* Allocate space for packet reassembly. */
status = nx_secure_tls_session_packet_buffer_set(tls_session, &packet_buffer[i * session_pkt_buffer_size],
session_pkt_buffer_size);
if(status != NX_SUCCESS)
{
return(status);
}
/* Add identity certificate. */
status = nx_secure_tls_local_certificate_add(tls_session, identity_certificate);
if(status != NX_SUCCESS)
{
return(status);
}
/* See if remote certificates are provided. */
if(remote_certs_num > 0)
{
/* We have remote certificates to allocate so enable client certificate authentication. */
nx_secure_tls_session_client_verify_enable(tls_session);
/* Add trusted certificates to each TLS session. */
for(cert_count = 0; cert_count < trusted_certs_num; ++cert_count)
{
status = nx_secure_tls_trusted_certificate_add(tls_session, trusted_certificates[cert_count]);
if(status != NX_SUCCESS)
{
return(status);
}
}
/* Allocate remote certificates (if remote_certs_num > 0). The remote certificate
buffers are shared between all TLS Sessions. This is possible since they are only
needed for the certificate verification process and are freed immediately after. */
session_cert_buffer = remote_certificate_buffer;
for(cert_count = 0; cert_count < remote_certs_num; ++cert_count)
{
/* Allocate a remote certificate from the provided array. */
status = nx_secure_tls_remote_certificate_allocate(tls_session, remote_certificates[i],
session_cert_buffer, session_cert_buffer_size);
if(status != NX_SUCCESS)
{
return(status);
}
/* Now get the next certificate and its buffer. */
session_cert_buffer += session_cert_buffer_size;
}
}
/* Advance metadata buffer. */
session_metadata = &session_metadata[session_metadata_size];
}
return(NX_SUCCESS);
}
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_start PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is called by an application to start a socket server */
/* that was previously created and configured. This routine starts the */
/* internal server thread and timer. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to server structure */
/* port Port for server to listen on */
/* listen_queue_size Maximum number of TCP */
/* connections queued */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_tcpserver_session_allocate Allocate socket for listening */
/* nx_tcp_server_socket_listen Listen on free TCP socket */
/* tx_timer_activate Start timeout timer */
/* tx_thread_resume Start server thread */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_tcpserver_start(NX_TCPSERVER *server_ptr, UINT port, UINT listen_queue_size)
{
UINT status;
NX_TCP_SESSION *session_ptr;
/* Check whether listen is done. */
if(server_ptr -> nx_tcpserver_listen_port)
return NX_TCPSERVER_FAIL;
/* Get a socket to listen. */
status = _nx_tcpserver_session_allocate(server_ptr, &session_ptr);
if(status)
return status;
/* Listen on port. */
status = nx_tcp_server_socket_listen(server_ptr -> nx_tcpserver_ip, port, &session_ptr -> nx_tcp_session_socket, listen_queue_size, _nx_tcpserver_connect_present);
if(status)
return status;
/* Store socket and port. */
server_ptr -> nx_tcpserver_listen_session = session_ptr;
server_ptr -> nx_tcpserver_listen_port = port;
/* Activate timer. */
tx_timer_activate(&server_ptr -> nx_tcpserver_timer);
/* Start thread. */
tx_thread_resume(&server_ptr -> nx_tcpserver_thread);
return NX_SUCCESS;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_connect_present PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is used for the TCP listen callback passed */
/* into nx_tcp_server_socket_listen and is used to determine when an */
/* incoming request has been received and is ready for processing. */
/* */
/* INPUT */
/* */
/* socket_ptr Pointer to TCP socket */
/* port Port of incoming request */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_set Set thread event flag */
/* */
/* CALLED BY */
/* */
/* TCP stack */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_connect_present(NX_TCP_SOCKET *socket_ptr, UINT port)
{
NX_TCPSERVER *server_ptr = socket_ptr -> nx_tcp_socket_reserved_ptr;
NX_PARAMETER_NOT_USED(port);
/* Set the connect event flag. */
tx_event_flags_set(&server_ptr -> nx_tcpserver_event_flags, NX_TCPSERVER_CONNECT, TX_OR);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_data_present PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is used for the TCP receive callback passed */
/* into nx_tcp_socket_receive_notify and is used to determine when */
/* data has been received and is ready for processing. */
/* */
/* INPUT */
/* */
/* socket_ptr Pointer to TCP socket */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_set Set thread event flag */
/* */
/* CALLED BY */
/* */
/* TCP stack */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_data_present(NX_TCP_SOCKET *socket_ptr)
{
NX_TCPSERVER *server_ptr = socket_ptr -> nx_tcp_socket_reserved_ptr;
/* Set the data event flag. */
tx_event_flags_set(&server_ptr -> nx_tcpserver_event_flags, NX_TCPSERVER_DATA, TX_OR);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_disconnect_present PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is used for the TCP disconnect callback */
/* passed into nx_tcp_socket_create and is used to determine when */
/* a socket has been disconnected. */
/* */
/* INPUT */
/* */
/* socket_ptr Pointer to TCP socket */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_set Set thread event flag */
/* */
/* CALLED BY */
/* */
/* TCP stack */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_disconnect_present(NX_TCP_SOCKET *socket_ptr)
{
NX_TCPSERVER *server_ptr = socket_ptr -> nx_tcp_socket_reserved_ptr;
/* Set the disconnect event flag. */
tx_event_flags_set(&server_ptr -> nx_tcpserver_event_flags, NX_TCPSERVER_DISCONNECT, TX_OR);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_timeout PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked whenever the internal timeout */
/* timer expires, and is passed into tx_timer_create as the callback. */
/* */
/* INPUT */
/* */
/* tcpserver_address Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* tx_event_flags_set Set thread event flag */
/* */
/* CALLED BY */
/* */
/* ThreadX */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_timeout(ULONG tcpserver_address)
{
NX_TCPSERVER *server_ptr = (NX_TCPSERVER *)tcpserver_address;
/* Set the timeout event flag. */
tx_event_flags_set(&server_ptr -> nx_tcpserver_event_flags, NX_TCPSERVER_TIMEOUT, TX_OR);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_connect_process PORTABLE C */
/* 6.1.9 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked by the server thread whenever an */
/* incoming connection request is received. It establishes the TCP */
/* connection and if TLS is enabled, it begins the TLS handshake. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _nx_tcpserver_session_allocate Get socket for listening */
/* nx_tcp_server_socket_relisten Relisten on existing socket */
/* nx_tcp_server_socket_accept Accept incoming TCP request */
/* nx_secure_tls_session_start Start TLS handshake */
/* nx_tcp_server_socket_unaccept Clear accepted socket */
/* _nx_tcpserver_relisten Re-listen on all sockets */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_thread_entry */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* fixed packet leak issue, */
/* resulting in version 6.1 */
/* 10-15-2021 Yuxin Zhou Modified comment(s), and */
/* fixed TLS connection */
/* deadlock issue, */
/* resulting in version 6.1.9 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_connect_process(NX_TCPSERVER *server_ptr)
{
UINT status;
NX_TCP_SESSION *session_ptr = NX_NULL;
/* Is any socket listening? */
if(server_ptr -> nx_tcpserver_listen_session == NX_NULL)
{
/* No. Check whether listen is done. */
if(server_ptr -> nx_tcpserver_listen_port == 0)
{
return;
}
/* Get a socket to listen. */
status = _nx_tcpserver_session_allocate(server_ptr, &session_ptr);
if(status)
{
return;
}
status = nx_tcp_server_socket_relisten(server_ptr -> nx_tcpserver_ip,
server_ptr -> nx_tcpserver_listen_port,
&session_ptr -> nx_tcp_session_socket);
if((status != NX_SUCCESS) && (status != NX_CONNECTION_PENDING))
{
return;
}
/* Store listen socket. */
server_ptr -> nx_tcpserver_listen_session = session_ptr;
}
else if(server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket.nx_tcp_socket_state == NX_TCP_CLOSED)
{
status = nx_tcp_server_socket_relisten(server_ptr -> nx_tcpserver_ip,
server_ptr -> nx_tcpserver_listen_port,
&session_ptr -> nx_tcp_session_socket);
if((status != NX_SUCCESS) && (status != NX_CONNECTION_PENDING))
{
return;
}
}
/* If session is connected, just return. */
if (server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_connected)
{
return;
}
/* Accept connection. */
status = nx_tcp_server_socket_accept(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket, server_ptr -> nx_tcpserver_accept_wait_option);
if(status == NX_SUCCESS)
{
#ifdef NX_TCPSERVER_ENABLE_TLS
/* If TLS, start the TLS handshake. */
if(server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_using_tls == NX_TRUE)
{
status = nx_secure_tls_session_start(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_tls_session,
&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket, NX_WAIT_FOREVER);
if(status != NX_SUCCESS)
{
nx_secure_tls_session_end(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_tls_session, NX_WAIT_FOREVER);
nx_tcp_socket_disconnect(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket, NX_NO_WAIT);
nx_tcp_server_socket_unaccept(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket);
}
}
if (status == NX_SUCCESS)
#endif
{
/* Set default expiration. */
server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_expiration = server_ptr -> nx_tcpserver_timeout;
if(server_ptr -> nx_tcpserver_new_connection)
{
/* Invoke new connection callback. */
server_ptr -> nx_tcpserver_new_connection(server_ptr, server_ptr -> nx_tcpserver_listen_session);
}
/* Set connection flag to true. */
server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_connected = NX_TRUE;
/* Clear listen socket. */
server_ptr -> nx_tcpserver_listen_session = NX_NULL;
}
}
else
{
nx_tcp_server_socket_unaccept(&server_ptr -> nx_tcpserver_listen_session -> nx_tcp_session_socket);
}
/* Relisten */
_nx_tcpserver_relisten(server_ptr);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_data_process PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked by the server thread whenever */
/* data is received from the remote client. If the application passes */
/* a receive callback to _nx_tcpserver_create, it will be invoked here.*/
/* */
/* INPUT */
/* */
/* server_ptr Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* nx_tcpserver_receive_data Callback to process data */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_thread_entry */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_data_process(NX_TCPSERVER *server_ptr)
{
UINT i;
NX_TCP_SOCKET *socket_ptr;
/* Do nothing if callback is not set. */
if(server_ptr -> nx_tcpserver_receive_data == NX_NULL)
{
return;
}
/* Initialize TCP sockets. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
socket_ptr = &(server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket);
if(socket_ptr -> nx_tcp_socket_receive_queue_count)
{
/* Reset default expiration. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_expiration = server_ptr -> nx_tcpserver_timeout;
/* Invoke receive data callback. */
server_ptr -> nx_tcpserver_receive_data(server_ptr, &server_ptr -> nx_tcpserver_sessions[i]);
/* Relisten */
_nx_tcpserver_relisten(server_ptr);
}
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_disconnect_process PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked by the server thread whenever */
/* a socket is disconnected. If the application passes a disconnect */
/* callback to _nx_tcpserver_create, it will be invoked here. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* nx_tcpserver_connection_end Callback for disconnections */
/* _nx_tcpserver_relisten Re-listen on free sockets */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_thread_entry */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* fixed packet leak issue, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_disconnect_process(NX_TCPSERVER *server_ptr)
{
UINT i;
NX_TCP_SOCKET *socket_ptr;
/* Do nothing if callback is not set. */
if(server_ptr -> nx_tcpserver_connection_end == NX_NULL)
{
return;
}
/* Initialize TCP sockets. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
socket_ptr = &(server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket);
if((socket_ptr -> nx_tcp_socket_state > NX_TCP_ESTABLISHED) ||
((socket_ptr -> nx_tcp_socket_state < NX_TCP_SYN_SENT) &&
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_expiration))
{
/* Invoke disconnect callback. */
server_ptr -> nx_tcpserver_connection_end(server_ptr, &server_ptr -> nx_tcpserver_sessions[i]);
/* Reset epiration of session. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_expiration = 0;
/* Set connection flag to false. */
server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_connected = NX_FALSE;
/* Relisten */
_nx_tcpserver_relisten(server_ptr);
}
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_timeout_process PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is invoked by the server thread whenever */
/* a timeout event is encountered (triggered by the timeout timer). */
/* If the application passes a disconnect callback to */
/* _nx_tcpserver_create, it will be invoked here. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* nx_tcpserver_connection_timeout Callback to process timeout */
/* _nx_tcpserver_relisten Re-listen on free sockets */
/* */
/* CALLED BY */
/* */
/* _nx_tcpserver_thread_entry */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), and */
/* fixed packet leak issue, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_timeout_process(NX_TCPSERVER *server_ptr)
{
UINT i;
NX_TCP_SESSION *session_ptr;
/* Do nothing if callback is not set. */
if(server_ptr -> nx_tcpserver_connection_timeout == NX_NULL)
{
return;
}
/* Initialize TCP sockets. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
session_ptr = &server_ptr -> nx_tcpserver_sessions[i];
/* Skip socket that is not used. */
if(session_ptr -> nx_tcp_session_socket.nx_tcp_socket_state == NX_TCP_CLOSED)
{
continue;
}
/* Skip socket that is already timeout. */
if(session_ptr -> nx_tcp_session_expiration == 0)
{
continue;
}
/* Is the session timeout? */
if(session_ptr -> nx_tcp_session_expiration > NX_TCPSERVER_TIMEOUT_PERIOD)
session_ptr -> nx_tcp_session_expiration -= NX_TCPSERVER_TIMEOUT_PERIOD;
else
{
session_ptr -> nx_tcp_session_expiration = 0;
/* Invoke timeout callback. */
server_ptr -> nx_tcpserver_connection_timeout(server_ptr, &server_ptr -> nx_tcpserver_sessions[i]);
/* Set connection flag to false. */
session_ptr -> nx_tcp_session_connected = NX_FALSE;
/* Relisten */
_nx_tcpserver_relisten(server_ptr);
}
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_thread_entry PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function is the entry point for the socket server */
/* thread. It continually loops, checking the event flags and */
/* dispatching processing when events are encountered. */
/* */
/* INPUT */
/* */
/* tcpserver_address Pointer to socket server */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _nx_tcpserver_connect_process Process new connection */
/* _nx_tcpserver_data_process Process received data */
/* _nx_tcpserver_disconnect_process Process disconnection event */
/* _nx_tcpserver_timeout_process Process server timeout */
/* */
/* CALLED BY */
/* */
/* ThreadX */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
static VOID _nx_tcpserver_thread_entry(ULONG tcpserver_address)
{
ULONG events;
UINT status;
NX_TCPSERVER *server_ptr = (NX_TCPSERVER *)tcpserver_address;
/* Loop to process events. */
while(1)
{
status = tx_event_flags_get(&server_ptr -> nx_tcpserver_event_flags, NX_TCPSERVER_ANY_EVENT, TX_OR_CLEAR, &events, TX_WAIT_FOREVER);
/* Check the return status. */
if(status)
{
/* If an error occurs, simply continue the loop. */
continue;
}
/* Otherwise, an event is present. Process according to the event. */
/* Check for a connect event. */
if(events & NX_TCPSERVER_CONNECT)
{
/* Call the connect processing. */
_nx_tcpserver_connect_process(server_ptr);
}
/* Check for a data event. */
if(events & NX_TCPSERVER_DATA)
{
/* Call the receive data processing. */
_nx_tcpserver_data_process(server_ptr);
}
/* Check for a disconnect event. */
if(events & NX_TCPSERVER_DISCONNECT)
{
/* Call the disconnect processing. */
_nx_tcpserver_disconnect_process(server_ptr);
}
/* Check for a timeout event. */
if(events & NX_TCPSERVER_TIMEOUT)
{
/* Call the disconnect processing. */
_nx_tcpserver_timeout_process(server_ptr);
}
}
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_stop PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is called by an application to stop a currently */
/* running socket server. It shuts down the server thread and stops */
/* listening on all internal TCP sockets. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to server structure */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_thread_suspend Stop server thread */
/* tx_timer_deactivate Stop server timeout timer */
/* nx_tcp_server_socket_unlisten Stop listening on TCP socket */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_tcpserver_stop(NX_TCPSERVER *server_ptr)
{
UINT status;
/* Check whether listen is done. */
if(server_ptr -> nx_tcpserver_listen_port == 0)
return NX_TCPSERVER_FAIL;
/* Suspend thread. */
tx_thread_suspend(&server_ptr -> nx_tcpserver_thread);
/* Deactivate timer. */
tx_timer_deactivate(&server_ptr -> nx_tcpserver_timer);
/* Unlisten. */
status = nx_tcp_server_socket_unlisten(server_ptr -> nx_tcpserver_ip, server_ptr -> nx_tcpserver_listen_port);
if(status == NX_SUCCESS)
{
/* Clear. */
server_ptr -> nx_tcpserver_listen_port = 0;
server_ptr -> nx_tcpserver_listen_session = NX_NULL;
}
return status;
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_tcpserver_delete PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is called by an application to clean up a previously */
/* created socket server. It cleans up the server thread and closes */
/* deletes all internal TCP sockets and TLS sessions. */
/* */
/* INPUT */
/* */
/* server_ptr Pointer to server structure */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_thread_terminate Stop server thread */
/* tx_thread_delete Stop server timeout timer */
/* tx_event_flags_delete Delete server event flags */
/* tx_timer_deactivate Deactivate timeout timer */
/* tx_timer_delete Delete timeout timer */
/* nx_tcp_socket_disconnect Disconnect TCP sockets */
/* nx_tcp_server_socket_unaccept Stop listening on TCP sockets */
/* nx_tcp_socket_delete Delete TCP socket */
/* */
/* CALLED BY */
/* */
/* Application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_tcpserver_delete(NX_TCPSERVER *server_ptr)
{
UINT i;
NX_TCP_SOCKET *socket_ptr;
/* Terminate server thread. */
tx_thread_terminate(&server_ptr -> nx_tcpserver_thread);
/* Delete server thread. */
tx_thread_delete(&server_ptr -> nx_tcpserver_thread);
/* Delete the event flag group */
tx_event_flags_delete(&server_ptr -> nx_tcpserver_event_flags);
/* Deactivate and delete timer. */
tx_timer_deactivate(&server_ptr -> nx_tcpserver_timer);
tx_timer_delete(&server_ptr -> nx_tcpserver_timer);
/* Delete all opened sockets. */
for(i = 0; i < server_ptr -> nx_tcpserver_sessions_count; i++)
{
/* Get socket pointer. */
socket_ptr = &server_ptr -> nx_tcpserver_sessions[i].nx_tcp_session_socket;
/* Disconnect the socket. */
nx_tcp_socket_disconnect(socket_ptr, NX_NO_WAIT);
/* unaccept the socket. */
nx_tcp_server_socket_unaccept(socket_ptr);
/* Delete the socket. */
nx_tcp_socket_delete(socket_ptr);
}
/* Return successful compeletion. */
return NX_SUCCESS;
}