curl_multi_info_read.3
上传用户:coffee44
上传日期:2018-10-23
资源大小:12304k
文件大小:2k
源码类别:
TAPI编程
开发平台:
Visual C++
- ." $Id: curl_multi_info_read.3,v 1.10 2008-12-28 21:56:56 bagder Exp $
- ."
- .TH curl_multi_info_read 3 "18 Dec 2004" "libcurl 7.10.3" "libcurl Manual"
- .SH NAME
- curl_multi_info_read - read multi stack informationals
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLMsg *curl_multi_info_read( CURLM *multi_handle,
- int *msgs_in_queue);
- .ad
- .SH 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 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
- NULL is returned as a signal that there is no more to get at this point. The
- integer pointed to with fImsgs_in_queuefP 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.
- fBWARNING:fP The data the returned pointer points to will not survive
- calling fIcurl_multi_cleanup(3)fP, fIcurl_multi_remove_handle(3)fP or
- fIcurl_easy_cleanup(3)fP.
- 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
- fIcurl_easy_getinfo(3)fP calls (or similar):
- .NF
- 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;
- };
- When fBmsgfP is fICURLMSG_DONEfP, the message identifies a transfer that
- is done, and then fBresultfP contains the return code for the easy handle
- that just completed.
- At this point, there are no other fBmsgfP types defined.
- .SH "RETURN VALUE"
- 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
- read) in the integer the second argument points to.
- .SH "SEE ALSO"
- .BR curl_multi_cleanup "(3), " curl_multi_init "(3), " curl_multi_perform "(3)"