docs/libcurl/opts/CURLOPT_UNIX_SOCKET_PATH.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, 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 "December 21, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_UNIX_SOCKET_PATH \- set Unix domain socket
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path);
  31 .SH DESCRIPTION
  32 Enables the use of Unix domain sockets as connection endpoint and sets the path
  33 to \fIpath\fP. If \fIpath\fP is NULL, then Unix domain sockets are disabled. An
  34 empty string will result in an error at some point, it will not disable use of
  35 Unix domain sockets.
  36
  37 When enabled, curl will connect to the Unix domain socket instead of
  38 establishing a TCP connection to a host. Since no TCP connection is created,
  39 curl does not need to resolve the DNS hostname in the URL.
  40
  41 The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms
  42 it might be even less.
  43
  44 Proxy and TCP options such as
  45 .BR CURLOPT_TCP_NODELAY "(3)
  46 are not supported. Proxy options such as
  47 .BR CURLOPT_PROXY "(3)
  48 have no effect either as these are TCP-oriented, and asking a proxy server to
  49 connect to a certain Unix domain socket is not possible.
  50
  51 The application does not have to keep the string around after setting this
  52 option.
  53 .SH DEFAULT
  54 Default is NULL, meaning that no Unix domain sockets are used.
  55 .SH PROTOCOLS
  56 All protocols except for file:// and FTP are supported in theory. HTTP, IMAP,
  57 POP3 and SMTP should in particular work (including their SSL/TLS variants).
  58 .SH EXAMPLE
  59 Given that you have an nginx server running, listening on /tmp/nginx.sock, you
  60 can request a HTTP resource with:
  61
  62 .nf
  63     curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, "/tmp/nginx.sock");
  64     curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/");
  65 .fi
  66
  67 If you are on Linux and somehow have a need for paths larger than 107 bytes, you
  68 could use the proc filesystem to bypass the limitation:
  69
  70 .nf
  71     int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY);
  72     char path[108];
  73     snprintf(path, sizeof(path), "/proc/self/fd/%d/nginx.sock", dirfd);
  74     curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path);
  75     /* Be sure to keep dirfd valid until you discard the handle */
  76 .fi
  77 .SH AVAILABILITY
  78 Since 7.40.0.
  79 .SH RETURN VALUE
  80 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  81 .SH "SEE ALSO"
  82 .BR CURLOPT_OPENSOCKETFUNCTION "(3), " unix "(7), "