curl/docs/libcurl/curl_multi_socket.3

   1 .\" $Id: curl_multi_socket.3,v 1.14 2008-07-10 13:40:59 bagder Exp $
   2 .\"
   3 .TH curl_multi_socket 3 "9 Jul 2006" "libcurl 7.16.0" "libcurl Manual"
   4 .SH NAME
   5 curl_multi_socket \- reads/writes available data
   6 .SH SYNOPSIS
   7 .nf
   8 #include <curl/curl.h>
   9
  10 CURLMcode curl_multi_socket_action(CURLM * multi_handle,
  11                                    curl_socket_t sockfd, int ev_bitmask,
  12                                    int *running_handles);
  13 .fi
  14
  15 .B "Now deprecated versions:"
  16 .nf
  17 CURLMcode curl_multi_socket(CURLM * multi_handle, curl_socket_t sockfd,
  18                             int *running_handles);
  19
  20 CURLMcode curl_multi_socket_all(CURLM *multi_handle,
  21                                 int *running_handles);
  22 .fi
  23 .SH DESCRIPTION
  24 Alternative versions of \fIcurl_multi_perform(3)\fP that allows the
  25 application to pass in the file descriptor/socket that has been detected to
  26 have \&"action" on it and let libcurl perform. This lets libcurl avoid having
  27 to scan through all possible file descriptors to check for action.
  28
  29 When the application has detected action on a socket handled by libcurl, it
  30 should call \fIcurl_multi_socket_action(3)\fP with the \fBsockfd\fP argument
  31 set to the socket with the action. When the events on a socket are known, they
  32 can be passed as an events bitmask \fBev_bitmask\fP by first setting
  33 \fBev_bitmask\fP to 0, and then adding using bitwise OR (|) any combination of
  34 events to be chosen from CURL_CSELECT_IN, CURL_CSELECT_OUT or
  35 CURL_CSELECT_ERR. When the events on a socket are unknown, pass 0 instead, and
  36 libcurl will test the descriptor internally.
  37
  38 At return, the integer \fBrunning_handles\fP points to will contain the number
  39 of still running easy handles within the multi handle. When this number
  40 reaches zero, all transfers are complete/done. Note that when you call
  41 \fIcurl_multi_socket_action(3)\fP on a specific socket and the counter
  42 decreases by one, it DOES NOT necessarily mean that this exact socket/transfer
  43 is the one that completed. Use \fIcurl_multi_info_read(3)\fP to figure out
  44 which easy handle that completed.
  45
  46 The \fBcurl_multi_socket_action(3)\fP functions inform the application about
  47 updates in the socket (file descriptor) status by doing none, one or multiple
  48 calls to the socket callback function set with the CURLMOPT_SOCKETFUNCTION
  49 option to \fIcurl_multi_setopt(3)\fP. They update the status with changes
  50 since the previous time the callback was called.
  51
  52 Get the timeout time by setting the \fICURLMOPT_TIMERFUNCTION\fP option with
  53 \fIcurl_multi_setopt(3)\fP. Your application will then get called with
  54 information on how long to wait for socket actions at most before doing the
  55 timeout action: call the \fBcurl_multi_socket_action(3)\fP function with the
  56 \fBsockfd\fP argument set to CURL_SOCKET_TIMEOUT. You can also use the
  57 \fIcurl_multi_timeout(3)\fP function to poll the value at any given time, but
  58 for an event-based system using the callback is far better than relying on
  59 polling the timeout value.
  60
  61 Usage of \fIcurl_multi_socket(3)\fP is deprecated, whereas the function is
  62 equivalent to \fIcurl_multi_socket_action(3)\fP with \fBev_bitmask\fP set to
  63 0.
  64
  65 Force libcurl to (re-)check all its internal sockets and transfers instead of
  66 just a single one by calling \fBcurl_multi_socket_all(3)\fP. Note that there
  67 should not exist any reasons to use this function!
  68 .SH "CALLBACK DETAILS"
  69
  70 The socket \fBcallback\fP function uses a prototype like this
  71 .nf
  72
  73   int curl_socket_callback(CURL *easy,      /* easy handle */
  74                            curl_socket_t s, /* socket */
  75                            int action,      /* see values below */
  76                            void *userp,    /* private callback pointer */
  77                            void *socketp); /* private socket pointer */
  78
  79 .fi
  80 The callback MUST return 0.
  81
  82 The \fIeasy\fP argument is a pointer to the easy handle that deals with this
  83 particular socket. Note that a single handle may work with several sockets
  84 simultaneously.
  85
  86 The \fIs\fP argument is the actual socket value as you use it within your
  87 system.
  88
  89 The \fIaction\fP argument to the callback has one of five values:
  90 .RS
  91 .IP "CURL_POLL_NONE (0)"
  92 register, not interested in readiness (yet)
  93 .IP "CURL_POLL_IN (1)"
  94 register, interested in read readiness
  95 .IP "CURL_POLL_OUT (2)"
  96 register, interested in write readiness
  97 .IP "CURL_POLL_INOUT (3)"
  98 register, interested in both read and write readiness
  99 .IP "CURL_POLL_REMOVE (4)"
 100 unregister
 101 .RE
 102
 103 The \fIsocketp\fP argument is a private pointer you have previously set with
 104 \fIcurl_multi_assign(3)\fP to be associated with the \fIs\fP socket. If no
 105 pointer has been set, socketp will be NULL. This argument is of course a
 106 service to applications that want to keep certain data or structs that are
 107 strictly associated to the given socket.
 108
 109 The \fIuserp\fP argument is a private pointer you have previously set with
 110 \fIcurl_multi_setopt(3)\fP and the CURLMOPT_SOCKETDATA option.
 111 .SH "RETURN VALUE"
 112 CURLMcode type, general libcurl multi interface error code.
 113
 114 Legacy: If you receive \fICURLM_CALL_MULTI_PERFORM\fP, this basically means
 115 that you should call \fIcurl_multi_socket(3)\fP again, before you wait for
 116 more actions on libcurl's sockets. You don't have to do it immediately, but
 117 the return code means that libcurl may have more data available to return or
 118 that there may be more data to send off before it is "satisfied".
 119
 120 In modern libcurls, \fICURLM_CALL_MULTI_PERFORM\fP or
 121 \fICURLM_CALL_MULTI_SOKCET\fP should not be returned and no application needs
 122 to care about them.
 123
 124 NOTE that the return code is for the whole multi stack. There might still have
 125 occurred problems on individual transfers even when one of these functions
 126 return OK.
 127 .SH "TYPICAL USAGE"
 128 1. Create a multi handle
 129
 130 2. Set the socket callback with CURLMOPT_SOCKETFUNCTION
 131
 132 3. Set the timeout callback with CURLMOPT_TIMERFUNCTION, to get to know what
 133 timeout value to use when waiting for socket activities.
 134
 135 4. Add easy handles with curl_multi_add_handle()
 136
 137 5. Provide some means to manage the sockets libcurl is using, so you can check
 138 them for activity. This can be done through your application code, or by way
 139 of an external library such as libevent or glib.
 140
 141 6. Wait for activity on any of libcurl's sockets, use the timeout value your
 142 callback has been told
 143
 144 7, When activity is detected, call curl_multi_socket_action() for the
 145 socket(s) that got action. If no activity is detected and the timeout expires,
 146 call \fIcurl_multi_socket_action(3)\fP with \fICURL_SOCKET_TIMEOUT\fP
 147
 148 8. Go back to step 6.
 149 .SH AVAILABILITY
 150 This function was added in libcurl 7.15.4, although deemed stable since
 151 7.16.0.
 152
 153 \fIcurl_multi_socket(3)\fP is deprecated, use
 154 \fIcurl_multi_socket_action(3)\fP instead!
 155 .SH "SEE ALSO"
 156 .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
 157 .BR curl_multi_fdset "(3), " curl_multi_info_read "(3), "
 158 .BR "the hiperfifo.c example"