~ubuntu-branches/ubuntu/gutsy/curl/gutsy

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_getinfo.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-06-29 15:04:24 UTC
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20060629150424-be178abcwks1n519
Tags: upstream-7.15.4
ImportĀ upstreamĀ versionĀ 7.15.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" You can view this file with:
2
 
.\" nroff -man [file]
3
 
.\" $Id: curl_easy_getinfo.3,v 1.24 2005/10/06 09:03:36 bagder Exp $
 
1
.\" **************************************************************************
 
2
.\" *                                  _   _ ____  _
 
3
.\" *  Project                     ___| | | |  _ \| |
 
4
.\" *                             / __| | | | |_) | |
 
5
.\" *                            | (__| |_| |  _ <| |___
 
6
.\" *                             \___|\___/|_| \_\_____|
 
7
.\" *
 
8
.\" * Copyright (C) 1998 - 2006, Daniel Stenberg, <daniel@haxx.se>, et al.
 
9
.\" *
 
10
.\" * This software is licensed as described in the file COPYING, which
 
11
.\" * you should have received as part of this distribution. The terms
 
12
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
 
13
.\" *
 
14
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
 
15
.\" * copies of the Software, and permit persons to whom the Software is
 
16
.\" * furnished to do so, under the terms of the COPYING file.
 
17
.\" *
 
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 
19
.\" * KIND, either express or implied.
 
20
.\" *
 
21
.\" * $Id: curl_easy_getinfo.3,v 1.29 2006-06-08 11:06:26 bagder Exp $
 
22
.\" **************************************************************************
4
23
.\"
5
 
.TH curl_easy_getinfo 3 "6 Oct 2005" "libcurl 7.12.3" "libcurl Manual"
 
24
.TH curl_easy_getinfo 3 "21 Mar 2006" "libcurl 7.15.4" "libcurl Manual"
6
25
.SH NAME
7
26
curl_easy_getinfo - extract information from a curl handle
8
27
.SH SYNOPSIS
44
63
to \fIcurl_easy_setopt(3)\fP or you will unconditionally get a -1 back. (Added
45
64
in 7.5)
46
65
.IP CURLINFO_TOTAL_TIME
47
 
Pass a pointer to a double to receive the total transaction time in seconds
48
 
for the previous transfer. This time does not include the connect time, so if
49
 
you want the complete operation time, you should add the
50
 
CURLINFO_CONNECT_TIME.
 
66
Pass a pointer to a double to receive the total time in seconds for the
 
67
previous transfer, including name resolving, TCP connect etc.
51
68
.IP CURLINFO_NAMELOOKUP_TIME
52
69
Pass a pointer to a double to receive the time, in seconds, it took from the
53
70
start until the name resolving was completed.
141
158
cookies (cookies for the handle have not been enabled or simply none have been
142
159
received) 'struct curl_slist *' will be set to point to NULL. (Added in
143
160
7.14.1)
 
161
.IP CURLINFO_LASTSOCKET
 
162
Pass a pointer to a long to receive the last socket used by this curl
 
163
session. If the socket is no longer valid, -1 is returned. When you finish
 
164
working with the socket, you must call curl_easy_cleanup() as usual and let
 
165
libcurl close the socket and cleanup other resources associated with the
 
166
handle. This is typically used in combination with \fICURLOPT_CONNECT_ONLY\fP.
 
167
(Added in 7.15.2)
 
168
.IP CURLINFO_FTP_ENTRY_PATH
 
169
Pass a pointer to a 'char *' to receive a pointer to a string holding the path
 
170
of the entry path. That is the initial path libcurl ended up in when logging
 
171
on to the remote FTP server. This stores a NULL as pointer if something is
 
172
wrong. (Added in 7.15.4)
144
173
.SH TIMES
145
174
.NF
146
175
An overview of the six time values available from curl_easy_getinfo()
147
176
 
148
 
curk_easy_perform()
 
177
curl_easy_perform()
149
178
    |
150
179
    |--NT
151
180
    |--|--CT
152
181
    |--|--|--PT
153
182
    |--|--|--|--ST
154
 
          |--|--|--TT
 
183
    |--|--|--|--|--TT
155
184
    |--|--|--|--|--RT
156
185
.FI
157
186
.IP NT
168
197
\fICURLINFO_STARTTRANSFER_TIME\fP. The time it took from the start until the
169
198
first byte is just about to be transferred.
170
199
.IP TT
171
 
\fICURLINFO_TOTAL_TIME\fP. Time of the previous transfer. This time does not
172
 
include the connect time (CT), so if you want the complete operation time, you
173
 
should add that.
 
200
\fICURLINFO_TOTAL_TIME\fP. Total time of the previous request.
174
201
.IP RT
175
202
\fICURLINFO_REDIRECT_TIME\fP. The time it took for all redirection steps
176
203
include name lookup, connect, pretransfer and transfer before final