www.LinuxHowtos.org

CURLOPT_PROXYTYPE

Section: C Library Functions (3)
Updated: 202-0-19
Index Return to Main Contents

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 using HTTP/1. (Added in 7.52.0 for OpenSSL and GnuTLS. Since 7.87.0, it also works for mbedTLS, Rustls, Schannel and wolfSSL.)
CURLPROXY_HTTPS2: HTTPS Proxy and attempt to speak HTTP/2 over it. (Added in 8.1.0)
CURLPROXY_HTTP_1_0: HTTP 1.0 Proxy. This is similar to CURLPROXY_HTTP except it uses HTTP/1.0 for any CONNECT tunneling. It does not change the HTTP version of the actual HTTP requests, controlled 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

This functionality affects all supported protocols

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    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);
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

HISTORY

CURLPROXY_* enums became long types in 8.16.0, prior to this version a long cast was necessary when passed to curl_easy_setopt(3).

AVAILABILITY

Added in curl 7.10

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).