Artifactspublic-v0

curl

master
ply4 git calls140 ms289 KiB2 cachedprotocol v2
129 lines3.9 KiBRaw

NAME

CURLOPT_ACCEPT_ENCODING - automatic decompression of HTTP downloads

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);

DESCRIPTION

Pass a char pointer argument specifying what encoding you would like.

Sets the contents of the Accept-Encoding: header sent in an HTTP request, and enables decoding of a response when a Content-Encoding: header is received.

libcurl potentially supports several different compressed encodings depending on what support that has been built-in.

To aid applications not having to bother about what specific algorithms this particular libcurl build supports, libcurl allows a zero-length string to be set ("") to ask for an Accept-Encoding: header to be used that contains all built-in supported encodings.

Alternatively, you can specify exactly the encoding or list of encodings you want in the response. The following encodings are supported: identity, meaning non-compressed, deflate which requests the server to compress its response using the zlib algorithm, gzip which requests the gzip algorithm, (since curl 7.57.0) br which is brotli and (since curl 7.72.0) zstd which is zstd. Provide them in the string as a comma-separated list of accepted encodings, like: "br, gzip, deflate".

Set CURLOPT_ACCEPT_ENCODING(3) to NULL to explicitly disable it, which makes libcurl not send an Accept-Encoding: header and not decompress received contents automatically.

You can also opt to include the Accept-Encoding: header in your request with CURLOPT_HTTPHEADER(3) but then there is no automatic decompressing when receiving data.

Setting this option is a request, not an order; the server may or may not do it. It must be set (to any non-NULL value) or else any encoding done by the server is ignored.

Servers might respond with Content-Encoding: even without getting a Accept-Encoding: in the request. Servers might respond with a different content encoding than what was asked for in the request.

The Content-Length: header field servers send for a compressed response is supposed to indicate the length of the compressed content so when auto decoding is enabled it may not match the sum of bytes reported by the write callbacks (although, sending the length of the non-compressed content is a common server mistake).

The application does not have to keep the string around after setting this option.

Using this option multiple times makes the last set string override the previous ones.

WARNING: when decompressing data, even tiny transfers might be expanded and generate a huge amount of bytes. You might want to limit using this option to only known and trusted sites using secure protocols, perhaps in combination with CURLOPT_MAXFILESIZE_LARGE(3).

HISTORY

This option was called CURLOPT_ENCODING before 7.21.6

NOTES

The specific libcurl you are using must have been built with zlib to be able to decompress gzip and deflate responses, with the brotli library to decompress brotli responses and with the zstd library to decompress zstd responses.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

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

    /* enable all supported built-in compressions */
    curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");

    /* Perform the request */
    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_ACCEPT_ENCODING
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_HTTPHEADER (3)
9 - CURLOPT_HTTP_CONTENT_DECODING (3)
10 - CURLOPT_TRANSFER_ENCODING (3)
11Protocol:
12 - HTTP
13Added-in: 7.21.6
14---
16# NAME
18CURLOPT_ACCEPT_ENCODING - automatic decompression of HTTP downloads
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);
26~~~
28# DESCRIPTION
30Pass a char pointer argument specifying what encoding you would like.
32Sets the contents of the `Accept-Encoding:` header sent in an HTTP request,
33and enables decoding of a response when a `Content-Encoding:` header is
34received.
36libcurl potentially supports several different compressed encodings depending
37on what support that has been built-in.
39To aid applications not having to bother about what specific algorithms this
40particular libcurl build supports, libcurl allows a zero-length string to be
41set ("") to ask for an `Accept-Encoding:` header to be used that contains all
42built-in supported encodings.
44Alternatively, you can specify exactly the encoding or list of encodings you
45want in the response. The following encodings are supported: *identity*,
46meaning non-compressed, *deflate* which requests the server to compress its
47response using the zlib algorithm, *gzip* which requests the gzip algorithm,
48(since curl 7.57.0) *br* which is brotli and (since curl 7.72.0) *zstd* which
49is zstd. Provide them in the string as a comma-separated list of accepted
50encodings, like: **"br, gzip, deflate"**.
52Set CURLOPT_ACCEPT_ENCODING(3) to NULL to explicitly disable it, which makes
53libcurl not send an `Accept-Encoding:` header and not decompress received
54contents automatically.
56You can also opt to include the `Accept-Encoding:` header in your request with
57CURLOPT_HTTPHEADER(3) but then there is no automatic decompressing when
58receiving data.
60Setting this option is a request, not an order; the server may or may not do
61it. It must be set (to any non-NULL value) or else any encoding done by the
62server is ignored.
64Servers might respond with `Content-Encoding:` even without getting a
65`Accept-Encoding:` in the request. Servers might respond with a different
66content encoding than what was asked for in the request.
68The `Content-Length:` header field servers send for a compressed response is
69supposed to indicate the length of the compressed content so when auto
70decoding is enabled it may not match the sum of bytes reported by the write
71callbacks (although, sending the length of the non-compressed content is a
72common server mistake).
74The application does not have to keep the string around after setting this
75option.
77Using this option multiple times makes the last set string override the
78previous ones.
80**WARNING:** when decompressing data, even tiny transfers might be expanded
81and generate a huge amount of bytes. You might want to limit using this option
82to only known and trusted sites using secure protocols, perhaps in combination
83with CURLOPT_MAXFILESIZE_LARGE(3).
85# HISTORY
87This option was called CURLOPT_ENCODING before 7.21.6
89# NOTES
91The specific libcurl you are using must have been built with zlib to be able to
92decompress gzip and deflate responses, with the brotli library to
93decompress brotli responses and with the zstd library to decompress zstd
94responses.
96# DEFAULT
98NULL
100# %PROTOCOLS%
102# EXAMPLE
104~~~c
105int main(void)
107 CURL *curl = curl_easy_init();
108 if(curl) {
109 CURLcode result;
110 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
112 /* enable all supported built-in compressions */
113 curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");
115 /* Perform the request */
116 result = curl_easy_perform(curl);
117 curl_easy_cleanup(curl);
118 }
120~~~
122# %AVAILABILITY%
124# RETURN VALUE
126curl_easy_setopt(3) returns a CURLcode indicating success or error.
128CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
129libcurl-errors(3).
Diagnostics4 git calls · 140 ms
CallStatusSizeTime0140 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=1
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 · hit1 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=132
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=1
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.9 KiB136 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1955
git.response.cache=MISS
git.response.duration_ms=136
git.fetch.wants=61f28e6e610f1e35d2b59535163ff4df615907fa
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=1955
git.pkt.payload.max=1934
git.sideband.band1.bytes=1933
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
a5e3529c9819224d
Request
e40bb206…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format