moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-14 21:45:13 -05:00
Code Issues Releases Wiki Activity

CURLINFO_ACTIVESOCKET.3: clarify the description

Browse Source 
Reported-by: Jay Satiro
Fixes #5299
Closes #5520
This commit is contained in:
Daniel Stenberg 2020-06-04 17:20:17 +02:00
parent 42ed22fea6
commit a00668d296
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3
View File

@ -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 .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * 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, CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET,
curl_socket_t *socket); curl_socket_t *socket);
.SH DESCRIPTION .SH DESCRIPTION
Pass a pointer to a curl_socket_t to receive the active socket used by this Pass a pointer to a curl_socket_t to receive the most recently active socket
curl session. If the socket is no longer valid, \fICURL_SOCKET_BAD\fP is used for the transfer connection by this curl session. If the socket is no
returned. When you finish working with the socket, you must call longer valid, \fICURL_SOCKET_BAD\fP is returned. When you are finished working
\fIcurl_easy_cleanup(3)\fP as usual on the easy handle and let libcurl close with the socket, you must call \fIcurl_easy_cleanup(3)\fP as usual on the easy
the socket and cleanup other resources associated with the handle. This is handle and let libcurl close the socket and cleanup other resources associated
typically used in combination with \fICURLOPT_CONNECT_ONLY(3)\fP. 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 \fICURLINFO_ACTIVESOCKET(3)\fP was added as a replacement for
that one isn't working on all platforms. \fICURLINFO_LASTSOCKET(3)\fP since that one isn't working on all platforms.
.SH PROTOCOLS .SH PROTOCOLS
All All
.SH EXAMPLE .SH EXAMPLE