mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
78 lines
2.8 KiB
Groff
78 lines
2.8 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 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.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.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLINFO_ACTIVESOCKET 3 "12 Sep 2015" "libcurl" "libcurl"
|
|
.SH NAME
|
|
CURLINFO_ACTIVESOCKET \- get the active socket
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET,
|
|
curl_socket_t *socket);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
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.
|
|
|
|
\fICURLINFO_ACTIVESOCKET(3)\fP was added as a replacement for
|
|
\fICURLINFO_LASTSOCKET(3)\fP since that one is not 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, "https://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),
|
|
.BR curl_easy_setopt (3),
|
|
.BR CURLINFO_LASTSOCKET (3),
|
|
.BR CURLOPT_CONNECT_ONLY (3)
|