repo/core/curl/files/CURLOPT_INTERFACE.3

.\" generated by cd2nroff 0.1 from CURLOPT_INTERFACE.md
.TH CURLOPT_INTERFACE 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_INTERFACE \- source interface for outgoing traffic
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERFACE, char *interface);
.fi
.SH DESCRIPTION
Pass a char pointer as parameter. This sets the \fIinterface\fP name to use as
outgoing network interface. The name can be an interface name, an IP address,
or a hostname. If you prefer one of these, you can use the following special
prefixes:

* \fIif!<name>\fP \- Interface name
* \fIhost!<name>\fP \- IP address or hostname
* \fIifhost!<interface>!<host>\fP \- Interface name and IP address or hostname

If \fIif!\fP or \fIifhost!\fP is specified but the parameter does not match an existing
interface, \fICURLE_INTERFACE_FAILED\fP is returned from the libcurl function used
to perform the transfer.

libcurl does not support using network interface names for this option on
Windows.

We strongly advise against specifying the interface with a hostname, as it
causes libcurl to do a blocking name resolve call to retrieve the IP
address. That name resolve operation does \fBnot\fP use DNS\-over\-HTTPS even if
\fICURLOPT_DOH_URL(3)\fP is set.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL, use whatever the TCP stack finds suitable
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");

    curl_easy_setopt(curl, CURLOPT_INTERFACE, "eth0");

    res = curl_easy_perform(curl);

    curl_easy_cleanup(curl);
  }
}
.fi
.SH HISTORY
The \fIif!\fP and \fIhost!\fP syntax was added in 7.24.0.

The \fIifhost!\fP syntax was added in 8.9.0.
.SH AVAILABILITY
Added in curl 7.3
.SH RETURN VALUE
Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH SEE ALSO
.BR CURLOPT_LOCALPORT (3),
.BR CURLOPT_SOCKOPTFUNCTION (3),
.BR CURLOPT_TCP_NODELAY (3)