curl / libcurl / API / curl_easy_setopt / CURLOPT_ABSTRACT_UNIX_SOCKET

CURLOPT_ABSTRACT_UNIX_SOCKET explained

NAME

CURLOPT_ABSTRACT_UNIX_SOCKET - set an 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 zero terminated string holding the path of the socket. The path will be 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).

On non-supporting platforms, the abstract address will be interpreted as an empty string and fail gracefully, generating a run-time error.

This option shares the same semantics as CURLOPT_UNIX_SOCKET_PATHin 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

Default is NULL.

EXAMPLE

    curl_easy_setopt(curl_handle, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock");
    curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/");

AVAILABILITY

Since 7.53.0.

RETURN VALUE

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

SEE ALSO

CURLOPT_UNIX_SOCKET_PATH, unix (7)

This HTML page was made with roffit.