Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SPEED_UPLOAD.3, revision 1.1.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 CURLINFO_SPEED_UPLOAD 3 "June 15, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
24:
25: .SH NAME
26: CURLINFO_SPEED_UPLOAD \- get upload speed
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD, double *speed);
31: .SH DESCRIPTION
32: Pass a pointer to a double to receive the average upload speed that curl
33: measured for the complete upload. Measured in bytes/second.
34:
35: \fICURLINFO_SPEED_UPLOAD_T(3)\fP is a newer replacement that returns a more
36: sensible variable type.
37: .SH PROTOCOLS
38: .SH EXAMPLE
39: .nf
40: CURL *curl = curl_easy_init();
41: if(curl) {
42: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
43:
44: /* Perform the request */
45: res = curl_easy_perform(curl);
46:
47: if(!res) {
48: double speed;
49: res = curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD, &speed);
50: if(!res) {
51: printf("Upload speed %.0f bytes/sec\\n", ul);
52: }
53: }
54: }
55: .fi
56: .SH AVAILABILITY
57: Added in
58: .SH RETURN VALUE
59: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60: .SH "SEE ALSO"
61: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
62: .BR CURLINFO_SPEED_DOWNLOAD "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>