~ubuntu-branches/ubuntu/maverick/curl/maverick

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_getinfo.3

  • Committer: Bazaar Package Importer
  • Author(s): Bhavani Shankar
  • Date: 2010-06-20 13:56:28 UTC
  • mfrom: (3.4.7 sid)
  • Revision ID: james.westby@ubuntu.com-20100620135628-e30tp9jldq6hq985
Tags: 7.21.0-1ubuntu1
* Merge from debian unstable.  Remaining changes: LP: #596334
  - Keep build deps in main:
    - Drop build dependencies: stunnel, libssh2-1-dev
    - Add build-dependency on openssh-server
    - Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
5
5
.\" *                            | (__| |_| |  _ <| |___
6
6
.\" *                             \___|\___/|_| \_\_____|
7
7
.\" *
8
 
.\" * Copyright (C) 1998 - 2009, Daniel Stenberg, <daniel@haxx.se>, et al.
 
8
.\" * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
9
9
.\" *
10
10
.\" * This software is licensed as described in the file COPYING, which
11
11
.\" * you should have received as part of this distribution. The terms
18
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
19
.\" * KIND, either express or implied.
20
20
.\" *
21
 
.\" * $Id: curl_easy_getinfo.3,v 1.43 2009-07-15 11:49:13 mmarek Exp $
22
21
.\" **************************************************************************
23
22
.\"
24
23
.TH curl_easy_getinfo 3 "11 Feb 2009" "libcurl 7.19.4" "libcurl Manual"
174
173
\fBcurl\fP handle. This string may be IPv6 if that's enabled. Note that you
175
174
get a pointer to a memory area that will be re-used at next request so you
176
175
need to copy the string if you want to keep the information. (Added in 7.19.0)
 
176
.IP CURLINFO_PRIMARY_PORT
 
177
Pass a pointer to a long to receive the destination port of the most recent
 
178
connection done with this \fBcurl\fP handle. (Added in 7.21.0)
 
179
.IP CURLINFO_LOCAL_IP
 
180
Pass a pointer to a char pointer to receive the pointer to a zero-terminated
 
181
string holding the local (source) IP address of the most recent connection done
 
182
with this \fBcurl\fP handle. This string may be IPv6 if that's enabled. The
 
183
same restrictions apply as to \fICURLINFO_PRIMARY_IP\fP. (Added in 7.21.0)
 
184
.IP CURLINFO_LOCAL_PORT
 
185
Pass a pointer to a long to receive the local (source) port of the most recent
 
186
connection done with this \fBcurl\fP handle. (Added in 7.21.0)
177
187
.IP CURLINFO_COOKIELIST
178
188
Pass a pointer to a 'struct curl_slist *' to receive a linked-list of all
179
189
cookies cURL knows (expired ones, too). Don't forget to
209
219
this returns a 1 you know that the reason you didn't get data in return is
210
220
because it didn't fulfill the condition. The long ths argument points to will
211
221
get a zero stored if the condition instead was met. (Added in 7.19.4)
 
222
.IP CURLINFO_RTSP_SESSION_ID
 
223
Pass a pointer to a char pointer to receive a pointer to a string holding the
 
224
most recent RTSP Session ID.
 
225
 
 
226
Applications wishing to resume an RTSP session on another connection should
 
227
retreive this info before closing the active connection.
 
228
.IP CURLINFO_RTSP_CLIENT_CSEQ
 
229
Pass a pointer to a long to receive the next CSeq that will be used by the
 
230
application.
 
231
.IP CURLINFO_RTSP_SERVER_CSEQ
 
232
Pass a pointer to a long to receive the next server CSeq that will be expected
 
233
by the application.
 
234
 
 
235
\fI(NOTE: listening for server initiated requests is currently
 
236
unimplemented).\fP
 
237
 
 
238
Applications wishing to resume an RTSP session on another connection should
 
239
retreive this info before closing the active connection.
 
240
.IP CURLINFO_RTSP_CSEQ_RECV
 
241
Pass a pointer to a long to receive the most recently received CSeq from the
 
242
server. If your application encounters a \fICURLE_RTSP_CSEQ_ERROR\fP then you
 
243
may wish to troubleshoot and/or fix the CSeq mismatch by peeking at this value.
212
244
.SH TIMES
213
245
.nf
214
246
An overview of the six time values available from curl_easy_getinfo()