Artifactspublic-v0

curl

master
ply4 git calls232 ms288 KiB2 cachedprotocol v2
116 lines3.0 KiBRaw

NAME

CURLOPT_TRAILERFUNCTION - callback for sending trailing headers

SYNOPSIS

c
#include <curl.h>

int curl_trailer_callback(struct curl_slist ** list, void *userdata);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRAILERFUNCTION,
                          curl_trailer_callback *func);

DESCRIPTION

Pass a pointer to a callback function.

This callback function is called once right before sending the final CR LF in an HTTP chunked transfer to fill a list of trailing headers to be sent before finishing the HTTP transfer.

You can set the userdata argument with the CURLOPT_TRAILERDATA(3) option.

The trailing headers included in the linked list must not be CRLF-terminated, because libcurl adds the appropriate line termination characters after each header item.

If you use curl_slist_append(3) to add trailing headers to the curl_slist then libcurl duplicates the strings, and frees the curl_slist once the trailers have been sent.

If one of the trailing header fields is not formatted correctly it is ignored and an info message is emitted.

The return value can either be CURL_TRAILERFUNC_OK or CURL_TRAILERFUNC_ABORT which would respectively instruct libcurl to either continue with sending the trailers or to abort the request.

If you set this option to NULL, then the transfer proceeds as usual without any interruptions.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
extern size_t read_cb(char *ptr, size_t size,
                      size_t nmemb, void *userdata);

static int trailer_cb(struct curl_slist **tr, void *data)
{
  /* libcurl frees the list */
  *tr = curl_slist_append(*tr, "My-super-awesome-trailer: trailer-stuff");
  return CURL_TRAILERFUNC_OK;
}

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    struct curl_slist *headers;

    /* Set the URL of the request */
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    /* Now set it as a put */
    curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);

    /* Assuming we have a function that returns the data to be pushed
       Let that function be read_cb */
    curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_cb);

    headers = curl_slist_append(NULL, "Trailer: My-super-awesome-trailer");
    result = curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

    /* Set the trailers filling callback */
    curl_easy_setopt(curl, CURLOPT_TRAILERFUNCTION, trailer_cb);

    /* Perform the transfer */
    result = curl_easy_perform(curl);

    curl_easy_cleanup(curl);

    curl_slist_free_all(headers);
  }
}

%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_TRAILERFUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_TRAILERDATA (3)
9 - CURLOPT_WRITEFUNCTION (3)
10Protocol:
11 - HTTP
12Added-in: 7.64.0
13---
15# NAME
17CURLOPT_TRAILERFUNCTION - callback for sending trailing headers
19# SYNOPSIS
21~~~c
22#include <curl.h>
24int curl_trailer_callback(struct curl_slist ** list, void *userdata);
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRAILERFUNCTION,
27 curl_trailer_callback *func);
28~~~
30# DESCRIPTION
32Pass a pointer to a callback function.
34This callback function is called once right before sending the final CR LF in
35an HTTP chunked transfer to fill a list of trailing headers to be sent before
36finishing the HTTP transfer.
38You can set the userdata argument with the CURLOPT_TRAILERDATA(3)
39option.
41The trailing headers included in the linked list must not be CRLF-terminated,
42because libcurl adds the appropriate line termination characters after each
43header item.
45If you use curl_slist_append(3) to add trailing headers to the *curl_slist*
46then libcurl duplicates the strings, and frees the *curl_slist* once the
47trailers have been sent.
49If one of the trailing header fields is not formatted correctly it is ignored
50and an info message is emitted.
52The return value can either be **CURL_TRAILERFUNC_OK** or
53**CURL_TRAILERFUNC_ABORT** which would respectively instruct libcurl to
54either continue with sending the trailers or to abort the request.
56If you set this option to NULL, then the transfer proceeds as usual
57without any interruptions.
59# DEFAULT
61NULL
63# %PROTOCOLS%
65# EXAMPLE
66~~~c
67extern size_t read_cb(char *ptr, size_t size,
68 size_t nmemb, void *userdata);
70static int trailer_cb(struct curl_slist **tr, void *data)
72 /* libcurl frees the list */
73 *tr = curl_slist_append(*tr, "My-super-awesome-trailer: trailer-stuff");
74 return CURL_TRAILERFUNC_OK;
77int main(void)
79 CURL *curl = curl_easy_init();
80 if(curl) {
81 CURLcode result;
82 struct curl_slist *headers;
84 /* Set the URL of the request */
85 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
86 /* Now set it as a put */
87 curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
89 /* Assuming we have a function that returns the data to be pushed
90 Let that function be read_cb */
91 curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_cb);
93 headers = curl_slist_append(NULL, "Trailer: My-super-awesome-trailer");
94 result = curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
96 /* Set the trailers filling callback */
97 curl_easy_setopt(curl, CURLOPT_TRAILERFUNCTION, trailer_cb);
99 /* Perform the transfer */
100 result = curl_easy_perform(curl);
102 curl_easy_cleanup(curl);
104 curl_slist_free_all(headers);
105 }
107~~~
109# %AVAILABILITY%
111# RETURN VALUE
113curl_easy_setopt(3) returns a CURLcode indicating success or error.
115CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
116libcurl-errors(3).
Diagnostics4 git calls · 232 ms
CallStatusSizeTime0232 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 · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=226
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.4 KiB226 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1457
git.response.cache=MISS
git.response.duration_ms=226
git.fetch.wants=3d9e2d096a6b695ab1bd2eb4f7926a64a40a8923
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=1457
git.pkt.payload.max=1436
git.sideband.band1.bytes=1435
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
a5e355bedb6c994c
Request
666d1442…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format