docs/libcurl/opts/CURLOPT_MAX_SEND_SPEED_LARGE.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 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_MAX_SEND_SPEED_LARGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_MAX_SEND_SPEED_LARGE \- rate limit data upload speed
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
  31                           curl_off_t maxspeed);
  32 .SH DESCRIPTION
  33 Pass a curl_off_t as parameter with the \fImaxspeed\fP.  If an upload exceeds
  34 this speed (counted in bytes per second) on cumulative average during the
  35 transfer, the transfer will pause to keep the average rate less than or equal
  36 to the parameter value.  Defaults to unlimited speed.
  37
  38 This option doesn't affect transfer speeds done with FILE:// URLs.
  39 .SH DEFAULT
  40 0, disabled
  41 .SH PROTOCOLS
  42 All except file://
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.15.5
  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_LARGE "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "