| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2019, 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. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_CONNECT_ONLY 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_CONNECT_ONLY \- stop when connected to target server |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only); |
| .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. |
| |
| Transfers marked connect only will not reuse any existing connections and |
| connections marked connect only will not be allowed to get reused. |
| .SH DEFAULT |
| 0 |
| .SH PROTOCOLS |
| HTTP, SMTP, POP3 and IMAP |
| .SH EXAMPLE |
| .nf |
| 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_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), " |
| .BR curl_easy_recv "(3), " curl_easy_send "(3) " |
