diff options
Diffstat (limited to 'docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3')
| -rw-r--r-- | docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 b/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 new file mode 100644 index 00000000..0896d150 --- /dev/null +++ b/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3 @@ -0,0 +1,51 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2015, 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 +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLINFO_ACTIVESOCKET 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" +.SH NAME +CURLINFO_ACTIVESOCKET \- get the active socket +.SH SYNOPSIS +#include <curl/curl.h> + +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. + +This option was added as a replacement for \fICURLINFO_LASTSOCKET(3)\fP since +that one isn't working on all platforms. +.SH PROTOCOLS +All +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.45.0 +.SH RETURN VALUE +Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " +.BR CURLINFO_LASTSOCKET "(3), " |