mirror of
https://github.com/moparisthebest/curl
synced 2024-11-15 14:05:03 -05:00
1763aceb0c
Previously this logic would cap the send to CURL_MAX_WRITE_SIZE bytes, but for the situations where a larger upload buffer has been set, this function can benefit from sending more bytes. With default size used, this does the same as before. Also changed the storage of the size to an 'unsigned int' as it is not allowed to be set larger than 2M. Also added cautions to the man pages about changing buffer sizes in run-time. Closes #7022
73 lines
2.7 KiB
Groff
73 lines
2.7 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2018, 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_UPLOAD_BUFFERSIZE 3 "18 Aug 2018" "libcurl 7.62.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_UPLOAD_BUFFERSIZE \- set preferred upload buffer size
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPLOAD_BUFFERSIZE, long size);
|
|
.SH DESCRIPTION
|
|
Pass a long specifying your preferred \fIsize\fP (in bytes) for the upload
|
|
buffer in libcurl. It makes libcurl uses a larger buffer that gets passed to
|
|
the next layer in the stack to get sent off. In some setups and for some
|
|
protocols, there's a huge performance benefit of having a larger upload
|
|
buffer.
|
|
|
|
This is just treated as a request, not an order. You cannot be guaranteed to
|
|
actually get the given size.
|
|
|
|
The upload buffer size is by default 64 kilobytes. The maximum buffer size
|
|
allowed to be set is 2 megabytes. The minimum buffer size allowed to be set is
|
|
16 kilobytes.
|
|
|
|
Since curl 7.61.1 the upload buffer is allocated on-demand - so if the handle
|
|
isn't used for upload, this buffer will not be allocated at all.
|
|
|
|
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
|
|
64 kB
|
|
.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 upload buffer */
|
|
curl_easy_setopt(curl, CURLOPT_UPLOAD_BUFFERSIZE, 120000L);
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.62.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_BUFFERSIZE "(3), " CURLOPT_READFUNCTION "(3), "
|