adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: websocket: update docs to describe additional callback parameter

Browse source 
Update HTTP server documentation and migration guide to account for
added request_ctx parameter to the http_resource_websocket_cb_t
callback.

Signed-off-by: Matt Rodgers <mrodgers@witekio.com>
This commit is contained in:
Matt Rodgers 2025-01-01 13:09:16 +00:00 committed by Benjamin Cabé
parent 549e5de277
commit 579e5868b0
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/connectivity/networking/api/http_server.rst
View file

@ -342,7 +342,7 @@ release it when done.
static int ws_socket; static int ws_socket;
static uint8_t ws_recv_buffer[1024]; static uint8_t ws_recv_buffer[1024];
int ws_setup(int sock, void *user_data) int ws_setup(int sock, struct http_request_ctx *request_ctx, void *user_data)
{ {
ws_socket = sock; ws_socket = sock;
return 0; return 0;

5
doc/releases/migration-guide-4.1.rst
View file

@ -367,6 +367,11 @@ Networking
rather than directly in the :c:struct:`http_client_ctx` to correctly handle concurrent requests rather than directly in the :c:struct:`http_client_ctx` to correctly handle concurrent requests
on different HTTP/2 streams. on different HTTP/2 streams.
* The HTTP server public API function signature for the :c:type:`http_resource_websocket_cb_t` has
changed, a :c:struct:`http_request_ctx` parameter has been added. The application may use this to
access the request headers of the HTTP upgrade request, which may be useful in deciding whether
to accept or reject a websocket connection.
* The :kconfig:option:`CONFIG_NET_L2_OPENTHREAD` symbol no longer implies the * The :kconfig:option:`CONFIG_NET_L2_OPENTHREAD` symbol no longer implies the
:kconfig:option:`CONFIG_NVS` Kconfig option. Platforms using OpenThread must explicitly enable :kconfig:option:`CONFIG_NVS` Kconfig option. Platforms using OpenThread must explicitly enable
either the :kconfig:option:`CONFIG_NVS` or :kconfig:option:`CONFIG_ZMS` Kconfig option. either the :kconfig:option:`CONFIG_NVS` or :kconfig:option:`CONFIG_ZMS` Kconfig option.