curlmultiinforead(3) libcurl Manual curlmultiinforead(3)
NAME
curlmultiinforead - read multi stack informationals
SYNOPSIS
#include
CURLMsg *curlmultiinforead( CURLM *multihandle,
int *msgsinqueue);
DESCRIPTION
Ask the multi handle if there are any messages/informationals from the
individual transfers. Messages may include informationals such as an
error code from the transfer or just the fact that a transfer is com-
pleted. More details on these should be written down as well.
Repeated calls to this function will return a new struct each time,
until a NUL is returned as a signal that there is no more to get at
this point. The integer pointed to with msgsinqueue will contain the
number of remaining messages after this function was called.
The data the returned pointer points to will not survive calling
curlmulticleanup(3) or curlmultiremovehandle(3).
The 'CURLMsg' struct is very simple and only contain very basic infor-
mation. If more involved information is wanted, the particular "easy
handle" in present in that struct and can thus be used in subsequent
regular curleasygetinfo(3) calls (or similar):
struct CURLMsg {
CURLMSG msg; /* what this message means */
CURL *easyhandle; /* the handle it concerns */
union {
void *whatever; /* message-specific data */
CURLcode result; /* return code for transfer */
} data;
};
RETURN VALUE
A pointer to a filled-in struct, or NUL if it failed or ran out of
structs. It also writes the number of messages left in the queue (after
this read) in the integer the second argument points to.
SEE ALSO
curlmulticleanup(3), curlmultiinit(3), curlmultiperform(3)
libcurl 7.10.3 18 Dec 2004 curlmultiinforead(3)
|