Artifactspublic-v0

curl

master
ply4 git calls28 ms288 KiB3 cachedprotocol v2
90 lines2.3 KiBRaw

NAME

curl_easy_upkeep - keep existing connections alive

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_upkeep(CURL *handle);

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.

For HTTP/2 we have an upkeep mechanism: when the connection upkeep interval is exceeded and curl_easy_upkeep(3) is called, an HTTP/2 PING frame is sent on the connection.

For MQTT the upkeep interval defines when to send ping requests to prevent the server from disconnecting.

This function must be explicitly called in order to perform the upkeep work. The connection upkeep interval is set with CURLOPT_UPKEEP_INTERVAL_MS(3).

If you call this function on an easy handle that uses a shared connection cache then upkeep is performed on the connections in that cache, even if those connections were never used by the easy handle. (Added in 8.10.0)

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    /* 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);

    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

This function returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3). If CURLOPT_ERRORBUFFER(3) was set with curl_easy_setopt(3) there can be an error message stored in the error buffer when non-zero is returned.

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: curl_easy_upkeep
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_TCP_KEEPALIVE (3)
9 - CURLOPT_TCP_KEEPIDLE (3)
10Protocol:
11 - All
12Added-in: 7.62.0
13---
15# NAME
17curl_easy_upkeep - keep existing connections alive
19# SYNOPSIS
21~~~c
22#include <curl/curl.h>
24CURLcode curl_easy_upkeep(CURL *handle);
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.
34For HTTP/2 we have an upkeep mechanism: when
35the connection upkeep interval is exceeded and curl_easy_upkeep(3)
36is called, an HTTP/2 PING frame is sent on the connection.
38For MQTT the upkeep interval defines when to send ping requests to prevent the
39server from disconnecting.
41This function must be explicitly called in order to perform the upkeep work.
42The connection upkeep interval is set with
43CURLOPT_UPKEEP_INTERVAL_MS(3).
45If you call this function on an easy handle that uses a shared connection cache
46then upkeep is performed on the connections in that cache, even if those
47connections were never used by the easy handle. (Added in 8.10.0)
49# %PROTOCOLS%
51# EXAMPLE
53~~~c
54int main(void)
56 CURL *curl = curl_easy_init();
57 if(curl) {
58 /* Make a connection to an HTTP/2 server. */
59 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
61 /* Set the interval to 30000ms / 30s */
62 curl_easy_setopt(curl, CURLOPT_UPKEEP_INTERVAL_MS, 30000L);
64 curl_easy_perform(curl);
66 /* Perform more work here. */
68 /* While the connection is being held open, curl_easy_upkeep() can be
69 called. If curl_easy_upkeep() is called and the time since the last
70 upkeep exceeds the interval, then an HTTP/2 PING is sent. */
71 curl_easy_upkeep(curl);
73 /* Perform more work here. */
75 /* always cleanup */
76 curl_easy_cleanup(curl);
77 }
79~~~
81# %AVAILABILITY%
83# RETURN VALUE
85This function returns a CURLcode indicating success or error.
87CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
88libcurl-errors(3). If CURLOPT_ERRORBUFFER(3) was set with curl_easy_setopt(3)
89there can be an error message stored in the error buffer when non-zero is
90returned.
Diagnostics4 git calls · 28 ms
CallStatusSizeTime028 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
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 · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=23
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
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.2 KiB · hit23 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1209
git.response.cache=HIT
git.response.duration_ms=23
git.fetch.wants=1aa448bee344893b626ba99fadc885c26ac6ee08
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=1209
git.pkt.payload.max=1188
git.sideband.band1.bytes=1187
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
a5e32ad00f725094
Request
0ddea254…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format