← Back to branch summary

~ubuntu-branches/ubuntu/utopic/curl/utopic-updates

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_multi_info_read.html

  • Committer: Bazaar Package Importer
  • Author(s): James Page
  • Date: 2011-10-20 09:28:24 UTC
  • mfrom: (3.4.22 sid)
  • Revision ID: james.westby@ubuntu.com-20111020092824-i7kfjd5we7dh57nv
Tags: 7.21.7-3ubuntu1
https://launchpad.net/bugs/831496
* Merge from Debian testing, remaining changes:
  - Drop dependencies not in main:
    + Build-Depends: Drop stunnel and libssh2-1-dev.
    + Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.
  - Add new libcurl3-udeb package, stripped down for use during 
    installation (LP: #831496).
* Dropped changes:
  - debian/patches/timeout_bug_736216: applied upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/curl_multi_info_read.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
 
2
 "http://www.w3.org/TR/html4/loose.dtd">
1
3
<html><head>
2
4
<title>curl_multi_info_read man page</title>
3
 
<meta name="generator" content="roffit 0.7">
 
5
<meta name="generator" content="roffit">
4
6
<STYLE type="text/css">
5
7
P.level0 {
6
8
 padding-left: 2em;
53
55
<p class="level0">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. 
54
56
<p class="level0"><span Class="bold">WARNING:</span> The data the returned pointer points to will not survive calling <a class="emphasis" href="./curl_multi_cleanup.html">curl_multi_cleanup(3)</a>, <a class="emphasis" href="./curl_multi_remove_handle.html">curl_multi_remove_handle(3)</a> or <a class="emphasis" href="./curl_easy_cleanup.html">curl_easy_cleanup(3)</a>. 
55
57
<p class="level0">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 <a class="emphasis" href="./curl_easy_getinfo.html">curl_easy_getinfo(3)</a> calls (or similar): 
56
 
<p class="level0"><pre>
57
 
<p class="level0">&nbsp;struct CURLMsg {
58
 
 &nbsp;  CURLMSG msg;       /* what this message means */
59
 
 &nbsp;  CURL *easy_handle; /* the handle it concerns */
60
 
 &nbsp;  union {
61
 
 &nbsp;    void *whatever;    /* message-specific data */
62
 
 &nbsp;    CURLcode result;   /* return code for transfer */
63
 
 &nbsp;  } data;
64
 
 &nbsp;};
65
 
 </pre>
66
 
 
 
58
<p class="level0">
 
59
<p class="level0">&nbsp;struct CURLMsg { &nbsp;  CURLMSG msg;       /* what this message means */ &nbsp;  CURL *easy_handle; /* the handle it concerns */ &nbsp;  union { &nbsp;    void *whatever;    /* message-specific data */ &nbsp;    CURLcode result;   /* return code for transfer */ &nbsp;  } data; &nbsp;}; 
67
60
<p class="level0">When <span Class="bold">msg</span> is <span Class="emphasis">CURLMSG_DONE</span>, the message identifies a transfer that is done, and then <span Class="bold">result</span> contains the return code for the easy handle that just completed. 
68
61
<p class="level0">At this point, there are no other <span Class="bold">msg</span> types defined. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
69
62
<p class="level0">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. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>