Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_CONNECT_ONLY 3 "February 18, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_CONNECT_ONLY \- stop when connected to target server
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only);
31: .SH DESCRIPTION
32: Pass a long. If the parameter equals 1, it tells the library to perform all
33: the required proxy authentication and connection setup, but no data transfer,
34: and then return.
35:
36: The option can be used to simply test a connection to a server, but is more
37: useful when used with the \fICURLINFO_ACTIVESOCKET(3)\fP option to
38: \fIcurl_easy_getinfo(3)\fP as the library can set up the connection and then
39: the application can obtain the most recently used socket for special data
40: transfers.
41:
42: Transfers marked connect only will not reuse any existing connections and
43: connections marked connect only will not be allowed to get reused.
44: .SH DEFAULT
45: 0
46: .SH PROTOCOLS
47: HTTP, SMTP, POP3 and IMAP
48: .SH EXAMPLE
49: .nf
50: CURL *curl = curl_easy_init();
51: if(curl) {
52: CURLcode ret;
53: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
54: curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
55: ret = curl_easy_perform(curl);
56: if(ret == CURLE_OK) {
57: /* only connected! */
58: }
59: }
60: .fi
61: .SH AVAILABILITY
62: Added in 7.15.2
63: .SH RETURN VALUE
64: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
65: .SH "SEE ALSO"
66: .BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
67: .BR curl_easy_recv "(3), " curl_easy_send "(3) "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>