docs/libcurl/opts/CURLOPT_LOW_SPEED_LIMIT.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_LOW_SPEED_LIMIT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_LOW_SPEED_LIMIT \- set low speed limit in bytes per second
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT, long speedlimit);
  30 .SH DESCRIPTION
  31 Pass a long as parameter. It contains the average transfer speed in bytes per
  32 second that the transfer should be below during
  33 \fICURLOPT_LOW_SPEED_TIME(3)\fP seconds for libcurl to consider it to be too
  34 slow and abort.
  35 .SH DEFAULT
  36 0, disabled
  37 .SH PROTOCOLS
  38 All
  39 .SH EXAMPLE
  40 TODO
  41 .SH AVAILABILITY
  42 Always
  43 .SH RETURN VALUE
  44 Returns CURLE_OK
  45 .SH "SEE ALSO"
  46 .BR CURLOPT_LOW_SPEED_TIME "(3), " CURLOPT_TIMEOUT "(3), "