Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_TCP_KEEPALIVE (3)

Name

CURLOPT_TCP_KEEPALIVE - alive probing

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_TCP_KEEPALIVE,  long
probe);

Description

CURLOPT_TCP_KEEPALIVE(3)   curl_easy_setopt options   CURLOPT_TCP_KEEPALIVE(3)



NAME
       CURLOPT_TCP_KEEPALIVE - enable TCP keep-alive probing

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_TCP_KEEPALIVE,  long
       probe);

DESCRIPTION
       Pass a long. If set to 1, TCP keepalive probes will be sent. The  delay
       and   frequency   of  these  probes  can  be  controlled  by  the  CUR-
       LOPT_TCP_KEEPIDLE(3) and CURLOPT_TCP_KEEPINTVL(3) options, provided the
       operating  system supports them. Set to 0 (default behavior) to disable
       keepalive probes

DEFAULT
       0

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

         /* enable TCP keep-alive for this transfer */
         curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);

         /* keep-alive idle time to 120 seconds */
         curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);

         /* interval time between keep-alive probes: 60 seconds */
         curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.25.0

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_TCP_KEEPIDLE(3), CURLOPT_TCP_KEEPINTVL(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_TCP_KEEPALIVE(3)