Commit 3b80d3ca authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

getinfo: return sizes as curl_off_t 

This change introduces new alternatives for the existing six
curl_easy_getinfo() options that return sizes or speeds as doubles. The
new versions are named like the old ones but with an appended '_T':

CURLINFO_CONTENT_LENGTH_DOWNLOAD_T
CURLINFO_CONTENT_LENGTH_UPLOAD_T
CURLINFO_SIZE_DOWNLOAD_T
CURLINFO_SIZE_UPLOAD_T
CURLINFO_SPEED_DOWNLOAD_T
CURLINFO_SPEED_UPLOAD_T

Closes #1511
parent 62085470

docs/libcurl/curl_easy_getinfo.3

+24 −8
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms
@@ -84,17 +84,29 @@ See \fICURLINFO_REDIRECT_COUNT(3)\fP 
URL a redirect would take you to, had you enabled redirects.

See \fICURLINFO_REDIRECT_URL(3)\fP

.IP CURLINFO_SIZE_UPLOAD

Number of bytes uploaded.

(Deprecated) Number of bytes uploaded.

See \fICURLINFO_SIZE_UPLOAD(3)\fP

.IP CURLINFO_SIZE_UPLOAD_T

Number of bytes uploaded.

See \fICURLINFO_SIZE_UPLOAD_T(3)\fP

.IP CURLINFO_SIZE_DOWNLOAD

Number of bytes downloaded.

(Deprecated) Number of bytes downloaded.

See \fICURLINFO_SIZE_DOWNLOAD(3)\fP

.IP CURLINFO_SIZE_DOWNLOAD_T

Number of bytes downloaded.

See \fICURLINFO_SIZE_DOWNLOAD_T(3)\fP

.IP CURLINFO_SPEED_DOWNLOAD

Average download speed.

(Deprecated) Average download speed.

See \fICURLINFO_SPEED_DOWNLOAD(3)\fP

.IP CURLINFO_SPEED_DOWNLOAD_T

Average download speed.

See \fICURLINFO_SPEED_DOWNLOAD_T(3)\fP

.IP CURLINFO_SPEED_UPLOAD

Average upload speed.

(Deprecated) Average upload speed.

See \fICURLINFO_SPEED_UPLOAD(3)\fP

.IP CURLINFO_SPEED_UPLOAD_T

Average upload speed.

See \fICURLINFO_SPEED_UPLOAD_T(3)\fP

.IP CURLINFO_HEADER_SIZE

Number of bytes of all headers received.

See \fICURLINFO_HEADER_SIZE(3)\fP
@@ -111,11 +123,15 @@ See \fICURLINFO_PROXY_SSL_VERIFYRESULT(3)\fP 
A list of OpenSSL crypto engines.

See \fICURLINFO_SSL_ENGINES(3)\fP

.IP CURLINFO_CONTENT_LENGTH_DOWNLOAD

Content length from the Content-Length header.

(Deprecated) Content length from the Content-Length header.

See \fICURLINFO_CONTENT_LENGTH_DOWNLOAD(3)\fP

.IP CURLINFO_CONTENT_LENGTH_DOWNLOAD_T

Content length from the Content-Length header.

See \fICURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)\fP

.IP CURLINFO_CONTENT_LENGTH_UPLOAD

Upload size.

See \fICURLINFO_CONTENT_LENGTH_UPLOAD(3)\fP

(Deprecated) Upload size. See \fICURLINFO_CONTENT_LENGTH_UPLOAD(3)\fP

.IP CURLINFO_CONTENT_LENGTH_UPLOAD_T

Upload size.  See \fICURLINFO_CONTENT_LENGTH_UPLOAD_T(3)\fP

.IP CURLINFO_CONTENT_TYPE

Content type from the Content-Type header.

See \fICURLINFO_CONTENT_TYPE(3)\fP

docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD.3

+3 −0
Original line number Diff line number Diff line
@@ -32,6 +32,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD, 
Pass a pointer to a double to receive the content-length of the download. This

is the value read from the Content-Length: field. Since 7.19.4, this returns

-1 if the size isn't known.



\fICURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)\fP is a newer replacement that returns a more

sensible variable type.

.SH PROTOCOLS

HTTP(S)

.SH EXAMPLE

docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD_T.3

0 → 100644
+62 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at https://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLINFO_CONTENT_LENGTH_DOWNLOAD_T 3 "25 May 2017" "libcurl 7.55.0" "curl_easy_getinfo options"

.SH NAME

CURLINFO_CONTENT_LENGTH_DOWNLOAD_T \- get content-length of download

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T,

                           curl_off_t *content_length);

.SH DESCRIPTION

Pass a pointer to a \fIcurl_off_t\fP to receive the content-length of the

download. This is the value read from the Content-Length: field. Stores -1 if

the size isn't known.

.SH PROTOCOLS

HTTP(S)

.SH EXAMPLE

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");



  /* Perform the request */

  res = curl_easy_perform(curl);



  if(!res) {

    /* check the size */

    curl_off_t cl;

    res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &cl);

    if(!res) {

      printf("Size: " CURL_FORMAT_CURL_OFF_T "\\n", cl);

    }

  }

}

.fi

.SH AVAILABILITY

Added in 7.55.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "

.BR CURLINFO_CONTENT_LENGTH_UPLOAD_T "(3), "

docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_UPLOAD.3

+5 −1
Original line number Diff line number Diff line
@@ -31,6 +31,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD, 
.SH DESCRIPTION

Pass a pointer to a double to receive the specified size of the upload.  Since

7.19.4, this returns -1 if the size isn't known.



\fICURLINFO_CONTENT_LENGTH_UPLOAD_T(3)\fP is a newer replacement that returns a

more sensible variable type.

.SH PROTOCOLS

All

.SH EXAMPLE
@@ -45,7 +48,7 @@ if(curl) { 
  if(!res) {

    /* check the size */

    double cl;

    res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &cl);

    res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_UPLOAD, &cl);

    if(!res) {

      printf("Size: %.0f\\n", cl);

    }
@@ -58,3 +61,4 @@ Added in 7.6.1 
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "

.BR CURLINFO_CONTENT_LENGTH_DOWNLOAD_T "(3), "

docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_UPLOAD_T.3

0 → 100644
+61 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at https://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLINFO_CONTENT_LENGTH_UPLOAD_T 3 "25 May 2017" "libcurl 7.55.0" "curl_easy_getinfo options"

.SH NAME

CURLINFO_CONTENT_LENGTH_UPLOAD_T \- get the specified size of the upload

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD_T,

                           curl_off_t *content_length);

.SH DESCRIPTION

Pass a pointer to a \fIcurl_off_t\fP to receive the specified size of the

upload. Stores -1 if the size isn't known.

.SH PROTOCOLS

All

.SH EXAMPLE

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");



  /* Perform the upload */

  res = curl_easy_perform(curl);



  if(!res) {

    /* check the size */

    curl_off_t cl;

    res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_UPLOAD_T, &cl);

    if(!res) {

      printf("Size: " CURL_FORMAT_CURL_OFF_T "\\n", cl);

    }

  }

}

.fi

.SH AVAILABILITY

Added in 7.55.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "

.BR CURLINFO_CONTENT_LENGTH_DOWNLOAD_T "(3), "