1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 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.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.
- .\" *
- .\" * SPDX-License-Identifier: curl
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLINFO_APPCONNECT_TIME_T 3 "28 Apr 2018" "libcurl" "libcurl"
- .SH NAME
- CURLINFO_APPCONNECT_TIME_T \- time until the SSL/SSH handshake completed
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME_T,
- curl_off_t *timep);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a curl_off_t to receive the time, in microseconds, it took
- from the start until the SSL/SSH connect/handshake to the remote host was
- completed. This time is most often close to the
- \fICURLINFO_PRETRANSFER_TIME_T(3)\fP time, except for cases such as HTTP
- pipelining where the pretransfer time can be delayed due to waits in line for
- the pipeline and more.
- When a redirect is followed, the time from each request is added together.
- See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
- .SH PROTOCOLS
- All
- .SH EXAMPLE
- .nf
- curl = curl_easy_init();
- if(curl) {
- curl_off_t connect;
- curl_easy_setopt(curl, CURLOPT_URL, url);
- res = curl_easy_perform(curl);
- if(CURLE_OK == res) {
- res = curl_easy_getinfo(curl, CURLINFO_APPCONNECT_TIME_T, &connect);
- if(CURLE_OK == res) {
- printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", connect / 1000000,
- (long)(connect % 1000000));
- }
- }
- /* always cleanup */
- curl_easy_cleanup(curl);
- }
- .fi
- .SH AVAILABILITY
- Added in 7.61.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), " CURLINFO_APPCONNECT_TIME "(3)"
|