diff options
Diffstat (limited to 'docs/libcurl/curl_multi_setopt.3')
| -rw-r--r-- | docs/libcurl/curl_multi_setopt.3 | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/libcurl/curl_multi_setopt.3 b/docs/libcurl/curl_multi_setopt.3 new file mode 100644 index 000000000..6f88b989b --- /dev/null +++ b/docs/libcurl/curl_multi_setopt.3 @@ -0,0 +1,42 @@ +.\" $Id$ +.\" +.TH curl_multi_setopt 3 "8 Jan 2006" "libcurl 7.16.0" "libcurl Manual" +.SH NAME +curl_multi_setopt \- set options for a curl multi handle +.SH SYNOPSIS +#include <curl/curl.h> + +CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param); +.SH DESCRIPTION +curl_multi_setopt() is used to tell a libcurl multi handle how to behave. By +using the appropriate options to \fIcurl_multi_setopt\fP, you can change +libcurl's behaviour when using that multi handle. All options are set with +the \fIoption\fP followed by the parameter \fIparam\fP. That parameter can be +a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject pointer\fP or a +\fBcurl_off_t\fP type, depending on what the specific option expects. Read +this manual carefully as bad input values may cause libcurl to behave badly! +You can only set one option in each function call. + +.SH OPTIONS +.IP CURLMOPT_SOCKETFUNCTION +Pass a pointer to a function matching the curl_socket_callback prototype. The +\fIcurl_multi_socket(3)\fP 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 in the \fBparam\fP argument. They update the +status with changes since the previous time a \fIcurl_multi_socket(3)\fP +function was called. If the given callback pointer is NULL, no callback will +be called. Set the callback's fourth argument with \fICURLMOPT_SOCKETDATA\fP. +See \fIcurl_multi_socket(3)\fP for more callback details. +.IP CURLMOPT_SOCKETDATA +Pass a pointer to whatever you want passed to the curl_socket_callback's forth +argument, the userp pointer. This is not used by libcurl but only passed-thru +as-is. Set the callback pointer with \fICURLMOPT_SOCKETFUNCTION\fP. +.SH RETURNS +The standard CURLMcode for multi interface error codes. Note that it returns a +CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl +doesn't know of. +.SH AVAILABILITY +This function was added in libcurl 7.16.0 +.SH "SEE ALSO" +.BR curl_multi_cleanup "(3), " curl_multi_init "(3), " +.BR curl_multi_socket "(3), " curl_multi_info_read "(3)" |