diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2014-11-03 23:11:37 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2014-11-03 23:50:31 +0100 |
| commit | a14ccfffb88b9d2103009a559361c370e21c2651 (patch) | |
| tree | 260d6e64a1fefcab03a803bc42691050e45ec83d /docs/libcurl/opts/CURLMOPT_SOCKETDATA.3 | |
| parent | 15c4d51d39ef8be29005fef58a0bb4d5c84796d5 (diff) | |
opts: made stand-alone man-pages for several multi options
Diffstat (limited to 'docs/libcurl/opts/CURLMOPT_SOCKETDATA.3')
| -rw-r--r-- | docs/libcurl/opts/CURLMOPT_SOCKETDATA.3 | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLMOPT_SOCKETDATA.3 b/docs/libcurl/opts/CURLMOPT_SOCKETDATA.3 new file mode 100644 index 000000000..49665b985 --- /dev/null +++ b/docs/libcurl/opts/CURLMOPT_SOCKETDATA.3 @@ -0,0 +1,49 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, 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 +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLMOPT_SOCKETDATA 3 "3 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options" +.SH NAME +CURLMOPT_SOCKETDATA \- custom pointer passed to the socket callback +.SH SYNOPSIS +.nf +#include <curl/curl.h> + +CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_SOCKETDATA, void *pointer); +.SH DESCRIPTION +A data \fIpointer\fP to pass to the socket callback set with the +\fICURLMOPT_SOCKETFUNCTION(3)\fP option. + +This pointer will not be touched by libcurl but will only be passed in to the +socket callbacks's \fBuserp\fP argument. +.SH DEFAULT +NULL +.SH PROTOCOLS +All +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.15.4 +.SH RETURN VALUE +Returns CURLM_OK. +.SH "SEE ALSO" +.BR CURLMOPT_SOCKETFUNCTION "(3), " curl_multi_socket_action "(3), " +.BR CURLMOPT_TIMERFUNCTION "(3) " |