| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_UNIX_SOCKET_PATH 3 "09 Oct 2014" "libcurl 7.40.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_UNIX_SOCKET_PATH \- set Unix domain socket |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path); |
| 30 |
.SH DESCRIPTION |
| 31 |
Enables the use of Unix domain sockets as connection endpoint and sets the path |
| 32 |
to \fIpath\fP. If \fIpath\fP is NULL, then Unix domain sockets are disabled. An |
| 33 |
empty string will result in an error at some point, it will not disable use of |
| 34 |
Unix domain sockets. |
| 35 |
|
| 36 |
When enabled, curl will connect to the Unix domain socket instead of |
| 37 |
establishing a TCP connection to a host. Since no TCP connection is created, |
| 38 |
curl does not need to resolve the DNS hostname in the URL. |
| 39 |
|
| 40 |
The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms |
| 41 |
it might be even less. |
| 42 |
|
| 43 |
Proxy and TCP options such as |
| 44 |
.BR CURLOPT_TCP_NODELAY "(3) |
| 45 |
are not supported. Proxy options such as |
| 46 |
.BR CURLOPT_PROXY "(3) |
| 47 |
have no effect either as these are TCP-oriented, and asking a proxy server to |
| 48 |
connect to a certain Unix domain socket is not possible. |
| 49 |
|
| 50 |
The application does not have to keep the string around after setting this |
| 51 |
option. |
| 52 |
.SH DEFAULT |
| 53 |
Default is NULL, meaning that no Unix domain sockets are used. |
| 54 |
.SH PROTOCOLS |
| 55 |
All protocols except for file:// and FTP are supported in theory. HTTP, IMAP, |
| 56 |
POP3 and SMTP should in particular work (including their SSL/TLS variants). |
| 57 |
.SH EXAMPLE |
| 58 |
Given that you have an nginx server running, listening on /tmp/nginx.sock, you |
| 59 |
can request an HTTP resource with: |
| 60 |
|
| 61 |
.nf |
| 62 |
curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, "/tmp/nginx.sock"); |
| 63 |
curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/"); |
| 64 |
.fi |
| 65 |
|
| 66 |
If you are on Linux and somehow have a need for paths larger than 107 bytes, you |
| 67 |
could use the proc filesystem to bypass the limitation: |
| 68 |
|
| 69 |
.nf |
| 70 |
int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY); |
| 71 |
char path[108]; |
| 72 |
snprintf(path, sizeof(path), "/proc/self/fd/%d/nginx.sock", dirfd); |
| 73 |
curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path); |
| 74 |
/* Be sure to keep dirfd valid until you discard the handle */ |
| 75 |
.fi |
| 76 |
.SH AVAILABILITY |
| 77 |
Since 7.40.0. |
| 78 |
.SH RETURN VALUE |
| 79 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 80 |
.SH "SEE ALSO" |
| 81 |
.BR CURLOPT_OPENSOCKETFUNCTION "(3), " unix "(7), " |