mirror of https://github.com/curl/curl.git synced 2024-12-27 06:59:43 +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.2 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

CURLINFO_HEADER_SIZE

libcurl

CURLINFO_REQUEST_SIZE (3)

CURLINFO_SIZE_DOWNLOAD (3)

curl_easy_getinfo (3)

curl_easy_setopt (3)

All

NAME

CURLINFO_HEADER_SIZE - get size of retrieved headers

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HEADER_SIZE, long *sizep);

DESCRIPTION

Pass a pointer to a long to receive the total size of all the headers received. Measured in number of bytes.

The total includes the size of any received headers suppressed by CURLOPT_SUPPRESS_CONNECT_HEADERS(3).

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    res = curl_easy_perform(curl);
    if(res == CURLE_OK) {
      long size;
      res = curl_easy_getinfo(curl, CURLINFO_HEADER_SIZE, &size);
      if(!res)
        printf("Header size: %ld bytes\n", size);
    }
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in 7.4.1

RETURN VALUE

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

1.2 KiB Raw Blame History