Artifactspublic-v0

curl

master
ply4 git calls138 ms288 KiB2 cachedprotocol v2
93 lines2.4 KiBRaw

NAME

CURLOPT_UNIX_SOCKET_PATH - Unix domain socket

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path);

DESCRIPTION

Enables the use of Unix domain sockets as connection endpoint and sets the path to path. If path is NULL, then Unix domain sockets are disabled.

When enabled, curl connects to the Unix domain socket instead of establishing a TCP connection to the host. Since no network connection is created, curl does not resolve the DNS hostname in the URL.

The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms it might be even less.

Proxy and TCP options such as CURLOPT_TCP_NODELAY(3) are not supported. Proxy options such as CURLOPT_PROXY(3) have no effect either as these are TCP-oriented, and asking a proxy server to connect to a certain Unix domain socket is not possible.

The application does not have to keep the string around after setting this option.

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

DEFAULT

NULL - no Unix domain sockets are used.

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_UNIX_SOCKET_PATH, "/tmp/httpd.sock");
    curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/");

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

If you are on Linux and somehow have a need for paths larger than 107 bytes, you can use the proc file system to bypass the limitation:

c
  int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY);
  char path[108];
  snprintf(path, sizeof(path), "/proc/self/fd/%d/httpd.sock", dirfd);
  curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path);
  /* Be sure to keep dirfd valid until you discard the handle */

%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_UNIX_SOCKET_PATH
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_ABSTRACT_UNIX_SOCKET (3)
9 - CURLOPT_OPENSOCKETFUNCTION (3)
10 - unix (7)
11Protocol:
12 - All
13Added-in: 7.40.0
14---
16# NAME
18CURLOPT_UNIX_SOCKET_PATH - Unix domain socket
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path);
26~~~
28# DESCRIPTION
30Enables the use of Unix domain sockets as connection endpoint and sets the
31path to *path*. If *path* is NULL, then Unix domain sockets are
32disabled.
34When enabled, curl connects to the Unix domain socket instead of establishing
35a TCP connection to the host. Since no network connection is created, curl
36does not resolve the DNS hostname in the URL.
38The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms
39it might be even less.
41Proxy and TCP options such as CURLOPT_TCP_NODELAY(3) are not supported. Proxy
42options such as CURLOPT_PROXY(3) have no effect either as these are
43TCP-oriented, and asking a proxy server to connect to a certain Unix domain
44socket is not possible.
46The application does not have to keep the string around after setting this
47option.
49Using this option multiple times makes the last set string override the
50previous ones. Set it to NULL to disable its use again.
52# DEFAULT
54NULL - no Unix domain sockets are used.
56# %PROTOCOLS%
58# EXAMPLE
60~~~c
61int main(void)
63 CURL *curl = curl_easy_init();
64 if(curl) {
65 CURLcode result;
66 curl_easy_setopt(curl, CURLOPT_UNIX_SOCKET_PATH, "/tmp/httpd.sock");
67 curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/");
69 result = curl_easy_perform(curl);
70 curl_easy_cleanup(curl);
71 }
73~~~
75If you are on Linux and somehow have a need for paths larger than 107 bytes,
76you can use the *proc* file system to bypass the limitation:
78~~~c
79 int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY);
80 char path[108];
81 snprintf(path, sizeof(path), "/proc/self/fd/%d/httpd.sock", dirfd);
82 curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path);
83 /* Be sure to keep dirfd valid until you discard the handle */
84~~~
86# %AVAILABILITY%
88# RETURN VALUE
90curl_easy_setopt(3) returns a CURLcode indicating success or error.
92CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
93libcurl-errors(3).
Diagnostics4 git calls · 138 ms
CallStatusSizeTime0138 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 KiB133 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=133
git.response.bytes=1325
git.response.cache=MISS
git.response.duration_ms=133
git.fetch.wants=2ff1c1bcb587042c59f4cea23525d3ddb3d93d89
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=1325
git.pkt.payload.max=1304
git.sideband.band1.bytes=1303
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
a5e357de3b4d2c38
Request
85efcebf…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format