mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00

Daniel Stenberg e3fe020089

docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175

2024-03-23 18:13:03 +01:00

1.3 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

CURLINFO_SPEED_DOWNLOAD

libcurl

CURLINFO_SIZE_UPLOAD_T (3)

CURLINFO_SPEED_UPLOAD (3)

curl_easy_getinfo (3)

curl_easy_setopt (3)

All

NAME

CURLINFO_SPEED_DOWNLOAD - get download speed

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD,
                           double *speed);

DESCRIPTION

Pass a pointer to a double to receive the average download speed that curl measured for the complete download. Measured in bytes/second.

CURLINFO_SPEED_DOWNLOAD_T(3) is a newer replacement that returns a more sensible variable type.

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* Perform the request */
    res = curl_easy_perform(curl);

    if(!res) {
      double speed;
      res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD, &speed);
      if(!res) {
        printf("Download speed %.0f bytes/sec\n", speed);
      }
    }
  }
}

AVAILABILITY

Added in 7.4.1. Deprecated since 7.55.0.

RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

1.3 KiB Raw Blame History