Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLMOPT_SOCKETDATA (3)

Name

CURLMOPT_SOCKETDATA - custom pointer passed to the socket callback

Synopsis

#include <curl/curl.h>

CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETDATA, void *pointer);

Description

CURLMOPT_SOCKETDATA(3)     curl_multi_setopt options    CURLMOPT_SOCKETDATA(3)



NAME
       CURLMOPT_SOCKETDATA - custom pointer passed to the socket callback

SYNOPSIS
       #include <curl/curl.h>

       CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETDATA, void *pointer);

DESCRIPTION
       A  data  pointer  to  pass  to  the  socket callback set with the CURL-
       MOPT_SOCKETFUNCTION(3) option.

       This pointer will not be touched by libcurl but will only be passed  in
       to the socket callbacks's userp argument.

DEFAULT
       NULL

PROTOCOLS
       All

EXAMPLE
       static int sock_cb(CURL *e, curl_socket_t s, int what, void *cbp, void *sockp)
       {
         GlobalInfo *g = (GlobalInfo*) cbp;
         SockInfo *fdp = (SockInfo*) sockp;

         if(what == CURL_POLL_REMOVE) {
           remsock(fdp);
         }
         else {
           if(!fdp) {
             addsock(s, e, what, g);
           }
           else {
             setsock(fdp, s, e, what, g);
           }
         }
         return 0;
       }

       main()
       {
         GlobalInfo setup;
         /* ... use socket callback and custom pointer */
         curl_multi_setopt(multi, CURLMOPT_SOCKETFUNCTION, sock_cb);
         curl_multi_setopt(multi, CURLMOPT_SOCKETDATA, &setup);
       }

AVAILABILITY
       Added in 7.15.4

RETURN VALUE
       Returns CURLM_OK.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLMOPT_SOCKETFUNCTION(3),      curl_multi_socket_action(3),     CURL-
       MOPT_TIMERFUNCTION(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 04, 2020        CURLMOPT_SOCKETDATA(3)