Artifactspublic-v0

curl

master
ply4 git calls248 ms289 KiB2 cachedprotocol v2
137 lines4.1 KiBRaw

NAME

CURLOPT_SOCKOPTFUNCTION - callback for setting socket options

SYNOPSIS

c
#include <curl/curl.h>

typedef enum {
  CURLSOCKTYPE_IPCXN,  /* socket created for a specific IP connection */
  CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */
  CURLSOCKTYPE_LAST    /* never use */
} curlsocktype;

#define CURL_SOCKOPT_OK 0
#define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return
                                CURLE_ABORTED_BY_CALLBACK */
#define CURL_SOCKOPT_ALREADY_CONNECTED 2

int sockopt_callback(void *clientp,
                     curl_socket_t curlfd,
                     curlsocktype purpose);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);

DESCRIPTION

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

When set, this callback function gets called by libcurl when the socket has been created, but before the connect call to allow applications to change specific socket options. The callback's purpose argument identifies the exact purpose for this particular socket:

CURLSOCKTYPE_IPCXN for actively created connections or CURLSOCKTYPE_ACCEPT for FTP when the connection was setup with PORT/EPSV (in earlier versions these sockets were not passed to this callback).

Future versions of libcurl may support more purposes. libcurl passes the newly created socket descriptor to the callback in the curlfd parameter so additional setsockopt() calls can be done at the user's discretion.

The clientp pointer contains whatever user-defined value set using the CURLOPT_SOCKOPTDATA(3) function.

Return CURL_SOCKOPT_OK from the callback on success. Return CURL_SOCKOPT_ERROR from the callback function to signal an unrecoverable error to the library and it closes the socket and returns CURLE_COULDNT_CONNECT for CURLSOCKTYPE_IPCXN and CURLE_ABORTED_BY_CALLBACK for CURLSOCKTYPE_ACCEPT.

The callback function may return CURL_SOCKOPT_ALREADY_CONNECTED for CURLSOCKTYPE_IPCXN, to tell libcurl that the socket is already connected and then libcurl does no attempt to connect. This allows an application to pass in an already connected socket with CURLOPT_OPENSOCKETFUNCTION(3) and then have this function make libcurl not attempt to connect (again).

The CURL_SOCKOPT_ALREADY_CONNECTED feature does not work for HTTP/3 (QUIC) connections.

DEFAULT

NULL

%PROTOCOLS%

EXAMPLE

c
/* make libcurl use the already established socket 'sockfd' */

static curl_socket_t opensocket(void *clientp,
                                curlsocktype purpose,
                                struct curl_sockaddr *address)
{
  curl_socket_t sockfd;
  sockfd = *(curl_socket_t *)clientp;
  /* the actual externally set socket is passed in via the OPENSOCKETDATA
     option */
  return sockfd;
}

static int sockopt_callback(void *clientp, curl_socket_t curlfd,
                            curlsocktype purpose)
{
  return CURL_SOCKOPT_ALREADY_CONNECTED;
}

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    int sockfd; /* our custom file descriptor */
    /* libcurl thinks that you connect to the host
     * and port that you specify in the URL option. */
    curl_easy_setopt(curl, CURLOPT_URL, "http://99.99.99.99:9999");
    /* call this function to get a socket */
    curl_easy_setopt(curl, CURLOPT_OPENSOCKETFUNCTION, opensocket);
    curl_easy_setopt(curl, CURLOPT_OPENSOCKETDATA, &sockfd);

    /* call this function to set options for the socket */
    curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);

    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_SOCKOPTFUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_OPENSOCKETFUNCTION (3)
9 - CURLOPT_SEEKFUNCTION (3)
10 - CURLOPT_SOCKOPTDATA (3)
11Protocol:
12 - All
13Added-in: 7.16.0
14---
16# NAME
18CURLOPT_SOCKOPTFUNCTION - callback for setting socket options
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25typedef enum {
26 CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */
27 CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */
28 CURLSOCKTYPE_LAST /* never use */
29} curlsocktype;
31#define CURL_SOCKOPT_OK 0
32#define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return
33 CURLE_ABORTED_BY_CALLBACK */
34#define CURL_SOCKOPT_ALREADY_CONNECTED 2
36int sockopt_callback(void *clientp,
37 curl_socket_t curlfd,
38 curlsocktype purpose);
40CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
41~~~
43# DESCRIPTION
45Pass a pointer to your callback function, which should match the prototype
46shown above.
48When set, this callback function gets called by libcurl when the socket has
49been created, but before the connect call to allow applications to change
50specific socket options. The callback's *purpose* argument identifies the
51exact purpose for this particular socket:
53*CURLSOCKTYPE_IPCXN* for actively created connections or *CURLSOCKTYPE_ACCEPT*
54for FTP when the connection was setup with PORT/EPSV (in earlier versions
55these sockets were not passed to this callback).
57Future versions of libcurl may support more purposes. libcurl passes the newly
58created socket descriptor to the callback in the *curlfd* parameter so
59additional setsockopt() calls can be done at the user's discretion.
61The *clientp* pointer contains whatever user-defined value set using the
62CURLOPT_SOCKOPTDATA(3) function.
64Return *CURL_SOCKOPT_OK* from the callback on success. Return
65*CURL_SOCKOPT_ERROR* from the callback function to signal an unrecoverable
66error to the library and it closes the socket and returns
67*CURLE_COULDNT_CONNECT* for *CURLSOCKTYPE_IPCXN* and
68*CURLE_ABORTED_BY_CALLBACK* for *CURLSOCKTYPE_ACCEPT*.
70The callback function may return *CURL_SOCKOPT_ALREADY_CONNECTED* for
71*CURLSOCKTYPE_IPCXN*, to tell libcurl that the socket is already connected and
72then libcurl does no attempt to connect. This allows an application to pass in
73an already connected socket with CURLOPT_OPENSOCKETFUNCTION(3) and then have
74this function make libcurl not attempt to connect (again).
76The *CURL_SOCKOPT_ALREADY_CONNECTED* feature does not work for HTTP/3 (QUIC)
77connections.
79# DEFAULT
81NULL
83# %PROTOCOLS%
85# EXAMPLE
87~~~c
88/* make libcurl use the already established socket 'sockfd' */
90static curl_socket_t opensocket(void *clientp,
91 curlsocktype purpose,
92 struct curl_sockaddr *address)
94 curl_socket_t sockfd;
95 sockfd = *(curl_socket_t *)clientp;
96 /* the actual externally set socket is passed in via the OPENSOCKETDATA
97 option */
98 return sockfd;
101static int sockopt_callback(void *clientp, curl_socket_t curlfd,
102 curlsocktype purpose)
104 return CURL_SOCKOPT_ALREADY_CONNECTED;
107int main(void)
109 CURL *curl = curl_easy_init();
110 if(curl) {
111 CURLcode result;
112 int sockfd; /* our custom file descriptor */
113 /* libcurl thinks that you connect to the host
114 * and port that you specify in the URL option. */
115 curl_easy_setopt(curl, CURLOPT_URL, "http://99.99.99.99:9999");
116 /* call this function to get a socket */
117 curl_easy_setopt(curl, CURLOPT_OPENSOCKETFUNCTION, opensocket);
118 curl_easy_setopt(curl, CURLOPT_OPENSOCKETDATA, &sockfd);
120 /* call this function to set options for the socket */
121 curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
123 result = curl_easy_perform(curl);
125 curl_easy_cleanup(curl);
126 }
128~~~
130# %AVAILABILITY%
132# RETURN VALUE
134curl_easy_setopt(3) returns a CURLcode indicating success or error.
136CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
137libcurl-errors(3).
Diagnostics4 git calls · 248 ms
CallStatusSizeTime0248 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=3
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.8 KiB243 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=243
git.response.bytes=1833
git.response.cache=MISS
git.response.duration_ms=243
git.fetch.wants=abc8d65f0cc25a934a5556499d6674695ca6f733
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=1833
git.pkt.payload.max=1812
git.sideband.band1.bytes=1811
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
a5e392b31f005751
Request
372684fe…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format