Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SPEED_DOWNLOAD_T.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, 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 CURLINFO_SPEED_DOWNLOAD_T 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
24:
25: .SH NAME
26: CURLINFO_SPEED_DOWNLOAD_T \- get download speed
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T, curl_off_t *speed);
31: .SH DESCRIPTION
32: Pass a pointer to a \fIcurl_off_t\fP to receive the average download speed
33: that curl measured for the complete download. Measured in bytes/second.
34: .SH PROTOCOLS
35: .SH EXAMPLE
36: .nf
37: CURL *curl = curl_easy_init();
38: if(curl) {
39: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
40:
41: /* Perform the request */
42: res = curl_easy_perform(curl);
43:
44: if(!res) {
45: curl_off_t speed;
46: res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD_T, &speed);
47: if(!res) {
48: printf("Download speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\\n", speed);
49: }
50: }
51: }
52: .fi
53: .SH AVAILABILITY
54: Added in 7.55.0
55: .SH RETURN VALUE
56: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
57: .SH "SEE ALSO"
58: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
59: .BR CURLINFO_SPEED_UPLOAD "(3), "
60: .BR CURLINFO_SIZE_UPLOAD_T "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>