curl / libcurl / API / curl_easy_setopt / CURLOPT_ABSTRACT_UNIX_SOCKET

CURLOPT_ABSTRACT_UNIX_SOCKET explained

Name

CURLOPT_ABSTRACT_UNIX_SOCKET - abstract Unix domain socket

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ABSTRACT_UNIX_SOCKET,
                          char *path);

Description

Enables the use of an abstract Unix domain socket instead of establishing a TCP connection to a host. The parameter should be a char * to a null-terminated string holding the path of the socket. The path is set to path prefixed by a NULL byte. This is the convention for abstract sockets, however it should be stressed that the path passed to this function should not contain a leading NULL byte.

On non-supporting platforms, the abstract address is interpreted as an empty string and fails gracefully, generating a runtime error.

This option shares the same semantics as CURLOPT_UNIX_SOCKET_PATH in which documentation more details can be found. Internally, these two options share the same storage and therefore only one of them can be set per handle.

Default

NULL

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock");
    curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/");
 
    /* Perform the request */
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.53.0

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.