docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.59.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 .SH DEFAULT
  42 0
  43 .SH PROTOCOLS
  44 HTTP, SMTP, POP3 and IMAP
  45 .SH EXAMPLE
  46 .nf
  47 CURL *curl = curl_easy_init();
  48 if(curl) {
  49   CURLcode ret;
  50   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  51   curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
  52   ret = curl_easy_perform(curl);
  53   if(ret == CURLE_OK) {
  54     /* only connected! */
  55   }
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Added in 7.15.2
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL  "(3), "
  64 .BR curl_easy_recv "(3), " curl_easy_send "(3) "