Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_PRETRANSFER_TIME_T (3)

Name

CURLINFO_PRETRANSFER_TIME_T - get the time until the file transfer start

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL  *handle,  CURLINFO_PRETRANSFER_TIME_T,
curl_off_t *timep);

Description

curl_easy_getinfo options                       CURLINFO_PRETRANSFER_TIME_T(3)



NAME
       CURLINFO_PRETRANSFER_TIME_T  -  get  the  time  until the file transfer
       start

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL  *handle,  CURLINFO_PRETRANSFER_TIME_T,
       curl_off_t *timep);

DESCRIPTION
       Pass a pointer to a curl_off_t to receive the time, in microseconds, it
       took from the start until the file transfer is  just  about  to  begin.
       This  includes all pre-transfer commands and negotiations that are spe-
       cific to the particular protocol(s) involved. It does not  involve  the
       sending of the protocol- specific request that triggers a transfer.

       See also the TIMES overview in the curl_easy_getinfo(3) man page.

PROTOCOLS
       All

EXAMPLE
       curl = curl_easy_init();
       if(curl) {
         curl_off_t pretransfer;
         curl_easy_setopt(curl, CURLOPT_URL, url);
         res = curl_easy_perform(curl);
         if(CURLE_OK == res) {
           res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME_T, &pretransfer);
           if(CURLE_OK == res) {
             printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", pretransfer / 1000000,
                    (long)(pretransfer % 1000000));
           }
         }
         /* always cleanup */
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.61.0

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3), CURLINFO_PRETRANSFER_TIME(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.61.0                    28 Apr 2018
                                                CURLINFO_PRETRANSFER_TIME_T(3)