diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2020-06-04 17:20:17 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2020-06-05 08:50:48 +0200 |
| commit | a00668d2961dc3e2340c4c30375051ec8b55c68c (patch) | |
| tree | 49c1d5e41629da948beb5900bdc5165004a9526c | |
| parent | 42ed22fea621ca06986070815c14b9dfa25a41c1 (diff) | |
CURLINFO_ACTIVESOCKET.3: clarify the description
Reported-by: Jay Satiro
Fixes #5299
Closes #5520
| -rw-r--r-- | docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 b/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 index b42ba110f..e5d52a796 100644 --- a/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 +++ b/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -29,15 +29,17 @@ CURLINFO_ACTIVESOCKET \- get the active socket CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET, curl_socket_t *socket); .SH DESCRIPTION -Pass a pointer to a curl_socket_t to receive the active socket used by this -curl session. If the socket is no longer valid, \fICURL_SOCKET_BAD\fP is -returned. When you finish working with the socket, you must call -\fIcurl_easy_cleanup(3)\fP as usual on the easy handle and let libcurl close -the socket and cleanup other resources associated with the handle. This is -typically used in combination with \fICURLOPT_CONNECT_ONLY(3)\fP. +Pass a pointer to a curl_socket_t to receive the most recently active socket +used for the transfer connection by this curl session. If the socket is no +longer valid, \fICURL_SOCKET_BAD\fP is returned. When you are finished working +with the socket, you must call \fIcurl_easy_cleanup(3)\fP as usual on the easy +handle and let libcurl close the socket and cleanup other resources associated +with the handle. This option returns the active socket only after the transfer +is complete, and is typically used in combination with +\fICURLOPT_CONNECT_ONLY(3)\fP, which skips the transfer phase. -This option was added as a replacement for \fICURLINFO_LASTSOCKET(3)\fP since -that one isn't working on all platforms. +\fICURLINFO_ACTIVESOCKET(3)\fP was added as a replacement for +\fICURLINFO_LASTSOCKET(3)\fP since that one isn't working on all platforms. .SH PROTOCOLS All .SH EXAMPLE |