curl / libcurl / API / curl_easy_setopt / CURLOPT_TRANSFER_ENCODING

CURLOPT_TRANSFER_ENCODING explained

Name

CURLOPT_TRANSFER_ENCODING - ask for HTTP Transfer Encoding

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFER_ENCODING,
                          long enable);

Description

Pass a long set to 1L to enable or 0 to disable.

Adds a request for compressed Transfer Encoding in the outgoing HTTP request. If the server supports this and so desires, it can respond with the HTTP response sent using a compressed Transfer-Encoding that is automatically uncompressed by libcurl on reception.

Transfer-Encoding differs slightly from the Content-Encoding you ask for with CURLOPT_ACCEPT_ENCODING in that a Transfer-Encoding is strictly meant to be for the transfer and thus MUST be decoded before the data arrives in the client. Traditionally, Transfer-Encoding has been much less used and supported by both HTTP clients and HTTP servers.

Default

Protocols

This functionality affects http only

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    curl_easy_setopt(curl, CURLOPT_TRANSFER_ENCODING, 1L);
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.21.6

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.