Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_BUFFERSIZE (3)

Name

CURLOPT_BUFFERSIZE - set preferred receive buffer size

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size);

Description

CURLOPT_BUFFERSIZE(3)      curl_easy_setopt options      CURLOPT_BUFFERSIZE(3)



NAME
       CURLOPT_BUFFERSIZE - set preferred receive buffer size

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size);

DESCRIPTION
       Pass  a  long specifying your preferred size (in bytes) for the receive
       buffer in libcurl.  The main point of this  would  be  that  the  write
       callback  gets called more often and with smaller chunks. Secondly, for
       some protocols, there's a benefit of having a larger buffer for perfor-
       mance.

       This  is just treated as a request, not an order. You cannot be guaran-
       teed to actually get the given size.

       This buffer size is by default CURL_MAX_WRITE_SIZE (16kB). The  maximum
       buffer  size allowed to be set is CURL_MAX_READ_SIZE (512kB). The mini-
       mum buffer size allowed to be set is 1024.

DEFAULT
       CURL_MAX_WRITE_SIZE (16kB)

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/foo.bin");

         /* ask libcurl to allocate a larger receive buffer */
         curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 120000L);

         ret = curl_easy_perform(curl);

         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.10.  Growing the buffer was added in 7.53.0.

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_MAX_RECV_SPEED_LARGE(3), CURLOPT_WRITEFUNCTION(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

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



libcurl 7.37.0                    17 Jun 2014            CURLOPT_BUFFERSIZE(3)