docs/libcurl/opts/CURLOPT_INTERFACE.3

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