docs/libcurl/opts/CURLOPT_INTERFACE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_INTERFACE 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_INTERFACE \- source interface for outgoing traffic
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERFACE, char *interface);
  31 .SH DESCRIPTION
  32 Pass a char * as parameter. This sets the \fIinterface\fP name to use as
  33 outgoing network interface. The name can be an interface name, an IP address,
  34 or a host name.
  35
  36 If the parameter starts with "if!" then it is treated as only as interface
  37 name and no attempt will ever be named to do treat it as an IP address or to
  38 do name resolution on it.  If the parameter starts with \&"host!" it is
  39 treated as either an IP address or a hostname.  Hostnames are resolved
  40 synchronously.  Using the if! format is highly recommended when using the
  41 multi interfaces to avoid allowing the code to block.  If "if!" is specified
  42 but the parameter does not match an existing interface, CURLE_INTERFACE_FAILED
  43 is returned from the libcurl function used to perform the transfer.
  44
  45 The application does not have to keep the string around after setting this
  46 option.
  47 .SH DEFAULT
  48 NULL, use whatever the TCP stack finds suitable
  49 .SH PROTOCOLS
  50 All
  51 .SH EXAMPLE
  52 .nf
  53 CURL *curl = curl_easy_init();
  54 if(curl) {
  55   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  56
  57   curl_easy_setopt(curl, CURLOPT_INTERFACE, "eth0");
  58
  59   ret = curl_easy_perform(curl);
  60
  61   curl_easy_cleanup(curl);
  62 }
  63 .fi
  64 .SH AVAILABILITY
  65 The "if!" and "host!" syntax was added in 7.24.0.
  66 .SH RETURN VALUE
  67 Returns CURLE_OK on success or
  68 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  69 .SH "SEE ALSO"
  70 .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), "