Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_TRANSFER_ENCODING (3)

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

curl_easy_setopt options                          CURLOPT_TRANSFER_ENCODING(3)



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
       will be automatically uncompressed by libcurl on reception.

       Transfer-Encoding differs slightly from the  Content-Encoding  you  ask
       for  with  CURLOPT_ACCEPT_ENCODING(3)  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
       0

PROTOCOLS
       HTTP

EXAMPLE
       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 7.21.6

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


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


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

SEE ALSO
       CURLOPT_ACCEPT_ENCODING(3), CURLOPT_HTTP_TRANSFER_DECODING(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_TRANSFER_ENCODING(3)