| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_BUFFERSIZE \- set preferred receive buffer size |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long specifying your preferred \fIsize\fP (in bytes) for the receive |
| 32 |
buffer in libcurl. The main point of this would be that the write callback |
| 33 |
gets called more often and with smaller chunks. Secondly, for some protocols, |
| 34 |
there's a benefit of having a larger buffer for performance. |
| 35 |
|
| 36 |
This is just treated as a request, not an order. You cannot be guaranteed to |
| 37 |
actually get the given size. |
| 38 |
|
| 39 |
This buffer size is by default \fICURL_MAX_WRITE_SIZE\fP (16kB). The maximum |
| 40 |
buffer size allowed to be set is \fICURL_MAX_READ_SIZE\fP (512kB). The minimum |
| 41 |
buffer size allowed to be set is 1024. |
| 42 |
.SH DEFAULT |
| 43 |
CURL_MAX_WRITE_SIZE (16kB) |
| 44 |
.SH PROTOCOLS |
| 45 |
All |
| 46 |
.SH EXAMPLE |
| 47 |
.nf |
| 48 |
CURL *curl = curl_easy_init(); |
| 49 |
if(curl) { |
| 50 |
curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/foo.bin"); |
| 51 |
|
| 52 |
/* ask libcurl to allocate a larger receive buffer */ |
| 53 |
curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 120000L); |
| 54 |
|
| 55 |
ret = curl_easy_perform(curl); |
| 56 |
|
| 57 |
curl_easy_cleanup(curl); |
| 58 |
} |
| 59 |
.fi |
| 60 |
.SH AVAILABILITY |
| 61 |
Added in 7.10. Growing the buffer was added in 7.53.0. |
| 62 |
.SH RETURN VALUE |
| 63 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 64 |
.SH "SEE ALSO" |
| 65 |
.BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_WRITEFUNCTION "(3), " |