curl / libcurl / API / curl_easy_setopt / CURLOPT_ACCEPTTIMEOUT_MS

CURLOPT_ACCEPTTIMEOUT_MS explained

Name

CURLOPT_ACCEPTTIMEOUT_MS - timeout waiting for FTP server to connect back

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPTTIMEOUT_MS, long ms);

Description

Pass a long telling libcurl the maximum number of milliseconds to wait for a server to connect back to libcurl when an active FTP connection is used. When active FTP is used, the client (libcurl) tells the server to do a TCP connect back to the client, instead of vice versa for passive FTP.

This option has no purpose for passive FTP.

Default

60000 milliseconds

Protocols

This functionality affects ftp only

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/path/file");
 
    /* wait no more than 5 seconds for the FTP server to connect */
    curl_easy_setopt(curl, CURLOPT_ACCEPTTIMEOUT_MS, 5000L);
 
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.24.0

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.