curl_multi_info_read.3
上传用户:coffee44
上传日期:2018-10-23
资源大小:12304k
文件大小:2k
源码类别:

TAPI编程

开发平台:

Visual C++

  1. ." $Id: curl_multi_info_read.3,v 1.10 2008-12-28 21:56:56 bagder Exp $
  2. ."
  3. .TH curl_multi_info_read 3 "18 Dec 2004" "libcurl 7.10.3" "libcurl Manual"
  4. .SH NAME
  5. curl_multi_info_read - read multi stack informationals
  6. .SH SYNOPSIS
  7. #include <curl/curl.h>
  8. CURLMsg *curl_multi_info_read( CURLM *multi_handle,
  9.                                int *msgs_in_queue);
  10. .ad
  11. .SH DESCRIPTION
  12. Ask the multi handle if there are any messages/informationals from the
  13. individual transfers. Messages may include informationals such as an error
  14. code from the transfer or just the fact that a transfer is completed. More
  15. details on these should be written down as well.
  16. Repeated calls to this function will return a new struct each time, until a
  17. NULL is returned as a signal that there is no more to get at this point. The
  18. integer pointed to with fImsgs_in_queuefP will contain the number of
  19. remaining messages after this function was called.
  20. When you fetch a message using this function, it is removed from the internal
  21. queue so calling this function again will not return the same message
  22. again. It will instead return new messages at each new invoke until the queue
  23. is emptied.
  24. fBWARNING:fP The data the returned pointer points to will not survive
  25. calling fIcurl_multi_cleanup(3)fP, fIcurl_multi_remove_handle(3)fP or
  26. fIcurl_easy_cleanup(3)fP.
  27. The 'CURLMsg' struct is very simple and only contains very basic information.
  28. If more involved information is wanted, the particular "easy handle" in
  29. present in that struct and can thus be used in subsequent regular
  30. fIcurl_easy_getinfo(3)fP calls (or similar):
  31. .NF
  32.  struct CURLMsg {
  33.    CURLMSG msg;       /* what this message means */
  34.    CURL *easy_handle; /* the handle it concerns */
  35.    union {
  36.      void *whatever;    /* message-specific data */
  37.      CURLcode result;   /* return code for transfer */
  38.    } data;
  39.  };
  40. When fBmsgfP is fICURLMSG_DONEfP, the message identifies a transfer that
  41. is done, and then fBresultfP contains the return code for the easy handle
  42. that just completed.
  43. At this point, there are no other fBmsgfP types defined.
  44. .SH "RETURN VALUE"
  45. A pointer to a filled-in struct, or NULL if it failed or ran out of
  46. structs. It also writes the number of messages left in the queue (after this
  47. read) in the integer the second argument points to.
  48. .SH "SEE ALSO"
  49. .BR curl_multi_cleanup "(3), " curl_multi_init "(3), " curl_multi_perform "(3)"