docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_CONNECT_ONLY \- stop when connected to target server
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only);
  30 .SH DESCRIPTION
  31 Pass a long. If the parameter equals 1, it tells the library to perform all
  32 the required proxy authentication and connection setup, but no data transfer,
  33 and then return.
  34
  35 The option can be used to simply test a connection to a server, but is more
  36 useful when used with the \fICURLINFO_ACTIVESOCKET(3)\fP option to
  37 \fIcurl_easy_getinfo(3)\fP as the library can set up the connection and then
  38 the application can obtain the most recently used socket for special data
  39 transfers.
  40 .SH DEFAULT
  41 0
  42 .SH PROTOCOLS
  43 HTTP, SMTP, POP3 and IMAP
  44 .SH EXAMPLE
  45 TODO
  46 .SH AVAILABILITY
  47 Added in 7.15.2
  48 .SH RETURN VALUE
  49 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  50 .SH "SEE ALSO"
  51 .BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL  "(3), "