mirror of
https://github.com/moparisthebest/curl
synced 2024-12-23 00:28:48 -05:00
70 lines
2.7 KiB
Groff
70 lines
2.7 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_INTERFACE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_INTERFACE \- source interface for outgoing traffic
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERFACE, char *interface);
|
|
.SH DESCRIPTION
|
|
Pass a char * 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 host name.
|
|
|
|
If the parameter starts with "if!" then it is treated as only as interface
|
|
name and no attempt will ever be named to do treat it as an IP address or to
|
|
do name resolution on it. If the parameter starts with \&"host!" it is
|
|
treated as either an IP address or a hostname. Hostnames are resolved
|
|
synchronously. Using the if! format is highly recommended when using the
|
|
multi interfaces to avoid allowing the code to block. If "if!" is specified
|
|
but the parameter does not match an existing interface, CURLE_INTERFACE_FAILED
|
|
is returned from the libcurl function used to perform the transfer.
|
|
|
|
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
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
|
|
|
|
curl_easy_setopt(curl, CURLOPT_INTERFACE, "eth0");
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
The "if!" and "host!" syntax was added in 7.24.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK on success or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), "
|