Artifactspublic-v0

curl

master
ply4 git calls179 ms288 KiB2 cachedprotocol v2
112 lines3.0 KiBRaw

NAME

CURLOPT_ERRORBUFFER - error buffer for error messages

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, char *buf);

DESCRIPTION

Pass a char pointer to a buffer that libcurl may use to store human readable error messages on failures or problems. This may be more helpful than the single return code from curl_easy_perform(3) and related functions. The buffer must be at least CURL_ERROR_SIZE bytes big.

You must keep the associated buffer available until libcurl no longer needs it. Failing to do so might cause odd behavior or even crashes. libcurl might need it until you call curl_easy_cleanup(3) or you set the same option again to use a different pointer.

libcurl initializes the contents of the error buffer to an empty string before performing a transfer.

Do not attempt to set the contents of the buffer yourself, including in any callbacks you write that may be called by libcurl. The library may overwrite the buffer after your callback returns.

Consider CURLOPT_VERBOSE(3) and CURLOPT_DEBUGFUNCTION(3) to better debug and trace why errors happen.

Using this option multiple times makes the last set pointer override the previous ones. Set it to NULL to disable its use again.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
#include <string.h> /* for strlen() */
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    char errbuf[CURL_ERROR_SIZE];

    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* provide a buffer to store errors in */
    curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errbuf);

    /* set the error buffer as empty before performing a request */
    errbuf[0] = 0;

    /* perform the request */
    result = curl_easy_perform(curl);

    /* if the request did not complete correctly, show the error
       information. if no detailed error information was written to errbuf
       show the more generic information from curl_easy_strerror instead. */
    if(result != CURLE_OK) {
      size_t len = strlen(errbuf);
      fprintf(stderr, "\nlibcurl: (%d) ", (int)result);
      if(len)
        fprintf(stderr, "%s%s", errbuf,
                ((errbuf[len - 1] != '\n') ? "\n" : ""));
      else
        fprintf(stderr, "%s\n", curl_easy_strerror(result));
    }
  }
}

HISTORY

Before curl 7.60.0, if an error code was returned but there was no error detail the buffer was untouched: not initialized.

%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_ERRORBUFFER
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_DEBUGFUNCTION (3)
9 - CURLOPT_VERBOSE (3)
10 - curl_easy_strerror (3)
11 - curl_multi_strerror (3)
12 - curl_share_strerror (3)
13 - curl_url_strerror (3)
14Protocol:
15 - All
16Added-in: 7.1
17---
19# NAME
21CURLOPT_ERRORBUFFER - error buffer for error messages
23# SYNOPSIS
25~~~c
26#include <curl/curl.h>
28CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, char *buf);
29~~~
31# DESCRIPTION
33Pass a char pointer to a buffer that libcurl may use to store human readable
34error messages on failures or problems. This may be more helpful than the
35single return code from curl_easy_perform(3) and related functions. The buffer
36must be at least **CURL_ERROR_SIZE** bytes big.
38You must keep the associated buffer available until libcurl no longer needs
39it. Failing to do so might cause odd behavior or even crashes. libcurl might
40need it until you call curl_easy_cleanup(3) or you set the same option again
41to use a different pointer.
43libcurl initializes the contents of the error buffer to an empty string before
44performing a transfer.
46Do not attempt to set the contents of the buffer yourself, including in any
47callbacks you write that may be called by libcurl. The library may overwrite
48the buffer after your callback returns.
50Consider CURLOPT_VERBOSE(3) and CURLOPT_DEBUGFUNCTION(3) to better debug and
51trace why errors happen.
53Using this option multiple times makes the last set pointer override the
54previous ones. Set it to NULL to disable its use again.
56# DEFAULT
58NULL
60# %PROTOCOLS%
62# EXAMPLE
64~~~c
65#include <string.h> /* for strlen() */
66int main(void)
68 CURL *curl = curl_easy_init();
69 if(curl) {
70 CURLcode result;
71 char errbuf[CURL_ERROR_SIZE];
73 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
75 /* provide a buffer to store errors in */
76 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errbuf);
78 /* set the error buffer as empty before performing a request */
79 errbuf[0] = 0;
81 /* perform the request */
82 result = curl_easy_perform(curl);
84 /* if the request did not complete correctly, show the error
85 information. if no detailed error information was written to errbuf
86 show the more generic information from curl_easy_strerror instead. */
87 if(result != CURLE_OK) {
88 size_t len = strlen(errbuf);
89 fprintf(stderr, "\nlibcurl: (%d) ", (int)result);
90 if(len)
91 fprintf(stderr, "%s%s", errbuf,
92 ((errbuf[len - 1] != '\n') ? "\n" : ""));
93 else
94 fprintf(stderr, "%s\n", curl_easy_strerror(result));
95 }
96 }
98~~~
100# HISTORY
102Before curl 7.60.0, if an error code was returned but there was no error
103detail the buffer was untouched: not initialized.
105# %AVAILABILITY%
107# RETURN VALUE
109curl_easy_setopt(3) returns a CURLcode indicating success or error.
111CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
112libcurl-errors(3).
Diagnostics4 git calls · 179 ms
CallStatusSizeTime0179 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 · 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 · hit3 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=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.5 KiB174 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=174
git.response.bytes=1548
git.response.cache=MISS
git.response.duration_ms=174
git.fetch.wants=ff5ee86c0044314b7ca0f8ff99c90541a87c8dab
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=1548
git.pkt.payload.max=1527
git.sideband.band1.bytes=1526
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
a5e36635acbb1de6
Request
36799c10…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format