docs/libcurl/opts/CURLOPT_MAX_RECV_SPEED_LARGE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_RECV_SPEED_LARGE 3 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_MAX_RECV_SPEED_LARGE \- rate limit data download speed
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_RECV_SPEED_LARGE,
  32                           curl_off_t speed);
  33 .SH DESCRIPTION
  34 Pass a curl_off_t as parameter.  If a download exceeds this \fIspeed\fP
  35 (counted in bytes per second) the transfer will pause to keep the speed less
  36 than or equal 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 but file://
  43 .SH EXAMPLE
  44 .nf
  45 CURL *curl = curl_easy_init();
  46 if(curl) {
  47   CURLcode ret;
  48   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  49   /* cap the download speed to 31415 bytes/sec */
  50   curl_easy_setopt(curl, CURLOPT_MAX_RECV_SPEED_LARGE, (curl_off_t)31415);
  51   ret = curl_easy_perform(curl);
  52 }
  53 .fi
  54 .SH AVAILABILITY
  55 Added in 7.15.5
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  58 .SH "SEE ALSO"
  59 .BR CURLOPT_MAX_SEND_SPEED_LARGE "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "