Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_SPEED_UPLOAD_T.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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_T 3 "25 May 2017" "libcurl 7.55.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_SPEED_UPLOAD_T \- get upload speed
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD_T, curl_off_t *speed);
30 .SH DESCRIPTION
31 Pass a pointer to a \fIcurl_off_t\fP to receive the average upload speed that
32 curl measured for the complete upload. Measured in bytes/second.
33 .SH PROTOCOLS
34 .SH EXAMPLE
35 .nf
36 CURL *curl = curl_easy_init();
37 if(curl) {
38 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
39
40 /* Perform the request */
41 res = curl_easy_perform(curl);
42
43 if(!res) {
44 curl_off_t speed;
45 res = curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD_T, &speed);
46 if(!res) {
47 printf("Upload speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\\n", speed);
48 }
49 }
50 }
51 .fi
52 .SH AVAILABILITY
53 Added in 7.55.0
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
56 .SH "SEE ALSO"
57 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
58 .BR CURLINFO_SPEED_DOWNLOAD_T "(3), "