Artifactspublic-v0

curl

master
ply4 git calls766 ms288 KiB2 cachedprotocol v2
84 lines1.8 KiBRaw

NAME

CURLOPT_HEADER - pass headers to the data stream

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);

DESCRIPTION

Pass the long value onoff set to 1 to ask libcurl to include the headers in the write callback (CURLOPT_WRITEFUNCTION(3)). This option is relevant for protocols that actually have headers or other meta-data (like HTTP and FTP).

When asking to get the headers passed to the same callback as the body, it is not possible to accurately separate them again without detailed knowledge about the protocol in use.

Further: the CURLOPT_WRITEFUNCTION(3) callback is limited to only ever get a maximum of CURL_MAX_WRITE_SIZE bytes passed to it (16KB), while a header can be longer and the CURLOPT_HEADERFUNCTION(3) supports getting called with headers up to CURL_MAX_HTTP_HEADER bytes big (100KB).

It is often better to use CURLOPT_HEADERFUNCTION(3) to get the header data separately.

While named confusingly similar, CURLOPT_HTTPHEADER(3) is used to set custom HTTP headers.

DEFAULT

0

%PROTOCOLS%

EXAMPLE

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

    curl_easy_setopt(curl, CURLOPT_HEADER, 1L);

    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_HEADER
5Section: 3
6Source: libcurl
7Protocol:
8 - HTTP
9 - FTP
10 - IMAP
11 - POP3
12 - SMTP
13See-also:
14 - CURLOPT_HEADERFUNCTION (3)
15 - CURLOPT_HTTPHEADER (3)
16Added-in: 7.1
17---
19# NAME
21CURLOPT_HEADER - pass headers to the data stream
23# SYNOPSIS
25~~~c
26#include <curl/curl.h>
28CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);
29~~~
31# DESCRIPTION
33Pass the long value *onoff* set to 1 to ask libcurl to include the headers
34in the write callback (CURLOPT_WRITEFUNCTION(3)). This option is
35relevant for protocols that actually have headers or other meta-data (like
36HTTP and FTP).
38When asking to get the headers passed to the same callback as the body, it is
39not possible to accurately separate them again without detailed knowledge
40about the protocol in use.
42Further: the CURLOPT_WRITEFUNCTION(3) callback is limited to only ever
43get a maximum of *CURL_MAX_WRITE_SIZE* bytes passed to it (16KB), while a
44header can be longer and the CURLOPT_HEADERFUNCTION(3) supports getting
45called with headers up to *CURL_MAX_HTTP_HEADER* bytes big (100KB).
47It is often better to use CURLOPT_HEADERFUNCTION(3) to get the header
48data separately.
50While named confusingly similar, CURLOPT_HTTPHEADER(3) is used to set
51custom HTTP headers.
53# DEFAULT
57# %PROTOCOLS%
59# EXAMPLE
61~~~c
62int main(void)
64 CURL *curl = curl_easy_init();
65 if(curl) {
66 CURLcode result;
67 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
69 curl_easy_setopt(curl, CURLOPT_HEADER, 1L);
71 result = curl_easy_perform(curl);
72 curl_easy_cleanup(curl);
73 }
75~~~
77# %AVAILABILITY%
79# RETURN VALUE
81curl_easy_setopt(3) returns a CURLcode indicating success or error.
83CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
84libcurl-errors(3).
Diagnostics4 git calls · 766 ms
CallStatusSizeTime0766 ms
discover200152 B4 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 · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=759
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.0 KiB759 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1056
git.response.cache=MISS
git.response.duration_ms=759
git.fetch.wants=ea513f519652c13d185def2be717ebe5cdea0dc4
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=1056
git.pkt.payload.max=1035
git.sideband.band1.bytes=1034
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
a5e37071fd6222ce
Request
61e6d89b…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format