CURLOPT_FTP_RESPONSE_TIMEOUT(3)

CURLOPT_FTP_RESPONSE_TIMEOUT3

Time allowed to wait for ftp response

Usage

#include <curl/curl.h>

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

Overview

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 CURLOPT_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

Examples

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);
}

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.

Releases

4 releases since Debian 8 (Jessie); the text changed 3 times.

  1. 8
  2. 9
  3. 10
  4. 11

Availability

Added in 7.10.8

From libcurl4-doc 7.74.0-1.3+deb11u13 in Debian 11 (Bullseye). Parsed by carta from the page's man source.