1d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#ifndef __CURL_MULTI_H 2d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define __CURL_MULTI_H 3d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/*************************************************************************** 4d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * _ _ ____ _ 5d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Project ___| | | | _ \| | 6d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * / __| | | | |_) | | 7d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * | (__| |_| | _ <| |___ 8d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * \___|\___/|_| \_\_____| 9d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 10d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Copyright (C) 1998 - 2007, Daniel Stenberg, <daniel@haxx.se>, et al. 11d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 12d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * This software is licensed as described in the file COPYING, which 13d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * you should have received as part of this distribution. The terms 14d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * are also available at http://curl.haxx.se/docs/copyright.html. 15d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 16d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * copies of the Software, and permit persons to whom the Software is 18d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * furnished to do so, under the terms of the COPYING file. 19d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 20d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * KIND, either express or implied. 22d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 23d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * $Id: multi.h,v 1.45 2008-05-20 10:21:50 patrickm Exp $ 24d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid ***************************************************************************/ 25d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 26d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid This is an "external" header file. Don't give away any internals here! 27d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 28d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid GOALS 29d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 30d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid o Enable a "pull" interface. The application that uses libcurl decides where 31d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid and when to ask libcurl to get/send data. 32d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 33d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid o Enable multiple simultaneous transfers in the same thread without making it 34d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid complicated for the application. 35d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 36d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid o Enable the application to select() on its own file descriptors and curl's 37d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid file descriptors simultaneous easily. 38d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 39d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid*/ 40d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 41d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 42d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * This header file should not really need to include "curl.h" since curl.h 43d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * itself includes this file and we expect user applications to do #include 44d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * <curl/curl.h> without the need for especially including multi.h. 45d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 46d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * For some reason we added this include here at one point, and rather than to 47d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * break existing (wrongly written) libcurl applications, we leave it as-is 48d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * but with this warning attached. 49d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 50d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#include "curl.h" 51d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 52d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#ifdef __cplusplus 53d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidextern "C" { 54d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#endif 55d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 56d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef void CURLM; 57d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 58d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef enum { 59d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or 60d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid curl_multi_socket*() soon */ 61d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_OK, 62d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_BAD_HANDLE, /* the passed-in handle is not a valid CURLM handle */ 63d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */ 64d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_OUT_OF_MEMORY, /* if you ever get this, you're in deep sh*t */ 65d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_INTERNAL_ERROR, /* this is a libcurl bug */ 66d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_BAD_SOCKET, /* the passed in socket argument did not match */ 67d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_UNKNOWN_OPTION, /* curl_multi_setopt() with unsupported option */ 68d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLM_LAST 69d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid} CURLMcode; 70d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 71d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* just to make code nicer when using curl_multi_socket() you can now check 72d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid for CURLM_CALL_MULTI_SOCKET too in the same style it works for 73d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid curl_multi_perform() and CURLM_CALL_MULTI_PERFORM */ 74d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURLM_CALL_MULTI_SOCKET CURLM_CALL_MULTI_PERFORM 75d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 76d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef enum { 77d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMSG_NONE, /* first, not used */ 78d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMSG_DONE, /* This easy handle has completed. 'result' contains 79d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid the CURLcode of the transfer */ 80d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMSG_LAST /* last, not used */ 81d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid} CURLMSG; 82d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 83d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidstruct CURLMsg { 84d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMSG msg; /* what this message means */ 85d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURL *easy_handle; /* the handle it concerns */ 86d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid union { 87d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid void *whatever; /* message-specific data */ 88d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLcode result; /* return code for transfer */ 89d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid } data; 90d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid}; 91d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef struct CURLMsg CURLMsg; 92d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 93d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 94d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_init() 95d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 96d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: inititalize multi-style curl usage 97d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 98d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: a new CURLM handle to use in all 'curl_multi' functions. 99d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 100d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLM *curl_multi_init(void); 101d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 102d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 103d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_add_handle() 104d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 105d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: add a standard curl handle to the multi stack 106d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 107d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLMcode type, general multi error code. 108d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 109d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_add_handle(CURLM *multi_handle, 110d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURL *curl_handle); 111d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 112d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* 113d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_remove_handle() 114d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 115d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: removes a curl handle from the multi stack again 116d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 117d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLMcode type, general multi error code. 118d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 119d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_remove_handle(CURLM *multi_handle, 120d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURL *curl_handle); 121d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 122d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* 123d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_fdset() 124d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 125d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Ask curl for its fd_set sets. The app can use these to select() or 126d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * poll() on. We want curl_multi_perform() called as soon as one of 127d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * them are ready. 128d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 129d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLMcode type, general multi error code. 130d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 131d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_fdset(CURLM *multi_handle, 132d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid fd_set *read_fd_set, 133d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid fd_set *write_fd_set, 134d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid fd_set *exc_fd_set, 135d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *max_fd); 136d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 137d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* 138d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_perform() 139d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 140d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: When the app thinks there's data available for curl it calls this 141d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * function to read/write whatever there is right now. This returns 142d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * as soon as the reads and writes are done. This function does not 143d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * require that there actually is data available for reading or that 144d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * data can be written, it can be called just in case. It returns 145d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * the number of handles that still transfer data in the second 146d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * argument's integer-pointer. 147d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 148d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLMcode type, general multi error code. *NOTE* that this only 149d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * returns errors etc regarding the whole multi stack. There might 150d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * still have occurred problems on invidual transfers even when this 151d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * returns OK. 152d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 153d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_perform(CURLM *multi_handle, 154d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *running_handles); 155d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 156d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* 157d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_cleanup() 158d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 159d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Cleans up and removes a whole multi stack. It does not free or 160d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * touch any individual easy handles in any way. We need to define 161d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * in what state those handles will be if this function is called 162d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * in the middle of a transfer. 163d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 164d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLMcode type, general multi error code. 165d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 166d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_cleanup(CURLM *multi_handle); 167d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 168d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 169d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_info_read() 170d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 171d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Ask the multi handle if there's any messages/informationals from 172d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * the individual transfers. Messages include informationals such as 173d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * error code from the transfer or just the fact that a transfer is 174d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * completed. More details on these should be written down as well. 175d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 176d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Repeated calls to this function will return a new struct each 177d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * time, until a special "end of msgs" struct is returned as a signal 178d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * that there is no more to get at this point. 179d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 180d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * The data the returned pointer points to will not survive calling 181d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * curl_multi_cleanup(). 182d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 183d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * The 'CURLMsg' struct is meant to be very simple and only contain 184d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * very basic informations. If more involved information is wanted, 185d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * we will provide the particular "transfer handle" in that struct 186d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * and that should/could/would be used in subsequent 187d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * curl_easy_getinfo() calls (or similar). The point being that we 188d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * must never expose complex structs to applications, as then we'll 189d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * undoubtably get backwards compatibility problems in the future. 190d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 191d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: A pointer to a filled-in struct, or NULL if it failed or ran out 192d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * of structs. It also writes the number of messages left in the 193d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * queue (after this read) in the integer the second argument points 194d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * to. 195d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 196d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMsg *curl_multi_info_read(CURLM *multi_handle, 197d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *msgs_in_queue); 198d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 199d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 200d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_strerror() 201d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 202d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: The curl_multi_strerror function may be used to turn a CURLMcode 203d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * value into the equivalent human readable error string. This is 204d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * useful for printing meaningful error messages. 205d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 206d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: A pointer to a zero-terminated error message. 207d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 208d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN const char *curl_multi_strerror(CURLMcode); 209d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 210d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 211d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_socket() and 212d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * curl_multi_socket_all() 213d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 214d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: An alternative version of curl_multi_perform() that allows the 215d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * application to pass in one of the file descriptors that have been 216d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * detected to have "action" on them and let libcurl perform. 217d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * See man page for details. 218d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 219d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_POLL_NONE 0 220d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_POLL_IN 1 221d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_POLL_OUT 2 222d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_POLL_INOUT 3 223d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_POLL_REMOVE 4 224d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 225d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_SOCKET_TIMEOUT CURL_SOCKET_BAD 226d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 227d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_CSELECT_IN 0x01 228d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_CSELECT_OUT 0x02 229d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CURL_CSELECT_ERR 0x04 230d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 231d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef int (*curl_socket_callback)(CURL *easy, /* easy handle */ 232d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid curl_socket_t s, /* socket */ 233d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int what, /* see above */ 234d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid void *userp, /* private callback 235d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid pointer */ 236d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid void *socketp); /* private socket 237d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid pointer */ 238d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 239d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_timer_callback 240d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 241d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Called by libcurl whenever the library detects a change in the 242d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * maximum number of milliseconds the app is allowed to wait before 243d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * curl_multi_socket() or curl_multi_perform() must be called 244d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * (to allow libcurl's timed events to take place). 245d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 246d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: The callback should return zero. 247d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 248d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef int (*curl_multi_timer_callback)(CURLM *multi, /* multi handle */ 249d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid long timeout_ms, /* see above */ 250d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid void *userp); /* private callback 251d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid pointer */ 252d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 253d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t s, 254d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *running_handles); 255d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 256d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_socket_action(CURLM *multi_handle, 257d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid curl_socket_t s, 258d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int ev_bitmask, 259d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *running_handles); 260d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 261d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_socket_all(CURLM *multi_handle, 262d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid int *running_handles); 263d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 264d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#ifndef CURL_ALLOW_OLD_MULTI_SOCKET 265d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* This macro below was added in 7.16.3 to push users who recompile to use 266d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid the new curl_multi_socket_action() instead of the old curl_multi_socket() 267d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid*/ 268d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define curl_multi_socket(x,y,z) curl_multi_socket_action(x,y,0,z) 269d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#endif 270d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 271d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 272d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_timeout() 273d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 274d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Returns the maximum number of milliseconds the app is allowed to 275d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * wait before curl_multi_socket() or curl_multi_perform() must be 276d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * called (to allow libcurl's timed events to take place). 277d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 278d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLM error code. 279d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 280d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_timeout(CURLM *multi_handle, 281d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid long *milliseconds); 282d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 283d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#undef CINIT /* re-using the same name as in curl.h */ 284d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 285d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#ifdef CURL_ISOCPP 286d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CINIT(name,type,num) CURLMOPT_ ## name = CURLOPTTYPE_ ## type + num 287d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#else 288d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ 289d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define LONG CURLOPTTYPE_LONG 290d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define OBJECTPOINT CURLOPTTYPE_OBJECTPOINT 291d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT 292d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define OFF_T CURLOPTTYPE_OFF_T 293d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#define CINIT(name,type,number) CURLMOPT_/**/name = type + number 294d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#endif 295d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 296d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidtypedef enum { 297d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* This is the socket callback function pointer */ 298d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(SOCKETFUNCTION, FUNCTIONPOINT, 1), 299d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 300d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* This is the argument passed to the socket callback */ 301d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(SOCKETDATA, OBJECTPOINT, 2), 302d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 303d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* set to 1 to enable pipelining for this multi handle */ 304d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(PIPELINING, LONG, 3), 305d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 306d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* This is the timer callback function pointer */ 307d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(TIMERFUNCTION, FUNCTIONPOINT, 4), 308d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 309d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* This is the argument passed to the timer callback */ 310d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(TIMERDATA, OBJECTPOINT, 5), 311d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 312d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid /* maximum number of entries in the connection cache */ 313d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CINIT(MAXCONNECTS, LONG, 6), 314d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 315d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMOPT_LASTENTRY /* the last unused */ 316d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid} CURLMoption; 317d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 318d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 319d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 320d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_setopt() 321d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 322d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: Sets options for the multi handle. 323d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 324d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLM error code. 325d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 326d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_setopt(CURLM *multi_handle, 327d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid CURLMoption option, ...); 328d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 329d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 330d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid/* 331d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Name: curl_multi_assign() 332d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 333d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Desc: This function sets an association in the multi handle between the 334d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * given socket and a private pointer of the application. This is 335d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * (only) useful for curl_multi_socket uses. 336d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * 337d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid * Returns: CURLM error code. 338d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid */ 339d9d863e153d12532fc85bd8b44bc47f079ed064cnealsidCURL_EXTERN CURLMcode curl_multi_assign(CURLM *multi_handle, 340d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid curl_socket_t sockfd, void *sockp); 341d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 342d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#ifdef __cplusplus 343d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid} /* end of extern "C" */ 344d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#endif 345d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid 346d9d863e153d12532fc85bd8b44bc47f079ed064cnealsid#endif 347