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

CURLMOPT_SOCKETFUNCTION.3: clarify CURL_POLL_REMOVE

Browse Source 
The removal is brief or long, don't assume.

Reported-by: Luca Niccoli

Fixes #9799
Closes #9800
This commit is contained in:
Daniel Stenberg 2022-10-26 00:35:07 +02:00
parent cd95ee9f77
commit 716ad5ea49
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.3
View File

@ -40,12 +40,16 @@ CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETFUNCTION, socket_callb
Pass a pointer to your callback function, which should match the prototype
shown above.
When the \fIcurl_multi_socket_action(3)\fP function is called, it informs the
application about updates in the socket (file descriptor) status by doing
none, one, or multiple calls to the \fBsocket_callback\fP. The callback
function gets status updates with changes since the previous time the callback
was called. If the given callback pointer is set to NULL, no callback will be
called.
When the \fIcurl_multi_socket_action(3)\fP function is called, it uses this
callback to inform the application about updates in the socket (file
descriptor) status by doing none, one, or multiple calls to the
\fBsocket_callback\fP. The callback function gets status updates with changes
since the previous time the callback was called. If the given callback pointer
is set to NULL, no callback will be called.
libcurl then expects the application to monitor the sockets for the specific
activities and tell libcurl again when something happens on one of them. Tell
libcurl by calling \fIcurl_multi_socket_action(3)\fP.
.SH "CALLBACK ARGUMENTS"
\fIeasy\fP identifies the specific transfer for which this update is related.
@ -73,7 +77,8 @@ Wait for outgoing data. For the socket to become writable.
Wait for incoming and outgoing data. For the socket to become readable or
writable.
.IP CURL_POLL_REMOVE
The specified socket/file descriptor is no longer used by libcurl.
The specified socket/file descriptor is no longer used by libcurl for any
active transfer. It might soon be added again.
.SH DEFAULT
NULL (no callback)
.SH PROTOCOLS