|
@@ -5,7 +5,7 @@
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
.\" *
|
|
|
-.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
.\" *
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
.\" * you should have received as part of this distribution. The terms
|
|
@@ -45,12 +45,13 @@ which easy handle that completed.
|
|
|
|
|
|
The \fIcurl_multi_socket_action(3)\fP functions inform the application about
|
|
|
updates in the socket (file descriptor) status by doing none, one, or multiple
|
|
|
-calls to the socket callback function set with the CURLMOPT_SOCKETFUNCTION
|
|
|
-option to \fIcurl_multi_setopt(3)\fP. They update the status with changes
|
|
|
-since the previous time the callback was called.
|
|
|
+calls to the socket callback function set with the
|
|
|
+\fICURLMOPT_SOCKETFUNCTION(3)\fP option to \fIcurl_multi_setopt(3)\fP. They
|
|
|
+update the status with changes since the previous time the callback was
|
|
|
+called.
|
|
|
|
|
|
-Get the timeout time by setting the \fICURLMOPT_TIMERFUNCTION\fP option with
|
|
|
-\fIcurl_multi_setopt(3)\fP. Your application will then get called with
|
|
|
+Get the timeout time by setting the \fICURLMOPT_TIMERFUNCTION(3)\fP option
|
|
|
+with \fIcurl_multi_setopt(3)\fP. Your application will then get called with
|
|
|
information on how long to wait for socket actions at most before doing the
|
|
|
timeout action: call the \fIcurl_multi_socket_action(3)\fP function with the
|
|
|
\fBsockfd\fP argument set to CURL_SOCKET_TIMEOUT. You can also use the
|
|
@@ -107,7 +108,7 @@ service to applications that want to keep certain data or structs that are
|
|
|
strictly associated to the given socket.
|
|
|
|
|
|
The \fIuserp\fP argument is a private pointer you have previously set with
|
|
|
-\fIcurl_multi_setopt(3)\fP and the CURLMOPT_SOCKETDATA option.
|
|
|
+\fIcurl_multi_setopt(3)\fP and the \fICURLMOPT_SOCKETDATA(3)\fP option.
|
|
|
.SH "RETURN VALUE"
|
|
|
CURLMcode type, general libcurl multi interface error code.
|
|
|
|
|
@@ -127,10 +128,10 @@ return OK.
|
|
|
.SH "TYPICAL USAGE"
|
|
|
1. Create a multi handle
|
|
|
|
|
|
-2. Set the socket callback with CURLMOPT_SOCKETFUNCTION
|
|
|
+2. Set the socket callback with \fICURLMOPT_SOCKETFUNCTION(3)\fP
|
|
|
|
|
|
-3. Set the timeout callback with CURLMOPT_TIMERFUNCTION, to get to know what
|
|
|
-timeout value to use when waiting for socket activities.
|
|
|
+3. Set the timeout callback with \fICURLMOPT_TIMERFUNCTION(3)\fP, to get to
|
|
|
+know what timeout value to use when waiting for socket activities.
|
|
|
|
|
|
4. Add easy handles with curl_multi_add_handle()
|
|
|
|