Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_CONNECT_ONLY (3)

Name

CURLOPT_CONNECT_ONLY - stop when connected to target server

Synopsis

#include <curl/curl.h>

CURLcode   curl_easy_setopt(CURL  *handle,  CURLOPT_CONNECT_ONLY,  long
only);

Description

CURLOPT_CONNECT_ONLY(3)    curl_easy_setopt options    CURLOPT_CONNECT_ONLY(3)



NAME
       CURLOPT_CONNECT_ONLY - stop when connected to target server

SYNOPSIS
       #include <curl/curl.h>

       CURLcode   curl_easy_setopt(CURL  *handle,  CURLOPT_CONNECT_ONLY,  long
       only);

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  CURLINFO_ACTIVESOCKET(3) option to
       curl_easy_getinfo(3) as the library can set up the connection and  then
       the  application  can  obtain the most recently used socket for special
       data transfers.

DEFAULT
       0

PROTOCOLS
       HTTP, SMTP, POP3 and IMAP

EXAMPLE
       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! */
         }
       }

AVAILABILITY
       Added in 7.15.2

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_VERBOSE(3),    CURLOPT_HTTPPROXYTUNNEL(3),   curl_easy_recv(3),
       curl_easy_send(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014          CURLOPT_CONNECT_ONLY(3)