FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
ESPAsyncWebServer/src/AsyncEventSource.cpp at main · ESP32Async/ESPAsyncWebServer · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
ESP32Async
/
ESPAsyncWebServer
Public
forked from
me-no-dev/ESPAsyncWebServer
Notifications
You must be signed in to change notification settings
Fork
108
Star
648
Code
Issues
0
Pull requests
1
Discussions
Actions
Projects
Security and quality
3
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
ESPAsyncWebServer
/
src
/
AsyncEventSource.cpp
Copy path
More file actions
More file actions
Latest commit
History
History
History
484 lines (414 loc) · 13.6 KB
Breadcrumbs
ESPAsyncWebServer
/
src
/
AsyncEventSource.cpp
Copy path
File metadata and controls
484 lines (414 loc) · 13.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
//
SPDX-License-Identifier: LGPL-3.0-or-later
//
Copyright 2016-2026 Hristo Gochkov, Mathieu Carbou, Emil Muratov, Will Miles
#
include
"
AsyncEventSource.h
"
#
include
"
AsyncWebServerLogging.h
"
#
include
<
algorithm
>
#
include
<
memory
>
#
include
<
utility
>
#
define
ASYNC_SSE_NEW_LINE_CHAR
(
char
)
0xa
using
namespace
asyncsrv
;
static
String
generateEventMessage
(
const
char
*message,
const
char
*event,
uint32_t
id,
uint32_t
reconnect) {
String str;
size_t
len{
0
};
if
(message) {
len +=
strlen
(message);
}
if
(event) {
len +=
strlen
(event);
}
len +=
42
;
//
give it some overhead
if
(!str.
reserve
(len)) {
async_ws_log_e
(
"
Failed to allocate
"
);
return
asyncsrv::emptyString;
}
if
(reconnect) {
str += T_retry_;
str += reconnect;
str +=
ASYNC_SSE_NEW_LINE_CHAR
;
//
'\n'
}
if
(id) {
str += T_id__;
str += id;
str +=
ASYNC_SSE_NEW_LINE_CHAR
;
//
'\n'
}
if
(event !=
NULL
) {
str += T_event_;
str += event;
str +=
ASYNC_SSE_NEW_LINE_CHAR
;
//
'\n'
}
if
(!message) {
return
str;
}
size_t
messageLen =
strlen
(message);
char
*lineStart = (
char
*)message;
char
*lineEnd;
do
{
char
*nextN =
strchr
(lineStart,
'
\n
'
);
char
*nextR =
strchr
(lineStart,
'
\r
'
);
if
(nextN ==
NULL
&& nextR ==
NULL
) {
//
a message is a single-line string
str += T_data_;
str += message;
str += T_nn;
return
str;
}
//
a message is a multi-line string
char
*nextLine =
NULL
;
if
(nextN !=
NULL
&& nextR !=
NULL
) {
//
windows line-ending \r\n
if
(nextR +
1
== nextN) {
//
normal \r\n sequence
lineEnd = nextR;
nextLine = nextN +
1
;
}
else
{
//
some abnormal \n \r mixed sequence
lineEnd =
std::min
(nextR, nextN);
nextLine = lineEnd +
1
;
}
}
else
if
(nextN !=
NULL
) {
//
Unix/Mac OS X LF
lineEnd = nextN;
nextLine = nextN +
1
;
}
else
{
//
some ancient garbage
lineEnd = nextR;
nextLine = nextR +
1
;
}
str += T_data_;
str.
concat
(lineStart, lineEnd - lineStart);
str +=
ASYNC_SSE_NEW_LINE_CHAR
;
//
\n
lineStart = nextLine;
}
while
(lineStart < ((
char
*)message + messageLen));
//
append another \n to terminate message
str +=
ASYNC_SSE_NEW_LINE_CHAR
;
//
'\n'
return
str;
}
//
Message
size_t
AsyncEventSourceMessage::ack
(
size_t
len, __attribute__((unused)) uint32_t time) {
//
If the whole message is now acked...
if
(_acked + len > _data->
length
()) {
//
Return the number of extra bytes acked (they will be carried on to the next message)
const
size_t
extra = _acked + len - _data->
length
();
_acked = _data->
length
();
return
extra;
}
//
Return that no extra bytes left.
_acked += len;
return
0
;
}
size_t
AsyncEventSourceMessage::write
(AsyncClient *client) {
if
(!client) {
return
0
;
}
if
(_sent >= _data->
length
() || !client->
canSend
()) {
return
0
;
}
size_t
len =
std::min
(_data->
length
() - _sent, client->
space
());
/*
add() would call lwip's tcp_write() under the AsyncTCP hood with apiflags argument.
By default apiflags=ASYNC_WRITE_FLAG_COPY
we could have used apiflags with this flag unset to pass data by reference and avoid copy to socket buffer,
but looks like it does not work for Arduino's lwip in ESP32/IDF
it is enforced in https://github.com/espressif/esp-lwip/blob/0606eed9d8b98a797514fdf6eabb4daf1c8c8cd9/src/core/tcp_out.c#L422C5-L422C30
if LWIP_NETIF_TX_SINGLE_PBUF is set, and it is set indeed in IDF
https://github.com/espressif/esp-idf/blob/a0f798cfc4bbd624aab52b2c194d219e242d80c1/components/lwip/port/include/lwipopts.h#L744
So let's just keep it enforced ASYNC_WRITE_FLAG_COPY and keep in mind that there is no zero-copy
*/
size_t
written = client->
add
(_data->
c_str
() + _sent, len,
ASYNC_WRITE_FLAG_COPY
);
//
ASYNC_WRITE_FLAG_MORE
_sent += written;
return
written;
}
size_t
AsyncEventSourceMessage::send
(AsyncClient *client) {
size_t
sent =
write
(client);
return
sent && client->
send
() ? sent :
0
;
}
//
Client
AsyncEventSourceClient::AsyncEventSourceClient
(AsyncClient *client, AsyncEventSource *server,
uint32_t
lastId)
: _client(client), _server(server), _lastId(lastId) {
_client->
setRxTimeout
(
0
);
_client->
onError
(
NULL
,
NULL
);
_client->
onAck
(
[](
void
*r, AsyncClient *c,
size_t
len,
uint32_t
time) {
(
void
)c;
static_cast
<AsyncEventSourceClient *>(r)->
_onAck
(len, time);
},
this
);
_client->
onPoll
(
[](
void
*r, AsyncClient *c) {
(
void
)c;
static_cast
<AsyncEventSourceClient *>(r)->
_onPoll
();
},
this
);
_client->
onData
(
NULL
,
NULL
);
_client->
onTimeout
(
[
this
](
void
*r, AsyncClient *c
__attribute__
((unused)),
uint32_t
time) {
static_cast
<AsyncEventSourceClient *>(r)->
_onTimeout
(time);
},
this
);
_client->
onDisconnect
(
[
this
](
void
*r, AsyncClient *c) {
static_cast
<AsyncEventSourceClient *>(r)->
_onDisconnect
();
delete
c;
},
this
);
_server->
_addClient
(
this
);
_client->
setNoDelay
(
true
);
}
AsyncEventSourceClient::~AsyncEventSourceClient
() {
//
Protect message queue access (size checks and modifications) which is not thread-safe.
asyncsrv::lock_guard_type
lock
(_lockmq);
_messageQueue.
clear
();
close
();
}
bool
AsyncEventSourceClient::_queueMessage
(
const
char
*message,
size_t
len) {
//
Protect message queue access (size checks and modifications) which is not thread-safe.
asyncsrv::lock_guard_type
lock
(_lockmq);
if
(_messageQueue.
size
() >=
SSE_MAX_QUEUED_MESSAGES
) {
async_ws_log_w
(
"
Event message queue overflow: discard message
"
);
return
false
;
}
if
(_client) {
_messageQueue.
emplace_back
(message, len);
}
else
{
_messageQueue.
clear
();
return
false
;
}
/*
throttle queue run
if Q is filled for >25% then network/CPU is congested, since there is no zero-copy mode for socket buff
forcing Q run will only eat more heap ram and blow the buffer, let's just keep data in our own queue
the queue will be processed at least on each onAck()/onPoll() call from AsyncTCP
*/
if
(_client && _client->
canSend
() && _messageQueue.
size
() <
SSE_MAX_QUEUED_MESSAGES
>>
2
) {
_runQueue
();
}
return
true
;
}
bool
AsyncEventSourceClient::_queueMessage
(AsyncEvent_SharedData_t &&msg) {
//
Protect message queue access (size checks and modifications) which is not thread-safe.
asyncsrv::lock_guard_type
lock
(_lockmq);
if
(_messageQueue.
size
() >=
SSE_MAX_QUEUED_MESSAGES
) {
async_ws_log_w
(
"
Event message queue overflow: discard message
"
);
return
false
;
}
if
(_client) {
_messageQueue.
emplace_back
(
std::move
(msg));
}
else
{
_messageQueue.
clear
();
return
false
;
}
/*
throttle queue run
if Q is filled for >25% then network/CPU is congested, since there is no zero-copy mode for socket buff
forcing Q run will only eat more heap ram and blow the buffer, let's just keep data in our own queue
the queue will be processed at least on each onAck()/onPoll() call from AsyncTCP
*/
if
(_client && _client->
canSend
() && _messageQueue.
size
() <
SSE_MAX_QUEUED_MESSAGES
>>
2
) {
_runQueue
();
}
return
true
;
}
void
AsyncEventSourceClient::_onAck
(
size_t
len
__attribute__
((unused)), uint32_t time __attribute__((unused))) {
//
Protect message queue access (size checks and modifications) which is not thread-safe.
asyncsrv::lock_guard_type
lock
(_lockmq);
//
adjust in-flight len
if
(len < _inflight) {
_inflight -= len;
}
else
{
_inflight =
0
;
}
//
acknowledge as much messages's data as we got confirmed len from a AsyncTCP
while
(len && _messageQueue.
size
()) {
len = _messageQueue.
front
().
ack
(len);
if
(_messageQueue.
front
().
finished
()) {
//
now we could release full ack'ed messages, we were keeping it unless send confirmed from AsyncTCP
_messageQueue.
pop_front
();
}
}
//
try to send another batch of data
if
(_messageQueue.
size
()) {
_runQueue
();
}
}
void
AsyncEventSourceClient::_onPoll
() {
//
Protect message queue access (size checks and modifications) which is not thread-safe.
asyncsrv::lock_guard_type
lock
(_lockmq);
if
(_messageQueue.
size
()) {
_runQueue
();
}
}
void
AsyncEventSourceClient::_onTimeout
(
uint32_t
time
__attribute__
((unused))) {
if
(_client) {
_client->
close
();
}
}
void
AsyncEventSourceClient::_onDisconnect
() {
if
(!_client) {
return
;
}
_client =
nullptr
;
_server->
_handleDisconnect
(
this
);
}
void
AsyncEventSourceClient::close
() {
if
(_client) {
_client->
close
();
}
}
bool
AsyncEventSourceClient::send
(
const
char
*message,
const
char
*event,
uint32_t
id,
uint32_t
reconnect) {
if
(!
connected
()) {
return
false
;
}
return
_queueMessage
(std::make_shared<String>(
generateEventMessage
(message, event, id, reconnect)));
}
void
AsyncEventSourceClient::_runQueue
() {
if
(!_client) {
return
;
}
//
there is no need to lock the mutex here, 'cause all the calls to this method must be already lock'ed
size_t
total_bytes_written =
0
;
for
(
auto
i = _messageQueue.
begin
(); i != _messageQueue.
end
(); ++i) {
if
(!i->
sent
()) {
const
size_t
bytes_written = i->
write
(_client);
total_bytes_written += bytes_written;
_inflight += bytes_written;
if
(bytes_written ==
0
|| _inflight > _max_inflight) {
//
Serial.print("_");
break
;
}
}
}
//
flush socket
if
(_client && total_bytes_written) {
_client->
send
();
}
}
void
AsyncEventSourceClient::set_max_inflight_bytes
(
size_t
value) {
if
(value >=
SSE_MIN_INFLIGH
&& value <=
SSE_MAX_INFLIGH
) {
_max_inflight = value;
}
}
/*
AsyncEventSource
*/
void
AsyncEventSource::authorizeConnect
(ArAuthorizeConnectHandler cb) {
AsyncAuthorizationMiddleware *m =
new
AsyncAuthorizationMiddleware
(
401
, cb);
m->
_freeOnRemoval
=
true
;
addMiddleware
(m);
}
void
AsyncEventSource::_addClient
(AsyncEventSourceClient *client) {
if
(!client) {
return
;
}
if
(_connectcb) {
_connectcb
(client);
}
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
_clients.
emplace_back
(client);
_adjust_inflight_window
();
}
void
AsyncEventSource::_handleDisconnect
(AsyncEventSourceClient *client) {
if
(_disconnectcb) {
_disconnectcb
(client);
}
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
for
(
auto
i = _clients.
begin
(); i != _clients.
end
(); ++i) {
if
(i->
get
() == client) {
_clients.
erase
(i);
break
;
}
}
_adjust_inflight_window
();
}
void
AsyncEventSource::close
() {
//
While the whole loop is not done, the linked list is locked and so the
//
iterator should remain valid even when AsyncEventSource::_handleDisconnect()
//
is called very early
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
for
(
const
auto
&c : _clients) {
if
(c->
connected
()) {
/*
*
* @brief: Fix self-deadlock by using recursive_mutex instead.
* Due to c->close() shall call the callback function _onDisconnect()
* The calling flow _onDisconnect() --> _handleDisconnect() --> deadlock
*/
c->
close
();
}
}
}
//
pmb fix
size_t
AsyncEventSource::avgPacketsWaiting
()
const
{
size_t
aql =
0
;
uint32_t
nConnectedClients =
0
;
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
for
(
const
auto
&c : _clients) {
if
(c->
connected
()) {
aql += c->
packetsWaiting
();
++nConnectedClients;
}
}
return
nConnectedClients ==
0
?
0
: ((aql) + (nConnectedClients /
2
)) / (nConnectedClients);
//
round up
}
AsyncEventSource::SendStatus
AsyncEventSource::send
(
const
char
*message,
const
char
*event,
uint32_t
id,
uint32_t
reconnect) {
AsyncEvent_SharedData_t shared_msg = std::make_shared<String>(
generateEventMessage
(message, event, id, reconnect));
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
size_t
hits =
0
;
size_t
miss =
0
;
for
(
const
auto
&c : _clients) {
if
(c->
connected
()) {
if
(c->
write
(shared_msg)) {
++hits;
}
else
{
++miss;
}
}
}
return
hits ==
0
?
DISCARDED
: (miss ==
0
?
ENQUEUED
:
PARTIALLY_ENQUEUED
);
}
size_t
AsyncEventSource::count
()
const
{
asyncsrv::lock_guard_type
lock
(_client_queue_lock);
size_t
n_clients{
0
};
for
(
const
auto
&i : _clients) {
if
(i->
connected
()) {
++n_clients;
}
}
return
n_clients;
}
bool
AsyncEventSource::canHandle
(AsyncWebServerRequest *request)
const
{
return
request->
isSSE
() && request->
url
().
equals
(_url);
}
void
AsyncEventSource::handleRequest
(AsyncWebServerRequest *request) {
request->
send
(
new
AsyncEventSourceResponse
(
this
));
}
//
list iteration protected by caller's lock
void
AsyncEventSource::_adjust_inflight_window
() {
const
size_t
clientCount =
count
();
if
(clientCount) {
size_t
inflight =
SSE_MAX_INFLIGH
/ clientCount;
for
(
const
auto
&c : _clients) {
if
(c->
connected
()) {
c->
set_max_inflight_bytes
(inflight);
}
}
//
Serial.printf("adjusted inflight to: %u\n", inflight);
}
}
/*
Response
*/
AsyncEventSourceResponse::AsyncEventSourceResponse
(AsyncEventSource *server) : _server(server) {
_code =
200
;
_contentType = T_text_event_stream;
_sendContentLength =
false
;
addHeader
(T_Cache_Control, T_no_cache);
addHeader
(T_Connection, T_keep_alive);
}
void
AsyncEventSourceResponse::_respond
(AsyncWebServerRequest *request) {
String out;
_assembleHead
(out, request->
version
());
uint32_t
lastId =
0
;
if
(request->
hasHeader
(T_Last_Event_ID)) {
lastId =
strtoul
(request->
getHeader
(T_Last_Event_ID)->
value
().
c_str
(),
nullptr
,
10
);
}
request->
client
()->
write
(out.
c_str
(), _headLength);
//
Add a new AsyncEventSourceClient to the server's list of clients
//
This adopts the ownership of the AsyncTCP's client pointer from `request` parameter
new
AsyncEventSourceClient
(request->
clientRelease
(), _server, lastId);
}
Back
|
FazBrowse Home
|
New Git URL