mirror of
https://github.com/curl/curl.git
synced 2025-01-06 13:44:52 +08:00
e3fe020089
Remove the PROTOCOLS section from the source files completely and instead generate them based on the header data in the curldown files. It also generates TLS backend information for options marked for TLS as protocol. Closes #13175
63 lines
1.1 KiB
Markdown
63 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_TIMEOUT_MS
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_CONNECTTIMEOUT (3)
|
|
- CURLOPT_LOW_SPEED_LIMIT (3)
|
|
- CURLOPT_TCP_KEEPALIVE (3)
|
|
- CURLOPT_TIMEOUT (3)
|
|
Protocol:
|
|
- All
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_TIMEOUT_MS - maximum time the transfer is allowed to complete
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long as parameter containing *timeout* - the maximum time in
|
|
milliseconds that you allow the libcurl transfer operation to take.
|
|
|
|
See CURLOPT_TIMEOUT(3) for details.
|
|
|
|
# DEFAULT
|
|
|
|
Default timeout is 0 (zero) which means it never times out during transfer.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* complete within 20000 milliseconds */
|
|
curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L);
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Always
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK
|