mirror of
https://codeberg.org/kiss-community/repo
synced 2024-10-27 05:16:16 -06:00
63 lines
2.0 KiB
Groff
63 lines
2.0 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_CONNECT_ONLY.md
|
||
|
.TH CURLOPT_CONNECT_ONLY 3 "March 15 2024" libcurl
|
||
|
.SH NAME
|
||
|
CURLOPT_CONNECT_ONLY \- stop when connected to target server
|
||
|
.SH SYNOPSIS
|
||
|
.nf
|
||
|
#include <curl/curl.h>
|
||
|
|
||
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only);
|
||
|
.fi
|
||
|
.SH DESCRIPTION
|
||
|
Pass a long. If the parameter equals 1, it tells the library to perform all
|
||
|
the required proxy authentication and connection setup, but no data transfer,
|
||
|
and then return.
|
||
|
|
||
|
The option can be used to simply test a connection to a server, but is more
|
||
|
useful when used with the \fICURLINFO_ACTIVESOCKET(3)\fP option to
|
||
|
\fIcurl_easy_getinfo(3)\fP as the library can set up the connection and then
|
||
|
the application can obtain the most recently used socket for special data
|
||
|
transfers.
|
||
|
|
||
|
Since 7.86.0, this option can be set to \(aq2\(aq and if HTTP or WebSocket are used,
|
||
|
libcurl performs the request and reads all response headers before handing
|
||
|
over control to the application.
|
||
|
|
||
|
Transfers marked connect only do not reuse any existing connections and
|
||
|
connections marked connect only are not allowed to get reused.
|
||
|
|
||
|
If the connect only transfer is done using the multi interface, the particular
|
||
|
easy handle must remain added to the multi handle for as long as the
|
||
|
application wants to use it. Once it has been removed with
|
||
|
\fIcurl_multi_remove_handle(3)\fP, \fIcurl_easy_send(3)\fP and
|
||
|
\fIcurl_easy_recv(3)\fP do not function.
|
||
|
.SH DEFAULT
|
||
|
0
|
||
|
.SH PROTOCOLS
|
||
|
HTTP, SMTP, POP3 and IMAP. For WS and WSS starting in 7.86.0.
|
||
|
.SH EXAMPLE
|
||
|
.nf
|
||
|
int main(void)
|
||
|
{
|
||
|
CURL *curl = curl_easy_init();
|
||
|
if(curl) {
|
||
|
CURLcode ret;
|
||
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
||
|
curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
|
||
|
ret = curl_easy_perform(curl);
|
||
|
if(ret == CURLE_OK) {
|
||
|
/* only connected! */
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
.fi
|
||
|
.SH AVAILABILITY
|
||
|
Added in 7.15.2
|
||
|
.SH RETURN VALUE
|
||
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||
|
.SH SEE ALSO
|
||
|
.BR CURLOPT_HTTPPROXYTUNNEL (3),
|
||
|
.BR CURLOPT_VERBOSE (3),
|
||
|
.BR curl_easy_recv (3),
|
||
|
.BR curl_easy_send (3)
|