docs: fix missed option name markups
This commit is contained in:
Родитель
09a72f5dd5
Коммит
9679790b23
|
@ -5,7 +5,7 @@
|
|||
.\" * | (__| |_| | _ <| |___
|
||||
.\" * \___|\___/|_| \_\_____|
|
||||
.\" *
|
||||
.\" * Copyright (C) 1998 - 2014, 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
|
||||
|
@ -46,11 +46,11 @@ connection cache owned by the multi handle. Removing and adding new easy
|
|||
handles will not affect the pool of connections or the ability to do
|
||||
connection re-use.
|
||||
|
||||
If you have CURLMOPT_TIMERFUNCTION set in the multi handle (and you really
|
||||
should if you're working event-based with \fIcurl_multi_socket_action(3)\fP
|
||||
and friends), that callback will be called from within this function to ask
|
||||
for an updated timer so that your main event loop will get the activity on
|
||||
this handle to get started.
|
||||
If you have \fICURLMOPT_TIMERFUNCTION(3)\fP set in the multi handle (and you
|
||||
really should if you're working event-based with
|
||||
\fIcurl_multi_socket_action(3)\fP and friends), that callback will be called
|
||||
from within this function to ask for an updated timer so that your main event
|
||||
loop will get the activity on this handle to get started.
|
||||
|
||||
The easy handle will remain added to the multi handle until you remove it
|
||||
again with \fIcurl_multi_remove_handle(3)\fP - even when a transfer with that
|
||||
|
|
|
@ -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()
|
||||
|
||||
|
|
|
@ -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
|
||||
|
@ -111,7 +111,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.
|
||||
|
||||
|
@ -128,10 +128,10 @@ functions 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()
|
||||
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
.\" * | (__| |_| | _ <| |___
|
||||
.\" * \___|\___/|_| \_\_____|
|
||||
.\" *
|
||||
.\" * Copyright (C) 1998 - 2017, 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
|
||||
|
@ -132,24 +132,24 @@ using large numbers of simultaneous connections.
|
|||
|
||||
When using this API, you add easy handles to the multi handle just as with the
|
||||
normal multi interface. Then you also set two callbacks with the
|
||||
CURLMOPT_SOCKETFUNCTION and CURLMOPT_TIMERFUNCTION options to
|
||||
\fIcurl_multi_setopt(3)\fP. They are two callback functions that libcurl will
|
||||
call with information about what sockets to wait for, and for what activity,
|
||||
and what the current timeout time is - if that expires libcurl should be
|
||||
notified.
|
||||
\fICURLMOPT_SOCKETFUNCTION(3)\fP and \fICURLMOPT_TIMERFUNCTION(3)\fP options
|
||||
to \fIcurl_multi_setopt(3)\fP. They are two callback functions that libcurl
|
||||
will call with information about what sockets to wait for, and for what
|
||||
activity, and what the current timeout time is - if that expires libcurl
|
||||
should be notified.
|
||||
|
||||
The multi_socket API is designed to inform your application about which
|
||||
sockets libcurl is currently using and for what activities (read and/or write)
|
||||
on those sockets your application is expected to wait for.
|
||||
|
||||
Your application must make sure to receive all sockets informed about in the
|
||||
CURLMOPT_SOCKETFUNCTION callback and make sure it reacts on the given activity
|
||||
on them. When a socket has the given activity, you call
|
||||
\fICURLMOPT_SOCKETFUNCTION(3)\fP callback and make sure it reacts on the given
|
||||
activity on them. When a socket has the given activity, you call
|
||||
\fIcurl_multi_socket_action(3)\fP specifying which socket and action there
|
||||
are.
|
||||
|
||||
The CURLMOPT_TIMERFUNCTION callback is called to set a timeout. When that
|
||||
timeout expires, your application should call the
|
||||
The \fICURLMOPT_TIMERFUNCTION(3)\fP callback is called to set a timeout. When
|
||||
that timeout expires, your application should call the
|
||||
\fIcurl_multi_socket_action(3)\fP function saying it was due to a timeout.
|
||||
|
||||
This API is typically used with an event-driven underlying functionality (like
|
||||
|
|
Загрузка…
Ссылка в новой задаче