docs/libcurl/opts/CURLMOPT_SOCKETDATA.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLMOPT_SOCKETDATA 3 "3 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_SOCKETDATA \- custom pointer passed to the socket callback
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETDATA, void *pointer);
  31 .SH DESCRIPTION
  32 A data \fIpointer\fP to pass to the socket callback set with the
  33 \fICURLMOPT_SOCKETFUNCTION(3)\fP option.
  34
  35 This pointer will not be touched by libcurl but will only be passed in to the
  36 socket callbacks's \fBuserp\fP argument.
  37 .SH DEFAULT
  38 NULL
  39 .SH PROTOCOLS
  40 All
  41 .SH EXAMPLE
  42 TODO
  43 .SH AVAILABILITY
  44 Added in 7.15.4
  45 .SH RETURN VALUE
  46 Returns CURLM_OK.
  47 .SH "SEE ALSO"
  48 .BR CURLMOPT_SOCKETFUNCTION "(3), " curl_multi_socket_action "(3), "
  49 .BR CURLMOPT_TIMERFUNCTION "(3) "