mirror of
https://github.com/etlegacy/etlegacy-libs.git
synced 2025-02-25 04:30:42 +00:00
86 lines
3.9 KiB
HTML
86 lines
3.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
<html><head>
|
|
<title>CURLMOPT_SOCKETFUNCTION man page</title>
|
|
<meta name="generator" content="roffit">
|
|
<STYLE type="text/css">
|
|
pre {
|
|
overflow: auto;
|
|
margin: 0;
|
|
}
|
|
|
|
P.level0, pre.level0 {
|
|
padding-left: 2em;
|
|
}
|
|
|
|
P.level1, pre.level1 {
|
|
padding-left: 4em;
|
|
}
|
|
|
|
P.level2, pre.level2 {
|
|
padding-left: 6em;
|
|
}
|
|
|
|
span.emphasis {
|
|
font-style: italic;
|
|
}
|
|
|
|
span.bold {
|
|
font-weight: bold;
|
|
}
|
|
|
|
span.manpage {
|
|
font-weight: bold;
|
|
}
|
|
|
|
h2.nroffsh {
|
|
background-color: #e0e0e0;
|
|
}
|
|
|
|
span.nroffip {
|
|
font-weight: bold;
|
|
font-size: 120%;
|
|
font-family: monospace;
|
|
}
|
|
|
|
p.roffit {
|
|
text-align: center;
|
|
font-size: 80%;
|
|
}
|
|
</STYLE>
|
|
</head><body>
|
|
|
|
<p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
|
|
<p class="level0">CURLMOPT_SOCKETFUNCTION - callback informed about what to wait for <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
|
|
<p class="level0"><pre class="level0">
|
|
#include <curl/curl.h>
|
|
|
|
int socket_callback(CURL *easy, /* easy handle */
|
|
curl_socket_t s, /* socket */
|
|
int what, /* describes the socket */
|
|
void *userp, /* private callback pointer */
|
|
void *socketp); /* private socket pointer */
|
|
|
|
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETFUNCTION, socket_callback);
|
|
</pre>
|
|
<a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
|
|
<p class="level0">Pass a pointer to your callback function, which should match the prototype shown above.
|
|
<p class="level0">When the <span Class="emphasis">curl_multi_socket_action(3)</span> function runs, it informs the application about updates in the socket (file descriptor) status by doing none, one, or multiple calls to the <span Class="bold">socket_callback</span>. The callback gets status updates with changes since the previous time the callback was called. If the given callback pointer is NULL, no callback will be called. Set the callback's <span Class="bold">userp</span> argument with <a Class="emphasis" href="./CURLMOPT_SOCKETDATA.html">CURLMOPT_SOCKETDATA</a>. See <span Class="emphasis">curl_multi_socket_action(3)</span> for more details on how the callback is used and should work.
|
|
<p class="level0">The <span Class="bold">what</span> parameter informs the callback on the status of the given socket. It can hold one of these values:
|
|
<p class="level0"><a name="CURLPOLLIN"></a><span class="nroffip">CURL_POLL_IN</span>
|
|
<p class="level1">Wait for incoming data. For the socket to become readable.
|
|
<p class="level0"><a name="CURLPOLLOUT"></a><span class="nroffip">CURL_POLL_OUT</span>
|
|
<p class="level1">Wait for outgoing data. For the socket to become writable.
|
|
<p class="level0"><a name="CURLPOLLINOUT"></a><span class="nroffip">CURL_POLL_INOUT</span>
|
|
<p class="level1">Wait for incoming and outgoing data. For the socket to become readable or writable.
|
|
<p class="level0"><a name="CURLPOLLREMOVE"></a><span class="nroffip">CURL_POLL_REMOVE</span>
|
|
<p class="level1">The specified socket/file descriptor is no longer used by libcurl. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
|
|
<p class="level0">NULL (no callback) <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
|
|
<p class="level0">All <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
|
|
<p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
|
|
<p class="level0">Added in 7.15.4 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
|
|
<p class="level0">Returns CURLM_OK. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
|
|
<p class="level0"><a Class="manpage" href="./CURLMOPT_SOCKETDATA.html">CURLMOPT_SOCKETDATA</a>, <span Class="manpage">curl_multi_socket_action (3)</span>, <a Class="manpage" href="./CURLMOPT_TIMERFUNCTION.html">CURLMOPT_TIMERFUNCTION</a>
|
|
<p class="level0"><p class="roffit">
|
|
This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
|
|
</body></html>
|