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. Mes-
sages may include informationals such as an error code from
the transfer or just the fact that a transfer is completed.
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.
When you fetch a message using this function, it is removed
from the internal queue so calling this function again will
not return the same message again. It will instead return
new messages at each new invoke until the queue is emptied.
WARNING: The data the returned pointer points to will not
survive calling curlmulticleanup(3),
curlmultiremovehandle(3) or curleasycleanup(3).
The 'CURLMsg' struct is very simple and only contains very
basic information. 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;
};
When msg is CURLMSGDONE, the message identifies a transfer
that is done, and then result contains the return code for
the easy handle that just completed.
At this point, there are no other msg types defined.
libcurl 7.10.3 Last change: 18 Dec 2004 1
libcurl Manual curlmultiinforead(3)
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)
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWcurl
Interface Stability Uncommitted
NOTES
Source for C-URL is available on http:/opensolaris.org.
libcurl 7.10.3 Last change: 18 Dec 2004 2
|