docs/libcurl/opts/CURLOPT_BUFFERSIZE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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. This is just treated as a
  34 request, not an order. You cannot be guaranteed to actually get the given
  35 size.
  36
  37 This size is by default set as big as possible (\fICURL_MAX_WRITE_SIZE\fP), so
  38 it only makes sense to use this option if you want it smaller.
  39 .SH DEFAULT
  40 CURL_MAX_WRITE_SIZE
  41 .SH PROTOCOLS
  42 All
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.10
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  49 .SH "SEE ALSO"
  50 .BR CURLOPT_MAX_RECV_SPEED "(3), " CURLOPT_WRITEFUNCTION "(3), "