Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_FTP_RESPONSE_TIMEOUT (3)

Name

CURLOPT_FTP_RESPONSE_TIMEOUT - time allowed to wait for FTP response

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_FTP_RESPONSE_TIMEOUT,
long timeout);

Description

curl_easy_setopt options                       CURLOPT_FTP_RESPONSE_TIMEOUT(3)



NAME
       CURLOPT_FTP_RESPONSE_TIMEOUT - time allowed to wait for FTP response

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_FTP_RESPONSE_TIMEOUT,
       long timeout);

DESCRIPTION
       Pass a long.  Causes libcurl to set a timeout period  (in  seconds)  on
       the  amount of time that the server is allowed to take in order to send
       a response message for a command before the session is considered dead.
       While  libcurl  is  waiting  for  a response, this value overrides CUR-
       LOPT_TIMEOUT(3). It is recommended that if  used  in  conjunction  with
       CURLOPT_TIMEOUT(3),  you set CURLOPT_FTP_RESPONSE_TIMEOUT(3) to a value
       smaller than CURLOPT_TIMEOUT(3).

DEFAULT
       None

PROTOCOLS
       FTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/slow.txt");
         /* wait no more than 23 seconds */
         curl_easy_setopt(curl, CURLOPT_FTP_RESPONSE_TIMEOUT, 23L);
         ret = curl_easy_perform(curl);

         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.10.8

RETURN VALUE
       Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if  not.
       Returns  CURLE_BAD_FUNCTION_ARGUMENT  if  set  to a negative value or a
       value that when converted to milliseconds is too large.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_TIMEOUT(3),           CURLOPT_CONNECTTIMEOUT(3),           CUR-
       LOPT_LOW_SPEED_LIMIT(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_FTP_RESPONSE_TIMEOUT(3)