Artifactspublic-v0

curl

master
ply4 git calls171 ms288 KiB2 cachedprotocol v2
85 lines2.0 KiBRaw

NAME

CURLOPT_UPKEEP_INTERVAL_MS - connection upkeep interval

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPKEEP_INTERVAL_MS,
                          long upkeep_interval_ms);

DESCRIPTION

Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic on existing connections in order to keep them alive; this can prevent connections from being closed due to overzealous firewalls, for example.

The user needs to explicitly call curl_easy_upkeep(3) in order to perform the upkeep work.

Currently the only protocol with a connection upkeep mechanism is HTTP/2: when the connection upkeep interval is exceeded and curl_easy_upkeep(3) is called, an HTTP/2 PING frame is sent on the connection.

DEFAULT

CURL_UPKEEP_INTERVAL_DEFAULT (currently defined as 60000L, which is 60 seconds)

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    /* Make a connection to an HTTP/2 server. */
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* Set the interval to 30000ms / 30s */
    curl_easy_setopt(curl, CURLOPT_UPKEEP_INTERVAL_MS, 30000L);

    result = curl_easy_perform(curl);

    /* Perform more work here. */

    /* While the connection is being held open, curl_easy_upkeep() can be
       called. If curl_easy_upkeep() is called and the time since the last
       upkeep exceeds the interval, then an HTTP/2 PING is sent. */
    curl_easy_upkeep(curl);

    /* Perform more work here. */

    /* always cleanup */
    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_UPKEEP_INTERVAL_MS
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_TCP_KEEPALIVE (3)
9Protocol:
10 - All
11Added-in: 7.62.0
12---
14# NAME
16CURLOPT_UPKEEP_INTERVAL_MS - connection upkeep interval
18# SYNOPSIS
20~~~c
21#include <curl/curl.h>
23CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPKEEP_INTERVAL_MS,
24 long upkeep_interval_ms);
25~~~
27# DESCRIPTION
29Some protocols have "connection upkeep" mechanisms. These mechanisms usually
30send some traffic on existing connections in order to keep them alive; this
31can prevent connections from being closed due to overzealous firewalls, for
32example.
34The user needs to explicitly call curl_easy_upkeep(3) in order to
35perform the upkeep work.
37Currently the only protocol with a connection upkeep mechanism is HTTP/2: when
38the connection upkeep interval is exceeded and curl_easy_upkeep(3)
39is called, an HTTP/2 PING frame is sent on the connection.
41# DEFAULT
43CURL_UPKEEP_INTERVAL_DEFAULT (currently defined as 60000L, which is 60 seconds)
45# %PROTOCOLS%
47# EXAMPLE
49~~~c
50int main(void)
52 CURL *curl = curl_easy_init();
53 if(curl) {
54 CURLcode result;
55 /* Make a connection to an HTTP/2 server. */
56 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
58 /* Set the interval to 30000ms / 30s */
59 curl_easy_setopt(curl, CURLOPT_UPKEEP_INTERVAL_MS, 30000L);
61 result = curl_easy_perform(curl);
63 /* Perform more work here. */
65 /* While the connection is being held open, curl_easy_upkeep() can be
66 called. If curl_easy_upkeep() is called and the time since the last
67 upkeep exceeds the interval, then an HTTP/2 PING is sent. */
68 curl_easy_upkeep(curl);
70 /* Perform more work here. */
72 /* always cleanup */
73 curl_easy_cleanup(curl);
74 }
76~~~
78# %AVAILABILITY%
80# RETURN VALUE
82curl_easy_setopt(3) returns a CURLcode indicating success or error.
84CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
85libcurl-errors(3).
Diagnostics4 git calls · 171 ms
CallStatusSizeTime0171 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 · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
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 · hit7 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=7
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.0 KiB161 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=161
git.response.bytes=1062
git.response.cache=MISS
git.response.duration_ms=161
git.fetch.wants=8b0e87cfb6a3db3a683a1dcc299b989a2c59fd18
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=1062
git.pkt.payload.max=1041
git.sideband.band1.bytes=1040
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
a5e313c97cc73e6e
Request
887f5991…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format