Unverified Commit ce2140a8 authored by Philip Prindeville's avatar Philip Prindeville Committed by Daniel Stenberg
Browse files

getinfo: add microsecond precise timers for various intervals 

Provide a set of new timers that return the time intervals using integer
number of microseconds instead of floats.

The new info names are as following:

CURLINFO_APPCONNECT_TIME_T
CURLINFO_CONNECT_TIME_T
CURLINFO_NAMELOOKUP_TIME_T
CURLINFO_PRETRANSFER_TIME_T
CURLINFO_REDIRECT_TIME_T
CURLINFO_STARTTRANSFER_TIME_T
CURLINFO_TOTAL_TIME_T

Closes #2495
parent c5fe8680

docs/examples/chkspeed.c

+15 −11
Original line number Diff line number Diff line
@@ -165,33 +165,37 @@ int main(int argc, char *argv[]) 
  res = curl_easy_perform(curl_handle);



  if(CURLE_OK == res) {

    double val;

    curl_off_t val;



    /* check for bytes downloaded */

    res = curl_easy_getinfo(curl_handle, CURLINFO_SIZE_DOWNLOAD, &val);

    res = curl_easy_getinfo(curl_handle, CURLINFO_SIZE_DOWNLOAD_T, &val);

    if((CURLE_OK == res) && (val>0))

      printf("Data downloaded: %0.0f bytes.\n", val);

      printf("Data downloaded: %" CURL_FORMAT_CURL_OFF_T " bytes.\n", val);



    /* check for total download time */

    res = curl_easy_getinfo(curl_handle, CURLINFO_TOTAL_TIME, &val);

    res = curl_easy_getinfo(curl_handle, CURLINFO_TOTAL_TIME_T, &val);

    if((CURLE_OK == res) && (val>0))

      printf("Total download time: %0.3f sec.\n", val);

      printf("Total download time: %" CURL_FORMAT_CURL_OFF_T ".%06ld sec.\n",

             (val / 1000000), (long)(val % 1000000));



    /* check for average download speed */

    res = curl_easy_getinfo(curl_handle, CURLINFO_SPEED_DOWNLOAD, &val);

    res = curl_easy_getinfo(curl_handle, CURLINFO_SPEED_DOWNLOAD_T, &val);

    if((CURLE_OK == res) && (val>0))

      printf("Average download speed: %0.3f kbyte/sec.\n", val / 1024);

      printf("Average download speed: %" CURL_FORMAT_CURL_OFF_T

             " kbyte/sec.\n", val / 1024);



    if(prtall) {

      /* check for name resolution time */

      res = curl_easy_getinfo(curl_handle, CURLINFO_NAMELOOKUP_TIME, &val);

      res = curl_easy_getinfo(curl_handle, CURLINFO_NAMELOOKUP_TIME_T, &val);

      if((CURLE_OK == res) && (val>0))

        printf("Name lookup time: %0.3f sec.\n", val);

        printf("Name lookup time: %" CURL_FORMAT_CURL_OFF_T ".%06ld sec.\n",

               (val / 1000000), (long)(val % 1000000));



      /* check for connect time */

      res = curl_easy_getinfo(curl_handle, CURLINFO_CONNECT_TIME, &val);

      res = curl_easy_getinfo(curl_handle, CURLINFO_CONNECT_TIME_T, &val);

      if((CURLE_OK == res) && (val>0))

        printf("Connect time: %0.3f sec.\n", val);

        printf("Connect time: %" CURL_FORMAT_CURL_OFF_T ".%06ld sec.\n",

               (val / 1000000), (long)(val % 1000000));

    }

  }

  else {

docs/examples/fileupload.c

+7 −5
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ int main(void) 
  CURL *curl;

  CURLcode res;

  struct stat file_info;

  double speed_upload, total_time;

  curl_off_t speed_upload, total_time;

  FILE *fd;



  fd = fopen("debugit", "rb"); /* open file to upload */
@@ -72,11 +72,13 @@ int main(void) 
    }

    else {

      /* now extract transfer info */

      curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD, &speed_upload);

      curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME, &total_time);

      curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD_T, &speed_upload);

      curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME_T, &total_time);



      fprintf(stderr, "Speed: %.3f bytes/sec during %.3f seconds\n",

              speed_upload, total_time);

      fprintf(stderr, "Speed: %" CURL_FORMAT_CURL_OFF_T " bytes/sec during %"

              CURL_FORMAT_CURL_OFF_T ".%06ld seconds\n",

              speed_upload,

              (total_time / 1000000), (long)(total_time % 1000000));



    }

    /* always cleanup */

docs/examples/progressfunc.c

+6 −5
Original line number Diff line number Diff line
@@ -28,10 +28,10 @@ 
#include <curl/curl.h>



#define STOP_DOWNLOAD_AFTER_THIS_MANY_BYTES         6000

#define MINIMAL_PROGRESS_FUNCTIONALITY_INTERVAL     3

#define MINIMAL_PROGRESS_FUNCTIONALITY_INTERVAL     3000000



struct myprogress {

  double lastruntime;

  curl_off_t lastruntime;

  CURL *curl;

};
@@ -42,16 +42,17 @@ static int xferinfo(void *p, 
{

  struct myprogress *myp = (struct myprogress *)p;

  CURL *curl = myp->curl;

  double curtime = 0;

  curl_off_t curtime = 0;



  curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME, &curtime);

  curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME_T, &curtime);



  /* under certain circumstances it may be desirable for certain functionality

     to only run every N seconds, in order to do this the transaction time can

     be used */

  if((curtime - myp->lastruntime) >= MINIMAL_PROGRESS_FUNCTIONALITY_INTERVAL) {

    myp->lastruntime = curtime;

    fprintf(stderr, "TOTAL TIME: %f \r\n", curtime);

    fprintf(stderr, "TOTAL TIME: %" CURL_FORMAT_CURL_OFF_T ".%06ld\r\n",

            (curtime / 1000000), (long)(curtime % 1000000));

  }



  fprintf(stderr, "UP: %" CURL_FORMAT_CURL_OFF_T " of %" CURL_FORMAT_CURL_OFF_T

docs/libcurl/curl_easy_getinfo.3

+37 −9
Original line number Diff line number Diff line
@@ -60,24 +60,45 @@ Remote time of the retrieved document. See \fICURLINFO_FILETIME_T(3)\fP 
.IP CURLINFO_TOTAL_TIME

Total time of previous transfer.

See \fICURLINFO_TOTAL_TIME(3)\fP

.IP CURLINFO_TOTAL_TIME_T

Total time of previous transfer.

See \fICURLINFO_TOTAL_TIME_T(3)\fP

.IP CURLINFO_NAMELOOKUP_TIME

Time from start until name resolving completed.

See \fICURLINFO_NAMELOOKUP_TIME(3)\fP

.IP CURLINFO_NAMELOOKUP_TIME_T

Time from start until name resolving completed.

See \fICURLINFO_NAMELOOKUP_TIME_T(3)\fP

.IP CURLINFO_CONNECT_TIME

Time from start until remote host or proxy completed.

See \fICURLINFO_CONNECT_TIME(3)\fP

.IP CURLINFO_CONNECT_TIME_T

Time from start until remote host or proxy completed.

See \fICURLINFO_CONNECT_TIME_T(3)\fP

.IP CURLINFO_APPCONNECT_TIME

Time from start until SSL/SSH handshake completed.

See \fICURLINFO_APPCONNECT_TIME(3)\fP

.IP CURLINFO_APPCONNECT_TIME_T

Time from start until SSL/SSH handshake completed.

See \fICURLINFO_APPCONNECT_TIME_T(3)\fP

.IP CURLINFO_PRETRANSFER_TIME

Time from start until just before the transfer begins.

See \fICURLINFO_PRETRANSFER_TIME(3)\fP

.IP CURLINFO_PRETRANSFER_TIME_T

Time from start until just before the transfer begins.

See \fICURLINFO_PRETRANSFER_TIME_T(3)\fP

.IP CURLINFO_STARTTRANSFER_TIME

Time from start until just when the first byte is received.

See \fICURLINFO_STARTTRANSFER_TIME(3)\fP

.IP CURLINFO_STARTTRANSFER_TIME_T

Time from start until just when the first byte is received.

See \fICURLINFO_STARTTRANSFER_TIME_T(3)\fP

.IP CURLINFO_REDIRECT_TIME

Time taken for all redirect steps before the final transfer.

See \fICURLINFO_REDIRECT_TIME(3)\fP

.IP CURLINFO_REDIRECT_TIME_T

Time taken for all redirect steps before the final transfer.

See \fICURLINFO_REDIRECT_TIME_T(3)\fP

.IP CURLINFO_REDIRECT_COUNT

Total number of redirects that were followed.

See \fICURLINFO_REDIRECT_COUNT(3)\fP
@@ -221,25 +242,32 @@ curl_easy_perform() 
    |--|--|--|--|--|--REDIRECT

.fi

.IP NAMELOOKUP

\fICURLINFO_NAMELOOKUP_TIME\fP. The time it took from the start until the name

resolving was completed.

\fICURLINFO_NAMELOOKUP_TIME\fP and \fIfICURLINFO_NAMELOOKUP_TIME_T\fP.

The time it took from the start until the name resolving was completed.

.IP CONNECT

\fICURLINFO_CONNECT_TIME\fP. The time it took from the start until the connect

\fICURLINFO_CONNECT_TIME\fP and \fICURLINFO_CONNECT_TIME_T\fP.

The time it took from the start until the connect

to the remote host (or proxy) was completed.

.IP APPCONNECT

\fICURLINFO_APPCONNECT_TIME\fP. The time it took from the start until the SSL

connect/handshake with the remote host was completed. (Added in in 7.19.0)

\fICURLINFO_APPCONNECT_TIME\fP and \fICURLINFO_APPCONNECT_TIME_T\fP.

The time it took from the start until the SSL

connect/handshake with the remote host was completed. (Added in 7.19.0)

The latter is the integer version (measuring microseconds).  (Added in 7.60.0)

.IP PRETRANSFER

\fICURLINFO_PRETRANSFER_TIME\fP. The time it took from the start until the

\fICURLINFO_PRETRANSFER_TIME\fP and \fICURLINFO_PRETRANSFER_TIME_T\fP.

The time it took from the start until the

file transfer is just about to begin. This includes all pre-transfer commands

and negotiations that are specific to the particular protocol(s) involved.

.IP STARTTRANSFER

\fICURLINFO_STARTTRANSFER_TIME\fP. The time it took from the start until the

\fICURLINFO_STARTTRANSFER_TIME\fP and \fICURLINFO_STARTTRANSFER_TIME_T\fP.

The time it took from the start until the

first byte is received by libcurl.

.IP TOTAL

\fICURLINFO_TOTAL_TIME\fP. Total time of the previous request.

\fICURLINFO_TOTAL_TIME\fP and \fICURLINFO_TOTAL_TIME_T\fP.

Total time of the previous request.

.IP REDIRECT

\fICURLINFO_REDIRECT_TIME\fP. The time it took for all redirection steps

\fICURLINFO_REDIRECT_TIME\fP and \fICURLINFO_REDIRECT_TIME_T\fP.

The time it took for all redirection steps

include name lookup, connect, pretransfer and transfer before final

transaction was started. So, this is zero if no redirection took place.

.SH RETURN VALUE

docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3

+1 −1
Original line number Diff line number Diff line
@@ -59,4 +59,4 @@ Added in 7.19.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 curl_easy_getinfo "(3), " curl_easy_setopt "(3), " CURLINFO_APPCONNECT_TIME_T "(3)"