Return to CURLOPT_LOW_SPEED_LIMIT.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_LOW_SPEED_LIMIT.3, revision 1.1

1.1     ! misho       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_LOW_SPEED_LIMIT 3 "May 06, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_LOW_SPEED_LIMIT \- set low speed limit in bytes per second
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT, long speedlimit);
        !            31: .SH DESCRIPTION
        !            32: Pass a long as parameter. It contains the average transfer speed in bytes per
        !            33: second that the transfer should be below during
        !            34: \fICURLOPT_LOW_SPEED_TIME(3)\fP seconds for libcurl to consider it to be too
        !            35: slow and abort.
        !            36: .SH DEFAULT
        !            37: 0, disabled
        !            38: .SH PROTOCOLS
        !            39: All
        !            40: .SH EXAMPLE
        !            41: .nf
        !            42: curl = curl_easy_init();
        !            43: if(curl) {
        !            44:   curl_easy_setopt(curl, CURLOPT_URL, url);
        !            45:   /* abort if slower than 30 bytes/sec during 60 seconds */
        !            46:   curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
        !            47:   curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
        !            48:   res = curl_easy_perform(curl);
        !            49:   if(CURLE_OPERATION_TIMEDOUT == res) {
        !            50:     printf("Timeout!\\n");
        !            51:   }
        !            52:   /* always cleanup */
        !            53:   curl_easy_cleanup(curl);
        !            54: }
        !            55: .fi
        !            56: .SH AVAILABILITY
        !            57: Always
        !            58: .SH RETURN VALUE
        !            59: Returns CURLE_OK
        !            60: .SH "SEE ALSO"
        !            61: .BR CURLOPT_LOW_SPEED_TIME "(3), " CURLOPT_TIMEOUT "(3), "