aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2024-02-28 21:23:34 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>2024-02-28 21:23:34 +0000
commit6a9977cde9914ddf75f6debd9810591e5b8f84ef (patch)
tree1b01132e15db02538dcf10922559df5a286d1cd6 /docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md
parente73cfcb7f7f74bf28d5b22092f1fbe4b2e7bfccf (diff)
parent80c3417987dd57711bf1832cc267599b55d1836e (diff)
downloadcurl-6a9977cde9914ddf75f6debd9810591e5b8f84ef.tar.gz
Merge "Snap for 11510257 from 5a7a71055c2c5ea8e7342422964c47f1e2d03970 to simpleperf-release" into simpleperf-releasesimpleperf-release
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md b/docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md
new file mode 100644
index 000000000..77615d886
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md
@@ -0,0 +1,61 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_ACCEPTTIMEOUT_MS
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_CONNECTTIMEOUT_MS (3)
+ - CURLOPT_DEBUGFUNCTION (3)
+ - CURLOPT_STDERR (3)
+---
+
+# NAME
+
+CURLOPT_ACCEPTTIMEOUT_MS - timeout waiting for FTP server to connect back
+
+# SYNOPSIS
+
+~~~c
+#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.
+
+# DEFAULT
+
+60000 milliseconds
+
+# PROTOCOLS
+
+FTP
+
+# EXAMPLE
+
+~~~c
+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 FTP server responses */
+ curl_easy_setopt(curl, CURLOPT_ACCEPTTIMEOUT_MS, 5000L);
+
+ curl_easy_perform(curl);
+ }
+}
+~~~
+
+# AVAILABILITY
+
+Added in 7.24.0
+
+# RETURN VALUE
+
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.