Skip to content
Snippets Groups Projects
Commit 248eb473 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

Updated to better reflect reality. Also displays how the CURLMsg struct

looks like.
parent 52ebf506
No related branches found
No related tags found
No related merge requests found
.\" $Id$ .\" $Id$
.\" .\"
.TH curl_multi_info_read 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual" .TH curl_multi_info_read 3 "27 Feb 2002" "libcurl 7.10.3" "libcurl Manual"
.SH NAME .SH NAME
curl_multi_info_read - read multi stack informationals curl_multi_info_read - read multi stack informationals
.SH SYNOPSIS .SH SYNOPSIS
...@@ -10,15 +10,15 @@ CURLMsg *curl_multi_info_read( CURLM *multi_handle, ...@@ -10,15 +10,15 @@ CURLMsg *curl_multi_info_read( CURLM *multi_handle,
int *msgs_in_queue); int *msgs_in_queue);
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
Ask the multi handle if there's any messages/informationals from the Ask the multi handle if there are any messages/informationals from the
individual transfers. Messages include informationals such as an error code individual transfers. Messages may include informationals such as an error
from the transfer or just the fact that a transfer is completed. More details code from the transfer or just the fact that a transfer is completed. More
on these should be written down as well. details on these should be written down as well.
Repeated calls to this function will return a new struct each time, until a Repeated calls to this function will return a new struct each time, until a
special "end of msgs" struct is returned as a signal that there is no more to NULL is returned as a signal that there is no more to get at this point. The
get at this point. The integer pointed to with \fImsgs_in_queue\fP will integer pointed to with \fImsgs_in_queue\fP will contain the number of
contain the number of remaining messages after this function was called. remaining messages after this function was called.
The data the returned pointer points to will not survive calling The data the returned pointer points to will not survive calling
curl_multi_cleanup(). curl_multi_cleanup().
...@@ -26,10 +26,19 @@ curl_multi_cleanup(). ...@@ -26,10 +26,19 @@ curl_multi_cleanup().
The 'CURLMsg' struct is very simple and only contain very basic informations. The 'CURLMsg' struct is very simple and only contain very basic informations.
If more involved information is wanted, the particular "easy handle" in If more involved information is wanted, the particular "easy handle" in
present in that struct and can thus be used in subsequent regular present in that struct and can thus be used in subsequent regular
curl_easy_getinfo() calls (or similar). curl_easy_getinfo() calls (or similar):
struct CURLMsg {
CURLMSG msg; /* what this message means */
CURL *easy_handle; /* the handle it concerns */
union {
void *whatever; /* message-specific data */
CURLcode result; /* return code for transfer */
} data;
};
.SH "RETURN VALUE" .SH "RETURN VALUE"
A pointer to a filled-in struct, or NULL if it failed or ran out of A pointer to a filled-in struct, or NULL if it failed or ran out of
structs. It also writes the number of messages left in the queue (after this structs. It also writes the number of messages left in the queue (after this
read) in the integer the second argument points to. read) in the integer the second argument points to.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR curl_multi_cleanup "(3)," curl_multi_init "(3)," curl_multi_perform "(3)" .BR curl_multi_cleanup "(3), " curl_multi_init "(3), " curl_multi_perform "(3)"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment