| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2017, 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 |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| curl_socket_t sockfd; |
| curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| |
| /* Do not do the transfer - only connect to host */ |
| curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L); |
| res = curl_easy_perform(curl); |
| |
| /* Extract the socket from the curl handle */ |
| res = curl_easy_getinfo(curl, CURLINFO_ACTIVESOCKET, &sockfd); |
| |
| if(res != CURLE_OK) { |
| printf("Error: %s\\n", curl_easy_strerror(res)); |
| return 1; |
| } |
| } |
| .fi |
| .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), " |
