]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
curl_ws_recv.md: the 'meta' pointer is only returned on success
authorDaniel Stenberg <daniel@haxx.se>
Sun, 20 Oct 2024 20:34:10 +0000 (22:34 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Sun, 20 Oct 2024 20:58:27 +0000 (22:58 +0200)
Reported-by: Dylam De La Torre
Fixes #15340
Closes #15343

docs/libcurl/curl_ws_recv.md

index d5df8b3391fab02f528eb3ba3e12745013ce1d48..c13d74a5c68e77b7ecccec12069240eadce96c29 100644 (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.
-
-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.
+*buffer*, libcurl returns a full buffer and the application needs to call this
+function again to continue draining the buffer.
+
+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%