Artifactspublic-v0

curl

master
ply4 git calls117 ms288 KiB2 cachedprotocol v2
130 lines3.4 KiBRaw

NAME

CURLOPT_PREREQFUNCTION - user callback called when a connection has been established, but before a request has been made.

SYNOPSIS

c
#include <curl/curl.h>

/* These are the return codes for the pre-request callback. */
#define CURL_PREREQFUNC_OK 0
#define CURL_PREREQFUNC_ABORT 1 /* fail the entire transfer */

int prereq_callback(void *clientp,
                    char *conn_primary_ip,
                    char *conn_local_ip,
                    int conn_primary_port,
                    int conn_local_port);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREREQFUNCTION, prereq_callback);

DESCRIPTION

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

This function gets called by libcurl after a connection has been established or a connection has been reused (including any SSL handshaking), but before any request is actually made on the connection. For example, for HTTP, this callback is called once a connection has been established to the server, but before a GET/HEAD/POST/etc request has been sent.

This function may be called multiple times if redirections are enabled and are being followed (see CURLOPT_FOLLOWLOCATION(3)).

The callback function must return CURL_PREREQFUNC_OK on success, or CURL_PREREQFUNC_ABORT to cause the transfer to fail with result CURLE_ABORTED_BY_CALLBACK.

This function is passed the following arguments:

conn_primary_ip

A pointer to a null-terminated C string containing the primary IP of the remote server established with this connection. For FTP, this is the IP for the control connection. IPv6 addresses are represented without surrounding brackets.

conn_local_ip

A pointer to a null-terminated C string containing the originating IP for this connection. IPv6 addresses are represented without surrounding brackets.

conn_primary_port

The primary port number on the remote server established with this connection. For FTP, this is the port for the control connection. This can be a TCP or a UDP port number depending on the protocol.

conn_local_port

The originating port number for this connection. This can be a TCP or a UDP port number depending on the protocol.

clientp

The pointer you set with CURLOPT_PREREQDATA(3).

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
struct priv {
  void *custom;
};

static int prereq_callback(void *clientp,
                           char *conn_primary_ip,
                           char *conn_local_ip,
                           int conn_primary_port,
                           int conn_local_port)
{
  printf("Connection made to %s:%d\n", conn_primary_ip, conn_primary_port);
  return CURL_PREREQFUNC_OK;
}

int main(void)
{
  struct priv prereq_data;
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_PREREQFUNCTION, prereq_callback);
    curl_easy_setopt(curl, CURLOPT_PREREQDATA, &prereq_data);
    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_PREREQFUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLINFO_PRIMARY_IP (3)
9 - CURLINFO_PRIMARY_PORT (3)
10 - CURLOPT_PREREQDATA (3)
11Protocol:
12 - All
13Added-in: 7.80.0
14---
16# NAME
18CURLOPT_PREREQFUNCTION - user callback called when a connection has been
19established, but before a request has been made.
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26/* These are the return codes for the pre-request callback. */
27#define CURL_PREREQFUNC_OK 0
28#define CURL_PREREQFUNC_ABORT 1 /* fail the entire transfer */
30int prereq_callback(void *clientp,
31 char *conn_primary_ip,
32 char *conn_local_ip,
33 int conn_primary_port,
34 int conn_local_port);
36CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREREQFUNCTION, prereq_callback);
37~~~
39# DESCRIPTION
41Pass a pointer to your callback function, which should match the prototype
42shown above.
44This function gets called by libcurl after a connection has been established
45or a connection has been reused (including any SSL handshaking), but before any
46request is actually made on the connection. For example, for HTTP, this
47callback is called once a connection has been established to the server, but
48before a GET/HEAD/POST/etc request has been sent.
50This function may be called multiple times if redirections are enabled and are
51being followed (see CURLOPT_FOLLOWLOCATION(3)).
53The callback function must return *CURL_PREREQFUNC_OK* on success, or
54*CURL_PREREQFUNC_ABORT* to cause the transfer to fail with result
55*CURLE_ABORTED_BY_CALLBACK*.
57This function is passed the following arguments:
59## `conn_primary_ip`
61A pointer to a null-terminated C string containing the primary IP of the
62remote server established with this connection. For FTP, this is the IP for
63the control connection. IPv6 addresses are represented without surrounding
64brackets.
66## `conn_local_ip`
68A pointer to a null-terminated C string containing the originating IP for this
69connection. IPv6 addresses are represented without surrounding brackets.
71## `conn_primary_port`
73The primary port number on the remote server established with this connection.
74For FTP, this is the port for the control connection. This can be a TCP or a
75UDP port number depending on the protocol.
77## `conn_local_port`
79The originating port number for this connection. This can be a TCP or a UDP
80port number depending on the protocol.
82## `clientp`
84The pointer you set with CURLOPT_PREREQDATA(3).
86# DEFAULT
88NULL
90# %PROTOCOLS%
92# EXAMPLE
94~~~c
95struct priv {
96 void *custom;
97};
99static int prereq_callback(void *clientp,
100 char *conn_primary_ip,
101 char *conn_local_ip,
102 int conn_primary_port,
103 int conn_local_port)
105 printf("Connection made to %s:%d\n", conn_primary_ip, conn_primary_port);
106 return CURL_PREREQFUNC_OK;
109int main(void)
111 struct priv prereq_data;
112 CURL *curl = curl_easy_init();
113 if(curl) {
114 CURLcode result;
115 curl_easy_setopt(curl, CURLOPT_PREREQFUNCTION, prereq_callback);
116 curl_easy_setopt(curl, CURLOPT_PREREQDATA, &prereq_data);
117 result = curl_easy_perform(curl);
118 curl_easy_cleanup(curl);
119 }
121~~~
123# %AVAILABILITY%
125# RETURN VALUE
127curl_easy_setopt(3) returns a CURLcode indicating success or error.
129CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
130libcurl-errors(3).
Diagnostics4 git calls · 117 ms
CallStatusSizeTime0117 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 · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=112
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
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 KiB112 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1453
git.response.cache=MISS
git.response.duration_ms=112
git.fetch.wants=f6b474f7eb31308e11ee1e9a833276534b11156b
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=1453
git.pkt.payload.max=1432
git.sideband.band1.bytes=1431
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
a5e32f8058d68821
Request
fdb01de5…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format