Artifactspublic-v0

curl

master
ply4 git calls201 ms289 KiB2 cachedprotocol v2
155 lines3.6 KiBRaw

NAME

CURLOPT_CHUNK_BGN_FUNCTION - callback before a transfer with FTP wildcard match

SYNOPSIS

c
#include <curl/curl.h>

struct curl_fileinfo {
  char *filename;
  curlfiletype filetype;
  time_t time;   /* always zero */
  unsigned int perm;
  int uid;
  int gid;
  curl_off_t size;
  long int hardlinks;

  struct {
    /* If some of these fields is not NULL, it is a pointer to b_data. */
    char *time;
    char *perm;
    char *user;
    char *group;
    char *target; /* pointer to the target filename of a symlink, only
                     available for CURLFILETYPE_SYMLINK */
  } strings;

  unsigned int flags;

  /* used internally */
  char *b_data;
  size_t b_size;
  size_t b_used;
};

long chunk_bgn_callback(const void *transfer_info, void *ptr,
                        int remains);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION,
                          chunk_bgn_callback);

DESCRIPTION

Pass a pointer to your callback function, which should match the prototype shown above.

This callback function gets called by libcurl before a part of the stream is going to be transferred (if the transfer supports chunks).

The transfer_info pointer points to a curl_fileinfo struct with details about the file that is about to get transferred.

This callback makes sense only when using the CURLOPT_WILDCARDMATCH(3) option for now.

The target of transfer_info parameter is a "feature depended" structure. For the FTP wildcard download, the target is curl_fileinfo structure (see curl/curl.h). The parameter ptr is a pointer given by CURLOPT_CHUNK_DATA(3). The parameter remains contains number of chunks remaining per the transfer. If the feature is not available, the parameter has zero value.

Return CURL_CHUNK_BGN_FUNC_OK if everything is fine, CURL_CHUNK_BGN_FUNC_SKIP if you want to skip the concrete chunk or CURL_CHUNK_BGN_FUNC_FAIL to tell libcurl to stop if some error occurred.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
#include <stdio.h>

struct callback_data {
  FILE *output;
};

static long file_is_coming(struct curl_fileinfo *finfo,
                           void *ptr,
                           int remains)
{
  struct callback_data *data = ptr;
  printf("%3d %40s %10luB ", remains, finfo->filename,
         (unsigned long)finfo->size);

  switch(finfo->filetype) {
  case CURLFILETYPE_DIRECTORY:
    printf(" DIR\n");
    break;
  case CURLFILETYPE_FILE:
    printf("FILE ");
    break;
  default:
    printf("OTHER\n");
    break;
  }

  if(finfo->filetype == CURLFILETYPE_FILE) {
    /* do not transfer files >= 50B */
    if(finfo->size > 50) {
      printf("SKIPPED\n");
      return CURL_CHUNK_BGN_FUNC_SKIP;
    }

    data->output = fopen(finfo->filename, "wb");
    if(!data->output) {
      return CURL_CHUNK_BGN_FUNC_FAIL;
    }
  }

  return CURL_CHUNK_BGN_FUNC_OK;
}

int main(void)
{
  /* data for callback */
  struct callback_data callback_info;

  CURL *curl = curl_easy_init();

  /* callback is called before download of concrete file started */
  curl_easy_setopt(curl, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
  curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info);
}

%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_CHUNK_BGN_FUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_CHUNK_END_FUNCTION (3)
9 - CURLOPT_WILDCARDMATCH (3)
10Protocol:
11 - FTP
12Added-in: 7.21.0
13---
15# NAME
17CURLOPT_CHUNK_BGN_FUNCTION - callback before a transfer with FTP wildcard match
19# SYNOPSIS
21~~~c
22#include <curl/curl.h>
24struct curl_fileinfo {
25 char *filename;
26 curlfiletype filetype;
27 time_t time; /* always zero */
28 unsigned int perm;
29 int uid;
30 int gid;
31 curl_off_t size;
32 long int hardlinks;
34 struct {
35 /* If some of these fields is not NULL, it is a pointer to b_data. */
36 char *time;
37 char *perm;
38 char *user;
39 char *group;
40 char *target; /* pointer to the target filename of a symlink, only
41 available for CURLFILETYPE_SYMLINK */
42 } strings;
44 unsigned int flags;
46 /* used internally */
47 char *b_data;
48 size_t b_size;
49 size_t b_used;
50};
52long chunk_bgn_callback(const void *transfer_info, void *ptr,
53 int remains);
55CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION,
56 chunk_bgn_callback);
57~~~
59# DESCRIPTION
61Pass a pointer to your callback function, which should match the prototype
62shown above.
64This callback function gets called by libcurl before a part of the stream is
65going to be transferred (if the transfer supports chunks).
67The *transfer_info* pointer points to a **curl_fileinfo** struct with
68details about the file that is about to get transferred.
70This callback makes sense only when using the CURLOPT_WILDCARDMATCH(3)
71option for now.
73The target of transfer_info parameter is a "feature depended" structure. For
74the FTP wildcard download, the target is **curl_fileinfo** structure (see
75*curl/curl.h*). The parameter *ptr* is a pointer given by
76CURLOPT_CHUNK_DATA(3). The parameter remains contains number of chunks
77remaining per the transfer. If the feature is not available, the parameter has
78zero value.
80Return *CURL_CHUNK_BGN_FUNC_OK* if everything is fine,
81*CURL_CHUNK_BGN_FUNC_SKIP* if you want to skip the concrete chunk or
82*CURL_CHUNK_BGN_FUNC_FAIL* to tell libcurl to stop if some error occurred.
84# DEFAULT
86NULL
88# %PROTOCOLS%
90# EXAMPLE
92~~~c
93#include <stdio.h>
95struct callback_data {
96 FILE *output;
97};
99static long file_is_coming(struct curl_fileinfo *finfo,
100 void *ptr,
101 int remains)
103 struct callback_data *data = ptr;
104 printf("%3d %40s %10luB ", remains, finfo->filename,
105 (unsigned long)finfo->size);
107 switch(finfo->filetype) {
108 case CURLFILETYPE_DIRECTORY:
109 printf(" DIR\n");
110 break;
111 case CURLFILETYPE_FILE:
112 printf("FILE ");
113 break;
114 default:
115 printf("OTHER\n");
116 break;
117 }
119 if(finfo->filetype == CURLFILETYPE_FILE) {
120 /* do not transfer files >= 50B */
121 if(finfo->size > 50) {
122 printf("SKIPPED\n");
123 return CURL_CHUNK_BGN_FUNC_SKIP;
124 }
126 data->output = fopen(finfo->filename, "wb");
127 if(!data->output) {
128 return CURL_CHUNK_BGN_FUNC_FAIL;
129 }
130 }
132 return CURL_CHUNK_BGN_FUNC_OK;
135int main(void)
137 /* data for callback */
138 struct callback_data callback_info;
140 CURL *curl = curl_easy_init();
142 /* callback is called before download of concrete file started */
143 curl_easy_setopt(curl, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
144 curl_easy_setopt(curl, CURLOPT_CHUNK_DATA, &callback_info);
146~~~
148# %AVAILABILITY%
150# RETURN VALUE
152curl_easy_setopt(3) returns a CURLcode indicating success or error.
154CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
155libcurl-errors(3).
Diagnostics4 git calls · 201 ms
CallStatusSizeTime0201 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 · 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 · hit6 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=192
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=6
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.7 KiB192 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1690
git.response.cache=MISS
git.response.duration_ms=192
git.fetch.wants=b632e1a3a75994abfdfe292afe1ce9cda97823e6
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=1690
git.pkt.payload.max=1669
git.sideband.band1.bytes=1668
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
a5e3859c4beaa691
Request
f486d28e…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format