Artifactspublic-v0

curl

master
ply4 git calls36 ms288 KiB3 cachedprotocol v2
108 lines2.8 KiBRaw

NAME

CURLOPT_CLOSESOCKETFUNCTION - callback to socket close replacement

SYNOPSIS

c
#include <curl/curl.h>

int closesocket_callback(void *clientp, curl_socket_t item);

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION,
                          closesocket_callback);

DESCRIPTION

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

This callback function gets called by libcurl instead of the close(3) or closesocket(3) call when sockets are closed (not for any other file descriptors). This is pretty much the reverse to the CURLOPT_OPENSOCKETFUNCTION(3) option. Return 0 to signal success and 1 if there was an error.

The clientp pointer is set with CURLOPT_CLOSESOCKETDATA(3). item is the socket libcurl wants to be closed.

Note that when using multi/share handles, your callback may get invoked even after the easy handle has been cleaned up. The callback and data is inherited by a new connection and that connection may live longer than the transfer itself in the multi/share handle's connection cache.

NOTES ON CONNECTION REUSE

The close socket callback is invoked when libcurl closes a socket it owns. When using the multi interface, the callback and CURLOPT_CLOSESOCKETDATA(3) are copied from the first easy handle that creates the socket used for a connection; changing this option on a subsequent easy handle that reuses the same connection has no effect for that connection. The callback is stored with the connection because the connection and its associated socket may outlive the easy handle that created it, so that libcurl can still invoke it when the socket is closed even after that handle has been cleaned up.

DEFAULT

Use the standard socket close function.

%PROTOCOLS%

EXAMPLE

c
struct priv {
  void *custom;
};

static int closesocket(void *clientp, curl_socket_t item)
{
  struct priv *my = clientp;
  printf("our ptr: %p\n", my->custom);

  printf("libcurl wants to close %d now\n", (int)item);
  return 0;
}

int main(void)
{
  struct priv myown;
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    /* call this function to close sockets */
    curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
    curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &myown);

    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_CLOSESOCKETFUNCTION
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_CLOSESOCKETDATA (3)
9 - CURLOPT_OPENSOCKETFUNCTION (3)
10 - CURLMOPT_SOCKETFUNCTION (3)
11Protocol:
12 - All
13Added-in: 7.21.7
14---
16# NAME
18CURLOPT_CLOSESOCKETFUNCTION - callback to socket close replacement
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25int closesocket_callback(void *clientp, curl_socket_t item);
27CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION,
28 closesocket_callback);
29~~~
31# DESCRIPTION
33Pass a pointer to your callback function, which should match the prototype
34shown above.
36This callback function gets called by libcurl instead of the *close(3)* or
37*closesocket(3)* call when sockets are closed (not for any other file
38descriptors). This is pretty much the reverse to the
39CURLOPT_OPENSOCKETFUNCTION(3) option. Return 0 to signal success and 1
40if there was an error.
42The *clientp* pointer is set with
43CURLOPT_CLOSESOCKETDATA(3). *item* is the socket libcurl wants to be
44closed.
46Note that when using multi/share handles, your callback may get invoked even
47after the easy handle has been cleaned up. The callback and data is
48inherited by a new connection and that connection may live longer
49than the transfer itself in the multi/share handle's connection cache.
51# NOTES ON CONNECTION REUSE
53The close socket callback is invoked when libcurl closes a socket it owns.
54When using the multi interface, the callback and
55CURLOPT_CLOSESOCKETDATA(3) are copied from the *first* easy handle that
56creates the socket used for a connection; changing this option on a subsequent
57easy handle that reuses the same connection has no effect for that connection.
58The callback is stored with the connection because the connection and its
59associated socket may outlive the easy handle that created it, so that libcurl
60can still invoke it when the socket is closed even after that handle has been
61cleaned up.
63# DEFAULT
65Use the standard socket close function.
67# %PROTOCOLS%
69# EXAMPLE
71~~~c
72struct priv {
73 void *custom;
74};
76static int closesocket(void *clientp, curl_socket_t item)
78 struct priv *my = clientp;
79 printf("our ptr: %p\n", my->custom);
81 printf("libcurl wants to close %d now\n", (int)item);
82 return 0;
85int main(void)
87 struct priv myown;
88 CURL *curl = curl_easy_init();
89 if(curl) {
90 CURLcode result;
91 /* call this function to close sockets */
92 curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
93 curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &myown);
95 result = curl_easy_perform(curl);
96 curl_easy_cleanup(curl);
97 }
99~~~
101# %AVAILABILITY%
103# RETURN VALUE
105curl_easy_setopt(3) returns a CURLcode indicating success or error.
107CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
108libcurl-errors(3).
Diagnostics4 git calls · 36 ms
CallStatusSizeTime036 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 · 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 · hit2 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=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.3 KiB · hit31 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=31
git.response.bytes=1377
git.response.cache=HIT
git.response.duration_ms=31
git.fetch.wants=42a58e25a505f0db416dd93d45084b8754e21267
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=1377
git.pkt.payload.max=1356
git.sideband.band1.bytes=1355
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
a5e339a239cdf162
Request
acde6578…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format