Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PROXYTYPE (3)

Name

CURLOPT_PROXYTYPE - proxy protocol type

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type);

Description

CURLOPT_PROXYTYPE(3)       curl_easy_setopt options       CURLOPT_PROXYTYPE(3)



NAME
       CURLOPT_PROXYTYPE - proxy protocol type

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type);

DESCRIPTION
       Pass one of the values below to set the type of the proxy.


              CURLPROXY_HTTP
                     HTTP Proxy. Default.

              CURLPROXY_HTTPS
                     HTTPS  Proxy.  (Added  in  7.52.0 for OpenSSL, GnuTLS and
                     NSS)

              CURLPROXY_HTTP_1_0
                     HTTP 1.0 Proxy. This is similar to CURLPROXY_HTTP  except
                     it  uses HTTP/1.0 for any CONNECT tunnelling. It does not
                     change the HTTP version of the actual HTTP requests, con-
                     trolled by CURLOPT_HTTP_VERSION(3).

              CURLPROXY_SOCKS4
                     SOCKS4 Proxy.

              CURLPROXY_SOCKS4A
                     SOCKS4a Proxy. Proxy resolves URL hostname.

              CURLPROXY_SOCKS5
                     SOCKS5 Proxy.

              CURLPROXY_SOCKS5_HOSTNAME
                     SOCKS5 Proxy. Proxy resolves URL hostname.

       Often  it  is more convenient to specify the proxy type with the scheme
       part of the CURLOPT_PROXY(3) string.

DEFAULT
       CURLPROXY_HTTP

PROTOCOLS
       Most

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode ret;
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_PROXY, "local.example.com:1080");
         /* set the proxy type */
         curl_easy_setopt(curl, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_PROXY(3), CURLOPT_PROXYPORT(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021          CURLOPT_PROXYTYPE(3)