2
<title>curl_multi_socket man page</title>
3
<meta name="generator" content="roffit 0.7">
4
<STYLE type="text/css">
30
background-color: #e0e0e0;
36
font-family: monospace;
46
<p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
47
<p class="level0">curl_multi_socket - reads/writes available data <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
48
<p class="level0">#include <curl/curl.h>
49
<p class="level0">CURLMcode curl_multi_socket(CURLM * multi_handle, curl_socket_t sockfd);
50
<p class="level0">CURLMcode curl_multi_socket_all(CURLM *multi_handle); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
51
<p class="level0">Alternative versions of <span Class="emphasis">curl_multi_perform()</span> that allows the application to pass in one of the file descriptors/sockets that have been detected to have "action" on them and let libcurl perform. This allows libcurl to not have to scan through all possible file descriptors to check for action. When the application has detected action on a socket handled by libcurl, it should call <span Class="emphasis">curl_multi_perform()</span> with the <span Class="bold">sockfd</span> argument set to the socket with the action.
52
<p class="level0">These functions inform the application about updates in the socket (file descriptor) status by doing none, one or multiple calls to the curl_socket_callback given with the CURLMOPT_SOCKETFUNCTION option to <a class="emphasis" href="./curl_multi_setopt.html">curl_multi_setopt(3)</a>. They update the status with changes since the previous time this function was called.
53
<p class="level0">If you want to force libcurl to (re-)check all its internal sockets and transfers instead of just a single one, you call <a class="bold" href="./curl_multi_socket_all.html">curl_multi_socket_all(3)</a> instead.
54
<p class="level0">An application should call <a class="bold" href="./curl_multi_timeout.html">curl_multi_timeout(3)</a> to figure out how long it should wait for socket actions - at most - before doing the timeout action: call the <a class="bold" href="./curl_multi_socket.html">curl_multi_socket(3)</a> function with the <span Class="bold">sockfd</span> argument set to CURL_SOCKET_TIMEOUT.
55
<p class="level0">The socket <span Class="bold">callback</span> function uses a prototype like this <pre>
56
<p class="level0"><p class="level0"> int curl_socket_callback(CURL *easy, /* easy handle */
57
curl_socket_t s, /* socket */
58
int action, /* see values below */
59
void *userp); /* "private" pointer */
60
<p class="level0">The callback MUST return 0.
61
<p class="level0">The <span Class="emphasis">action</span> (third) argument to the callback has one of five values:
62
<p class="level1"><p class="level0"><a name="CURLPOLLNONE"></a><span class="nroffip">CURL_POLL_NONE (0)</span> <p class="level1">register, not interested in readiness (yet)
63
<p class="level0"><a name="CURLPOLLIN"></a><span class="nroffip">CURL_POLL_IN (1)</span> <p class="level1">register, interested in read readiness
64
<p class="level0"><a name="CURLPOLLOUT"></a><span class="nroffip">CURL_POLL_OUT (2)</span> <p class="level1">register, interested in write readiness
65
<p class="level0"><a name="CURLPOLLINOUT"></a><span class="nroffip">CURL_POLL_INOUT (3)</span> <p class="level1">register, interested in both read and write readiness
66
<p class="level0"><a name="CURLPOLLREMOVE"></a><span class="nroffip">CURL_POLL_REMOVE (4)</span> <p class="level1">deregister
67
<p class="level0"></pre>
68
<a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
69
<p class="level0">CURLMcode type, general libcurl multi interface error code.
70
<p class="level0">If you receive <span Class="emphasis">CURLM_CALL_MULTI_PERFORM</span>, this basically means that you should call <span Class="emphasis">curl_multi_perform</span> again, before you wait for more actions on libcurl's sockets. You don't have to do it immediately, but the return code means that libcurl may have more data available to return or that there may be more data to send off before it is "satisfied".
71
<p class="level0">NOTE that this only returns errors etc regarding the whole multi stack. There might still have occurred problems on individual transfers even when this function returns OK. <a name="TYPICAL"></a><h2 class="nroffsh">TYPICAL USAGE</h2>
72
<p class="level0">1. Create a multi handle
73
<p class="level0">2. Set the socket callback with CURLMOPT_SOCKETFUNCTION
74
<p class="level0">3. Add easy handles
75
<p class="level0">4. Call curl_multi_socket_all() first once
76
<p class="level0">5. Setup a "collection" of sockets to supervise when your socket callback is called.
77
<p class="level0">6. Use curl_multi_timeout() to figure out how long to wait for action
78
<p class="level0">7. Wait for action on any of libcurl's sockets
79
<p class="level0">8, When action happens, call curl_multi_socket() for the socket(s) that got action.
80
<p class="level0">9. Go back to step 6. <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
81
<p class="level0">This function was added in libcurl 7.16.0 <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
82
<p class="level0"><a class="manpage" href="./curl_multi_cleanup.html">curl_multi_cleanup (3)</a> <a class="manpage" href="./curl_multi_init.html"> curl_multi_init (3)</a> <span Class="manpage"> </span> <a class="manpage" href="./curl_multi_fdset.html">curl_multi_fdset (3)</a> <a class="manpage" href="./curl_multi_info_read.html"> curl_multi_info_read (3)</a> <p class="roffit">
83
This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
added
removed
docs/libcurl/curl_multi_socket.html
