luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

curl_ws_recv.md: the 'meta' pointer is only returned on success

Browse Source 
Reported-by: Dylam De La Torre
Fixes #15340
Closes #15343
This commit is contained in:
Daniel Stenberg 2024-10-20 22:34:10 +02:00
parent d6bae1cb8f
commit 51724c43e3
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/libcurl/curl_ws_recv.md
View File

@ -37,12 +37,14 @@ Retrieves as much as possible of a received WebSocket data fragment into the
number of bytes actually stored.
If there is more fragment data to deliver than what fits in the provided
*buffer*, libcurl returns a full buffer and the application needs to call
this function again to continue draining the buffer.
*buffer*, libcurl returns a full buffer and the application needs to call this
function again to continue draining the buffer.
The *meta* pointer gets set to point to a *const struct curl_ws_frame*
that contains information about the received data. See the
curl_ws_meta(3) for details on that struct.
If the function call is successful, the *meta* pointer gets set to point to a
*const struct curl_ws_frame* that contains information about the received
data. That struct must not be freed and its contents must not be relied upon
anymore once another WebSocket function is called. See the curl_ws_meta(3) for
details on that struct.a
# %PROTOCOLS%