Artifactspublic-v0

curl

master
ply4 git calls157 ms288 KiB2 cachedprotocol v2
93 lines2.5 KiBRaw

NAME

CURLOPT_TIMEOUT - maximum time the transfer is allowed to complete

SYNOPSIS

c
#include <curl/curl.h>

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

DESCRIPTION

Pass a long as parameter containing timeout - the maximum time in seconds that you allow the entire transfer operation to take. The whole thing, from start to end. Normally, name lookups can take a considerable time and limiting operations risk aborting perfectly normal operations.

CURLOPT_TIMEOUT_MS(3) is the same function but set in milliseconds.

If both CURLOPT_TIMEOUT(3) and CURLOPT_TIMEOUT_MS(3) are set, the value set last is used.

Since this option puts a hard limit on how long time a request is allowed to take, it has limited use in dynamic use cases with varying transfer times. That is especially apparent when using the multi interface, which may queue the transfer, and that time is included. You are advised to explore CURLOPT_LOW_SPEED_LIMIT(3), CURLOPT_LOW_SPEED_TIME(3) or using CURLOPT_PROGRESSFUNCTION(3) to implement your own timeout logic.

The connection timeout set with CURLOPT_CONNECTTIMEOUT(3) is included in this general all-covering timeout.

With CURLOPT_CONNECTTIMEOUT(3) set to 3 and CURLOPT_TIMEOUT(3) set to 5, the operation can never last longer than 5 seconds.

With CURLOPT_CONNECTTIMEOUT(3) set to 4 and CURLOPT_TIMEOUT(3) set to 2, the operation can never last longer than 2 seconds.

This option may cause libcurl to use the SIGALRM signal to timeout system calls on builds not using asynch DNS. In Unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL(3) is set.

DEFAULT

0 (zero) which means it never times out during transfer.

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* complete within 20 seconds */
    curl_easy_setopt(curl, CURLOPT_TIMEOUT, 20L);

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

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

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_TIMEOUT
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_CONNECTTIMEOUT (3)
9 - CURLOPT_LOW_SPEED_LIMIT (3)
10 - CURLOPT_TCP_KEEPALIVE (3)
11 - CURLOPT_TIMEOUT_MS (3)
12Protocol:
13 - All
14Added-in: 7.1
15---
17# NAME
19CURLOPT_TIMEOUT - maximum time the transfer is allowed to complete
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT, long timeout);
27~~~
29# DESCRIPTION
31Pass a long as parameter containing *timeout* - the maximum time in
32seconds that you allow the entire transfer operation to take. The whole thing,
33from start to end. Normally, name lookups can take a considerable time and
34limiting operations risk aborting perfectly normal operations.
36CURLOPT_TIMEOUT_MS(3) is the same function but set in milliseconds.
38If both CURLOPT_TIMEOUT(3) and CURLOPT_TIMEOUT_MS(3) are set, the
39value set last is used.
41Since this option puts a hard limit on how long time a request is allowed to
42take, it has limited use in dynamic use cases with varying transfer
43times. That is especially apparent when using the multi interface, which may
44queue the transfer, and that time is included. You are advised to explore
45CURLOPT_LOW_SPEED_LIMIT(3), CURLOPT_LOW_SPEED_TIME(3) or using
46CURLOPT_PROGRESSFUNCTION(3) to implement your own timeout logic.
48The connection timeout set with CURLOPT_CONNECTTIMEOUT(3) is included in
49this general all-covering timeout.
51With CURLOPT_CONNECTTIMEOUT(3) set to 3 and CURLOPT_TIMEOUT(3) set
52to 5, the operation can never last longer than 5 seconds.
54With CURLOPT_CONNECTTIMEOUT(3) set to 4 and CURLOPT_TIMEOUT(3) set
55to 2, the operation can never last longer than 2 seconds.
57This option may cause libcurl to use the SIGALRM signal to timeout system
58calls on builds not using asynch DNS. In Unix-like systems, this might cause
59signals to be used unless CURLOPT_NOSIGNAL(3) is set.
61# DEFAULT
630 (zero) which means it never times out during transfer.
65# %PROTOCOLS%
67# EXAMPLE
69~~~c
70int main(void)
72 CURL *curl = curl_easy_init();
73 if(curl) {
74 CURLcode result;
75 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
77 /* complete within 20 seconds */
78 curl_easy_setopt(curl, CURLOPT_TIMEOUT, 20L);
80 result = curl_easy_perform(curl);
81 curl_easy_cleanup(curl);
82 }
84~~~
86# %AVAILABILITY%
88# RETURN VALUE
90curl_easy_setopt(3) returns a CURLcode indicating success or error.
92CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
93libcurl-errors(3).
Diagnostics4 git calls · 157 ms
CallStatusSizeTime0157 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.3 KiB152 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=152
git.response.bytes=1331
git.response.cache=MISS
git.response.duration_ms=152
git.fetch.wants=4058dd4cb70d8c9f21c3747be9278e7904128f79
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1331
git.pkt.payload.max=1310
git.sideband.band1.bytes=1309
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e31ac42d943e6e
Request
72aee0fb…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format