• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_SPEED_UPLOAD_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_SPEED_DOWNLOAD_T (3)
9  - curl_easy_getinfo (3)
10  - curl_easy_setopt (3)
11---
12
13# NAME
14
15CURLINFO_SPEED_UPLOAD_T - get upload speed
16
17# SYNOPSIS
18
19~~~c
20#include <curl/curl.h>
21
22CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD_T,
23                           curl_off_t *speed);
24~~~
25
26# DESCRIPTION
27
28Pass a pointer to a *curl_off_t* to receive the average upload speed that
29curl measured for the complete upload. Measured in bytes/second.
30
31# PROTOCOLS
32
33# EXAMPLE
34
35~~~c
36int main(void)
37{
38  CURL *curl = curl_easy_init();
39  if(curl) {
40    CURLcode res;
41    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
42
43    /* Perform the request */
44    res = curl_easy_perform(curl);
45
46    if(!res) {
47      curl_off_t speed;
48      res = curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD_T, &speed);
49      if(!res) {
50        printf("Upload speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\n", speed);
51      }
52    }
53  }
54}
55~~~
56
57# AVAILABILITY
58
59Added in 7.55.0
60
61# RETURN VALUE
62
63Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
64