mirror of
https://github.com/curl/curl.git
synced 2024-12-15 06:40:09 +08:00
1fbd822b64
- avoid writing "set ..." or "enable/disable ..." or "specify ..." *All* options for curl_easy_setopt() are about setting or enabling things and most of the existing options didn't use that way of description. - start with lowercase letter, unless abbreviation. For consistency. - Some additional touch-ups Closes #7688
69 lines
2.6 KiB
Groff
69 lines
2.6 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_BUFFERSIZE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_BUFFERSIZE \- receive buffer size
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size);
|
|
.SH DESCRIPTION
|
|
Pass a long specifying your preferred \fIsize\fP (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 performance.
|
|
|
|
This is just treated as a request, not an order. You cannot be guaranteed to
|
|
actually get the given size.
|
|
|
|
This buffer size is by default \fICURL_MAX_WRITE_SIZE\fP (16kB). The maximum
|
|
buffer size allowed to be set is \fICURL_MAX_READ_SIZE\fP (512kB). The minimum
|
|
buffer size allowed to be set is 1024.
|
|
|
|
DO NOT set this option on a handle that is currently used for an active
|
|
transfer as that may lead to unintended consequences.
|
|
.SH DEFAULT
|
|
CURL_MAX_WRITE_SIZE (16kB)
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.10. Growing the buffer was added in 7.53.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_WRITEFUNCTION "(3), "
|