Return to CURLOPT_BUFFERSIZE.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_BUFFERSIZE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_BUFFERSIZE 3 "May 13, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_BUFFERSIZE \- set preferred receive buffer size
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size);
                     31: .SH DESCRIPTION
                     32: Pass a long specifying your preferred \fIsize\fP (in bytes) for the receive
                     33: buffer in libcurl.  The main point of this would be that the write callback
                     34: gets called more often and with smaller chunks. Secondly, for some protocols,
                     35: there's a benefit of having a larger buffer for performance.
                     36: 
                     37: This is just treated as a request, not an order. You cannot be guaranteed to
                     38: actually get the given size.
                     39: 
                     40: This buffer size is by default \fICURL_MAX_WRITE_SIZE\fP (16kB). The maximum
                     41: buffer size allowed to be set is \fICURL_MAX_READ_SIZE\fP (512kB). The minimum
                     42: buffer size allowed to be set is 1024.
                     43: .SH DEFAULT
                     44: CURL_MAX_WRITE_SIZE (16kB)
                     45: .SH PROTOCOLS
                     46: All
                     47: .SH EXAMPLE
                     48: .nf
                     49: CURL *curl = curl_easy_init();
                     50: if(curl) {
                     51:   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/foo.bin");
                     52: 
                     53:   /* ask libcurl to allocate a larger receive buffer */
                     54:   curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 120000L);
                     55: 
                     56:   ret = curl_easy_perform(curl);
                     57: 
                     58:   curl_easy_cleanup(curl);
                     59: }
                     60: .fi
                     61: .SH AVAILABILITY
                     62: Added in 7.10.  Growing the buffer was added in 7.53.0.
                     63: .SH RETURN VALUE
                     64: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     65: .SH "SEE ALSO"
                     66: .BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_WRITEFUNCTION "(3), "