aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJay Satiro <raysatiro@yahoo.com>2015-09-25 02:37:42 -0400
committerJay Satiro <raysatiro@yahoo.com>2015-09-25 02:37:42 -0400
commit095fe60e27f255ca5c3f84d4212b5d76b6fa482c (patch)
treedaf1eee14e767a996bd9565785c3e4c078f4b293 /docs
parent4d60e125de85fca8d91ef8b4662736d6872a0851 (diff)
curl_easy_getinfo.3: Add brief description for each CURLINFO
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_easy_getinfo.389
1 files changed, 89 insertions, 0 deletions
diff --git a/docs/libcurl/curl_easy_getinfo.3 b/docs/libcurl/curl_easy_getinfo.3
index 542014c26..9050778f4 100644
--- a/docs/libcurl/curl_easy_getinfo.3
+++ b/docs/libcurl/curl_easy_getinfo.3
@@ -41,94 +41,183 @@ You should not free the memory returned by this function unless it is
explicitly mentioned below.
.SH AVAILABLE INFORMATION
The following information can be extracted:
+
.IP CURLINFO_EFFECTIVE_URL
+Last used URL.
See \fICURLINFO_EFFECTIVE_URL(3)\fP
+
.IP CURLINFO_RESPONSE_CODE
+Last received response code.
See \fICURLINFO_RESPONSE_CODE(3)\fP
+
.IP CURLINFO_HTTP_CONNECTCODE
+Last proxy CONNECT response code.
See \fICURLINFO_HTTP_CONNECTCODE(3)\fP
+
.IP CURLINFO_FILETIME
+Remote time of the retrieved document.
See \fICURLINFO_FILETIME(3)\fP
+
.IP CURLINFO_TOTAL_TIME
+Total time of previous transfer.
See \fICURLINFO_TOTAL_TIME(3)\fP
+
.IP CURLINFO_NAMELOOKUP_TIME
+Time from start until name resolving completed.
See \fICURLINFO_NAMELOOKUP_TIME(3)\fP
+
.IP CURLINFO_CONNECT_TIME
+Time from start until remote host or proxy completed.
See \fICURLINFO_CONNECT_TIME(3)\fP
+
.IP CURLINFO_APPCONNECT_TIME
+Time from start until SSL/SSH handshake completed.
See \fICURLINFO_APPCONNECT_TIME(3)\fP
+
.IP CURLINFO_PRETRANSFER_TIME
+Time from start until just before the transfer begins.
See \fICURLINFO_PRETRANSFER_TIME(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_REDIRECT_TIME
+Time taken for all redirect steps before the final transfer.
See \fICURLINFO_REDIRECT_TIME(3)\fP
+
.IP CURLINFO_REDIRECT_COUNT
+Total number of redirects that were followed.
See \fICURLINFO_REDIRECT_COUNT(3)\fP
+
.IP CURLINFO_REDIRECT_URL
+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.
See \fICURLINFO_SIZE_UPLOAD(3)\fP
+
.IP CURLINFO_SIZE_DOWNLOAD
+Number of bytes downloaded.
See \fICURLINFO_SIZE_DOWNLOAD(3)\fP
+
.IP CURLINFO_SPEED_DOWNLOAD
+Average download speed.
See \fICURLINFO_SPEED_DOWNLOAD(3)\fP
+
.IP CURLINFO_SPEED_UPLOAD
+Average upload speed.
See \fICURLINFO_SPEED_UPLOAD(3)\fP
+
.IP CURLINFO_HEADER_SIZE
+Number of bytes of all headers received.
See \fICURLINFO_HEADER_SIZE(3)\fP
+
.IP CURLINFO_REQUEST_SIZE
+Number of bytes sent in the issued HTTP requests.
See \fICURLINFO_REQUEST_SIZE(3)\fP
+
.IP CURLINFO_SSL_VERIFYRESULT
+Certificate verification result.
See \fICURLINFO_SSL_VERIFYRESULT(3)\fP
+
.IP CURLINFO_SSL_ENGINES
+A list of OpenSSL crypto engines.
See \fICURLINFO_SSL_ENGINES(3)\fP
+
.IP CURLINFO_CONTENT_LENGTH_DOWNLOAD
+Content length from the Content-Length header.
See \fICURLINFO_CONTENT_LENGTH_DOWNLOAD(3)\fP
+
.IP CURLINFO_CONTENT_LENGTH_UPLOAD
+Upload size.
See \fICURLINFO_CONTENT_LENGTH_UPLOAD(3)\fP
+
.IP CURLINFO_CONTENT_TYPE
+Content type from the Content-Type header.
See \fICURLINFO_CONTENT_TYPE(3)\fP
+
.IP CURLINFO_PRIVATE
+User's private data pointer.
See \fICURLINFO_PRIVATE(3)\fP
+
.IP CURLINFO_HTTPAUTH_AVAIL
+Available HTTP authentication methods.
See \fICURLINFO_HTTPAUTH_AVAIL(3)\fP
+
.IP CURLINFO_PROXYAUTH_AVAIL
+Available HTTP proxy authentication methods.
See \fICURLINFO_PROXYAUTH_AVAIL(3)\fP
+
.IP CURLINFO_OS_ERRNO
+The errno from the last failure to connect.
See \fICURLINFO_OS_ERRNO(3)\fP
+
.IP CURLINFO_NUM_CONNECTS
+Number of new successful connections used for previous transfer.
See \fICURLINFO_NUM_CONNECTS(3)\fP
+
.IP CURLINFO_PRIMARY_IP
+IP address of the last connection.
See \fICURLINFO_PRIMARY_IP(3)\fP
+
.IP CURLINFO_PRIMARY_PORT
+Port of the last connection.
See \fICURLINFO_PRIMARY_PORT(3)\fP
+
.IP CURLINFO_LOCAL_IP
+Local-end IP address of last connection.
See \fICURLINFO_LOCAL_IP(3)\fP
+
.IP CURLINFO_LOCAL_PORT
+Local-end port of last connection.
See \fICURLINFO_LOCAL_PORT(3)\fP
+
.IP CURLINFO_COOKIELIST
+List of all known cookies.
See \fICURLINFO_COOKIELIST(3)\fP
+
.IP CURLINFO_LASTSOCKET
+Last socket used.
See \fICURLINFO_LASTSOCKET(3)\fP
+
.IP CURLINFO_ACTIVESOCKET
+The session's active socket.
See \fICURLINFO_ACTIVESOCKET(3)\fP
+
.IP CURLINFO_FTP_ENTRY_PATH
+The entry path after logging in to an FTP server.
See \fICURLINFO_FTP_ENTRY_PATH(3)\fP
+
.IP CURLINFO_CERTINFO
+Certificate chain.
See \fICURLINFO_CERTINFO(3)\fP
+
.IP CURLINFO_TLS_SESSION
+TLS session info that can be used for further processing.
See \fICURLINFO_TLS_SESSION(3)\fP
+
.IP CURLINFO_CONDITION_UNMET
+Whether or not a time conditional was met.
See \fICURLINFO_CONDITION_UNMET(3)\fP
+
.IP CURLINFO_RTSP_SESSION_ID
+RTSP session ID.
See \fICURLINFO_RTSP_SESSION_ID(3)\fP
+
.IP CURLINFO_RTSP_CLIENT_CSEQ
+RTSP CSeq that will next be used.
See \fICURLINFO_RTSP_CLIENT_CSEQ(3)\fP
+
.IP CURLINFO_RTSP_SERVER_CSEQ
+RTSP CSeq that will next be expected.
See \fICURLINFO_RTSP_SERVER_CSEQ(3)\fP
+
.IP CURLINFO_RTSP_CSEQ_RECV
+RTSP CSeq last received.
See \fICURLINFO_RTSP_CSEQ_RECV(3)\fP
+
.SH TIMES
.nf
An overview of the six time values available from curl_easy_getinfo()