multi.h File Reference

#include "curl.h"

Go to the source code of this file.

Data Structures
struct	CURLMsg
struct	curl_waitfd

Macros
#define	CURLM_CALL_MULTI_SOCKET   CURLM_CALL_MULTI_PERFORM
#define	CURLPIPE_NOTHING   0L
#define	CURLPIPE_HTTP1   1L
#define	CURLPIPE_MULTIPLEX   2L
#define	CURL_WAIT_POLLIN   0x0001
#define	CURL_WAIT_POLLPRI   0x0002
#define	CURL_WAIT_POLLOUT   0x0004
#define	CURL_POLL_NONE   0
#define	CURL_POLL_IN   1
#define	CURL_POLL_OUT   2
#define	CURL_POLL_INOUT   3
#define	CURL_POLL_REMOVE   4
#define	CURL_SOCKET_TIMEOUT   CURL_SOCKET_BAD
#define	CURL_CSELECT_IN   0x01
#define	CURL_CSELECT_OUT   0x02
#define	CURL_CSELECT_ERR   0x04
#define	curl_multi_socket(x, y, z)   curl_multi_socket_action(x,y,0,z)
#define	CURL_PUSH_OK   0
#define	CURL_PUSH_DENY   1
#define	CURL_PUSH_ERROROUT   2 /* added in 7.72.0 */

Typedefs
typedef void	CURLM
typedef struct CURLMsg	CURLMsg
typedef int(*	curl_socket_callback) (CURL *easy, curl_socket_t s, int what, void *userp, void *socketp)
typedef int(*	curl_multi_timer_callback) (CURLM *multi, long timeout_ms, void *userp)
typedef int(*	curl_push_callback) (CURL *parent, CURL *easy, size_t num_headers, struct curl_pushheaders *headers, void *userp)

Enumerations
enum	CURLMcode {   CURLM_CALL_MULTI_PERFORM = -1 , CURLM_OK , CURLM_BAD_HANDLE , CURLM_BAD_EASY_HANDLE ,   CURLM_OUT_OF_MEMORY , CURLM_INTERNAL_ERROR , CURLM_BAD_SOCKET , CURLM_UNKNOWN_OPTION ,   CURLM_ADDED_ALREADY , CURLM_RECURSIVE_API_CALL , CURLM_WAKEUP_FAILURE , CURLM_BAD_FUNCTION_ARGUMENT ,   CURLM_ABORTED_BY_CALLBACK , CURLM_UNRECOVERABLE_POLL , CURLM_LAST }
enum	CURLMSG { CURLMSG_NONE , CURLMSG_DONE , CURLMSG_LAST }
enum	CURLMoption {   CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) ,   CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) ,   CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) ,   CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) , CURLOPT =(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1) ,   CURLMOPT_LASTENTRY }

Functions
CURL_EXTERN CURLM *	curl_multi_init (void)
CURL_EXTERN CURLMcode	curl_multi_add_handle (CURLM *multi_handle, CURL *curl_handle)
CURL_EXTERN CURLMcode	curl_multi_remove_handle (CURLM *multi_handle, CURL *curl_handle)
CURL_EXTERN CURLMcode	curl_multi_fdset (CURLM *multi_handle, fd_set *read_fd_set, fd_set *write_fd_set, fd_set *exc_fd_set, int *max_fd)
CURL_EXTERN CURLMcode	curl_multi_wait (CURLM *multi_handle, struct curl_waitfd extra_fds[], unsigned int extra_nfds, int timeout_ms, int *ret)
CURL_EXTERN CURLMcode	curl_multi_poll (CURLM *multi_handle, struct curl_waitfd extra_fds[], unsigned int extra_nfds, int timeout_ms, int *ret)
CURL_EXTERN CURLMcode	curl_multi_wakeup (CURLM *multi_handle)
CURL_EXTERN CURLMcode	curl_multi_perform (CURLM *multi_handle, int *running_handles)
CURL_EXTERN CURLMcode	curl_multi_cleanup (CURLM *multi_handle)
CURL_EXTERN CURLMsg *	curl_multi_info_read (CURLM *multi_handle, int *msgs_in_queue)
CURL_EXTERN const char *	curl_multi_strerror (CURLMcode)
CURL_EXTERN CURLMcode	CURL_DEPRECATED (7.19.5, "Use curl_multi_socket_action()") curl_multi_socket(CURLM *multi_handle
CURL_EXTERN CURLMcode	curl_multi_socket_action (CURLM *multi_handle, curl_socket_t s, int ev_bitmask, int *running_handles)
CURL_EXTERN CURLMcode	curl_multi_timeout (CURLM *multi_handle, long *milliseconds)
CURL_EXTERN CURLMcode	curl_multi_setopt (CURLM *multi_handle, CURLMoption option,...)
CURL_EXTERN CURLMcode	curl_multi_assign (CURLM *multi_handle, curl_socket_t sockfd, void *sockp)
CURL_EXTERN CURL **	curl_multi_get_handles (CURLM *multi_handle)
CURL_EXTERN char *	curl_pushheader_bynum (struct curl_pushheaders *h, size_t num)
CURL_EXTERN char *	curl_pushheader_byname (struct curl_pushheaders *h, const char *name)
CURL_EXTERN CURLMcode	curl_multi_waitfds (CURLM *multi, struct curl_waitfd *ufds, unsigned int size, unsigned int *fd_count)

Variables
CURL_EXTERN CURLMcode curl_socket_t	s
CURL_EXTERN CURLMcode curl_socket_t int *	running_handles

Macro Definition Documentation

CURL_CSELECT_ERR

#define CURL_CSELECT_ERR   0x04

Definition at line 293 of file multi.h.

CURL_CSELECT_IN

#define CURL_CSELECT_IN   0x01

Definition at line 291 of file multi.h.

CURL_CSELECT_OUT

#define CURL_CSELECT_OUT   0x02

Definition at line 292 of file multi.h.

curl_multi_socket

#define curl_multi_socket	(		x,
			y,
			z )   curl_multi_socket_action(x,y,0,z)

Definition at line 332 of file multi.h.

CURL_POLL_IN

#define CURL_POLL_IN   1

Definition at line 284 of file multi.h.

CURL_POLL_INOUT

#define CURL_POLL_INOUT   3

Definition at line 286 of file multi.h.

CURL_POLL_NONE

#define CURL_POLL_NONE   0

Definition at line 283 of file multi.h.

CURL_POLL_OUT

#define CURL_POLL_OUT   2

Definition at line 285 of file multi.h.

CURL_POLL_REMOVE

#define CURL_POLL_REMOVE   4

Definition at line 287 of file multi.h.

CURL_PUSH_DENY

#define CURL_PUSH_DENY   1

Definition at line 447 of file multi.h.

CURL_PUSH_ERROROUT

#define CURL_PUSH_ERROROUT   2 /* added in 7.72.0 */

Definition at line 448 of file multi.h.

CURL_PUSH_OK

#define CURL_PUSH_OK   0

Definition at line 446 of file multi.h.

CURL_SOCKET_TIMEOUT

#define CURL_SOCKET_TIMEOUT   CURL_SOCKET_BAD

Definition at line 289 of file multi.h.

CURL_WAIT_POLLIN

#define CURL_WAIT_POLLIN   0x0001

Definition at line 110 of file multi.h.

CURL_WAIT_POLLOUT

#define CURL_WAIT_POLLOUT   0x0004

Definition at line 112 of file multi.h.

CURL_WAIT_POLLPRI

#define CURL_WAIT_POLLPRI   0x0002

Definition at line 111 of file multi.h.

CURLM_CALL_MULTI_SOCKET

#define CURLM_CALL_MULTI_SOCKET   CURLM_CALL_MULTI_PERFORM

Definition at line 83 of file multi.h.

CURLPIPE_HTTP1

#define CURLPIPE_HTTP1   1L

Definition at line 87 of file multi.h.

CURLPIPE_MULTIPLEX

#define CURLPIPE_MULTIPLEX   2L

Definition at line 88 of file multi.h.

CURLPIPE_NOTHING

#define CURLPIPE_NOTHING   0L

Definition at line 86 of file multi.h.

Typedef Documentation

curl_multi_timer_callback

typedef int(* curl_multi_timer_callback) (CURLM *multi, long timeout_ms, void *userp)

Definition at line 312 of file multi.h.

curl_push_callback

typedef int(* curl_push_callback) (CURL *parent, CURL *easy, size_t num_headers, struct curl_pushheaders *headers, void *userp)

Definition at line 457 of file multi.h.

curl_socket_callback

typedef int(* curl_socket_callback) (CURL *easy, curl_socket_t s, int what, void *userp, void *socketp)

Definition at line 295 of file multi.h.

CURLM

typedef void CURLM

Definition at line 57 of file multi.h.

CURLMsg

typedef struct CURLMsg CURLMsg

Definition at line 105 of file multi.h.

Enumeration Type Documentation

CURLMcode

enum CURLMcode

Enumerator
CURLM_CALL_MULTI_PERFORM
CURLM_OK
CURLM_BAD_HANDLE
CURLM_BAD_EASY_HANDLE
CURLM_OUT_OF_MEMORY
CURLM_INTERNAL_ERROR
CURLM_BAD_SOCKET
CURLM_UNKNOWN_OPTION
CURLM_ADDED_ALREADY
CURLM_RECURSIVE_API_CALL
CURLM_WAKEUP_FAILURE
CURLM_BAD_FUNCTION_ARGUMENT
CURLM_ABORTED_BY_CALLBACK
CURLM_UNRECOVERABLE_POLL
CURLM_LAST

Definition at line 59 of file multi.h.

             {
  CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or
                                    curl_multi_socket*() soon */
  CURLM_OK,
  CURLM_BAD_HANDLE,      /* the passed-in handle is not a valid CURLM handle */
  CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */
  CURLM_OUT_OF_MEMORY,   /* if you ever get this, you are in deep sh*t */
  CURLM_INTERNAL_ERROR,  /* this is a libcurl bug */
  CURLM_BAD_SOCKET,      /* the passed in socket argument did not match */
  CURLM_UNKNOWN_OPTION,  /* curl_multi_setopt() with unsupported option */
  CURLM_ADDED_ALREADY,   /* an easy handle already added to a multi handle was
                            attempted to get added - again */
  CURLM_RECURSIVE_API_CALL, /* an api function was called from inside a
                               callback */
  CURLM_WAKEUP_FAILURE,  /* wakeup is unavailable or failed */
  CURLM_BAD_FUNCTION_ARGUMENT, /* function called with a bad parameter */
  CURLM_ABORTED_BY_CALLBACK,
  CURLM_UNRECOVERABLE_POLL,
  CURLM_LAST
} CURLMcode;

CURLMoption

enum CURLMoption

Enumerator
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLOPT
CURLMOPT_LASTENTRY

Definition at line 347 of file multi.h.

             {
  /* This is the socket callback function pointer */
  CURLOPT(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1),
 
  /* This is the argument passed to the socket callback */
  CURLOPT(CURLMOPT_SOCKETDATA, CURLOPTTYPE_OBJECTPOINT, 2),
 
    /* set to 1 to enable pipelining for this multi handle */
  CURLOPT(CURLMOPT_PIPELINING, CURLOPTTYPE_LONG, 3),
 
   /* This is the timer callback function pointer */
  CURLOPT(CURLMOPT_TIMERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 4),
 
  /* This is the argument passed to the timer callback */
  CURLOPT(CURLMOPT_TIMERDATA, CURLOPTTYPE_OBJECTPOINT, 5),
 
  /* maximum number of entries in the connection cache */
  CURLOPT(CURLMOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 6),
 
  /* maximum number of (pipelining) connections to one host */
  CURLOPT(CURLMOPT_MAX_HOST_CONNECTIONS, CURLOPTTYPE_LONG, 7),
 
  /* maximum number of requests in a pipeline */
  CURLOPT(CURLMOPT_MAX_PIPELINE_LENGTH, CURLOPTTYPE_LONG, 8),
 
  /* a connection with a content-length longer than this
     will not be considered for pipelining */
  CURLOPT(CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 9),
 
  /* a connection with a chunk length longer than this
     will not be considered for pipelining */
  CURLOPT(CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 10),
 
  /* a list of site names(+port) that are blocked from pipelining */
  CURLOPT(CURLMOPT_PIPELINING_SITE_BL, CURLOPTTYPE_OBJECTPOINT, 11),
 
  /* a list of server types that are blocked from pipelining */
  CURLOPT(CURLMOPT_PIPELINING_SERVER_BL, CURLOPTTYPE_OBJECTPOINT, 12),
 
  /* maximum number of open connections in total */
  CURLOPT(CURLMOPT_MAX_TOTAL_CONNECTIONS, CURLOPTTYPE_LONG, 13),
 
   /* This is the server push callback function pointer */
  CURLOPT(CURLMOPT_PUSHFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 14),
 
  /* This is the argument passed to the server push callback */
  CURLOPT(CURLMOPT_PUSHDATA, CURLOPTTYPE_OBJECTPOINT, 15),
 
  /* maximum number of concurrent streams to support on a connection */
  CURLOPT(CURLMOPT_MAX_CONCURRENT_STREAMS, CURLOPTTYPE_LONG, 16),
 
  CURLMOPT_LASTENTRY /* the last unused */
} CURLMoption;

CURLMSG

enum CURLMSG

Enumerator
CURLMSG_NONE
CURLMSG_DONE
CURLMSG_LAST

Definition at line 90 of file multi.h.

             {
  CURLMSG_NONE, /* first, not used */
  CURLMSG_DONE, /* This easy handle has completed. 'result' contains
                   the CURLcode of the transfer */
  CURLMSG_LAST /* last, not used */
} CURLMSG;

Function Documentation

CURL_DEPRECATED()

CURL_EXTERN CURLMcode CURL_DEPRECATED	(	7.19.	5,
		"Use curl_multi_socket_action()"	)

curl_multi_add_handle()

CURL_EXTERN CURLMcode curl_multi_add_handle	(	CURLM *	multi_handle,
		CURL *	curl_handle )

curl_multi_assign()

CURL_EXTERN CURLMcode curl_multi_assign	(	CURLM *	multi_handle,
		curl_socket_t	sockfd,
		void *	sockp )

curl_multi_cleanup()

CURL_EXTERN CURLMcode curl_multi_cleanup

(

CURLM *

multi_handle

)

curl_multi_fdset()

CURL_EXTERN CURLMcode curl_multi_fdset	(	CURLM *	multi_handle,
		fd_set *	read_fd_set,
		fd_set *	write_fd_set,
		fd_set *	exc_fd_set,
		int *	max_fd )

curl_multi_get_handles()

CURL_EXTERN CURL ** curl_multi_get_handles

(

CURLM *

multi_handle

)

curl_multi_info_read()

CURL_EXTERN CURLMsg * curl_multi_info_read	(	CURLM *	multi_handle,
		int *	msgs_in_queue )

curl_multi_init()

CURL_EXTERN CURLM * curl_multi_init

(

void

)

curl_multi_perform()

CURL_EXTERN CURLMcode curl_multi_perform	(	CURLM *	multi_handle,
		int *	running_handles )

curl_multi_poll()

CURL_EXTERN CURLMcode curl_multi_poll	(	CURLM *	multi_handle,
		struct curl_waitfd	extra_fds[],
		unsigned int	extra_nfds,
		int	timeout_ms,
		int *	ret )

curl_multi_remove_handle()

CURL_EXTERN CURLMcode curl_multi_remove_handle	(	CURLM *	multi_handle,
		CURL *	curl_handle )

curl_multi_setopt()

CURL_EXTERN CURLMcode curl_multi_setopt	(	CURLM *	multi_handle,
		CURLMoption	option,
			... )

curl_multi_socket_action()

CURL_EXTERN CURLMcode curl_multi_socket_action	(	CURLM *	multi_handle,
		curl_socket_t	s,
		int	ev_bitmask,
		int *	running_handles )

curl_multi_strerror()

CURL_EXTERN const char * curl_multi_strerror

(

CURLMcode

)

curl_multi_timeout()

CURL_EXTERN CURLMcode curl_multi_timeout	(	CURLM *	multi_handle,
		long *	milliseconds )

curl_multi_wait()

CURL_EXTERN CURLMcode curl_multi_wait	(	CURLM *	multi_handle,
		struct curl_waitfd	extra_fds[],
		unsigned int	extra_nfds,
		int	timeout_ms,
		int *	ret )

curl_multi_waitfds()

CURL_EXTERN CURLMcode curl_multi_waitfds	(	CURLM *	multi,
		struct curl_waitfd *	ufds,
		unsigned int	size,
		unsigned int *	fd_count )

curl_multi_wakeup()

CURL_EXTERN CURLMcode curl_multi_wakeup

(

CURLM *

multi_handle

)

curl_pushheader_byname()

CURL_EXTERN char * curl_pushheader_byname	(	struct curl_pushheaders *	h,
		const char *	name )

curl_pushheader_bynum()

CURL_EXTERN char * curl_pushheader_bynum	(	struct curl_pushheaders *	h,
		size_t	num )

Variable Documentation

running_handles

CURL_EXTERN CURLMcode int * running_handles

Definition at line 318 of file multi.h.

s

CURL_EXTERN CURLMcode curl_socket_t s

Definition at line 318 of file multi.h.

Referenced by add_s(), add_s(), add_s(), add_s(), add_value(), add_value(), add_value(), add_value(), addliteral(), addliteral(), addquoted(), addquoted(), addquoted(), addquoted(), b_pack(), b_str2int(), b_str2int(), byteoffset(), byteoffset(), checkliteral(), checkliteral(), codepoint(), codepoint(), codestring(), codestring(), codestring(), codestring(), dav_lock_file(), dostring(), dostring(), dostring(), dostring(), duk__bi_mul(), duk__enc_double(), duk__toint32_touint32_helper(), duk_js_tointeger_number(), DumpString(), DumpString(), DumpString(), dumpString(), end_capture(), end_capture(), end_capture(), end_capture(), find(), g_write(), g_write(), g_write(), g_write(), get_month_index(), get_onecapture(), gmatch(), gmatch(), gmatch_aux(), gmatch_aux(), graphene_simd4f_max_val(), graphene_simd4f_min_val(), graphene_simd4x4f_init(), graphene_simd4x4f_sum(), graphene_simd4x4f_transpose(), is_civetweb_webdav_method(), is_lead_token(), is_put_or_delete_method(), is_whitespace(), isneg(), isneg(), isneg(), iter_aux(), iter_aux(), l_str2d(), l_str2d(), l_str2dloc(), l_str2dloc(), l_str2int(), l_str2int(), LoadHeader(), LoadHeader(), LoadString(), LoadString(), localtimeOffset(), lowercase(), lua_pushlstring(), lua_pushstring(), lua_stringtonumber(), lua_strx2number(), luaB_load(), luaB_load(), luaB_load(), luaB_loadstring(), luaB_print(), luaB_print(), luaB_print(), luaB_print(), luaB_tonumber(), luaB_tonumber(), luaB_tonumber(), luaK_stringK(), luaL_addgsub(), luaL_addlstring(), luaL_addstring(), luaL_addvalue(), luaL_checklstring(), luaL_checklstring(), luaL_gsub(), luaL_loadstring(), luaO_pushvfstring(), luaO_str2d(), luaO_str2d(), luaO_str2num(), luaS_newudata(), luaS_newudata(), luaS_newudata(), luaV_tostring(), luaX_token2str(), main(), main(), mainposition(), match(), match(), match(), match(), match_capture(), match_capture(), match_capture(), match_capture(), matchbalance(), matchbalance(), matchbalance(), matchbalance(), max_expand(), max_expand(), max_expand(), max_expand(), mg_get_cookie(), mg_get_var2(), min_expand(), min_expand(), min_expand(), min_expand(), newshrstr(), os_date(), os_date(), os_date(), os_date(), parse_auth_header(), parseHhMmSs(), pmain(), pmain(), prepare_cgi_environment(), prepstate(), prepstate(), PrintHeader(), PrintHeader(), PrintHeader(), PrintHeader(), PrintString(), PrintString(), PrintString(), PrintString(), push_captures(), push_captures(), push_captures(), push_captures(), push_onecapture(), push_onecapture(), push_onecapture(), push_onecapture(), put_dir(), quotefloat(), readhexa(), set_option(), singlematch(), singlematch(), singlematch(), skip_sep(), skip_sep(), skip_sep(), skip_sep(), sqlite3AtoF(), sqlite3GetVarint(), sqlite3IntFloatCompare(), sqlite3WindowCodeStep(), start_capture(), start_capture(), start_capture(), start_capture(), str_byte(), str_byte(), str_byte(), str_byte(), str_find_aux(), str_find_aux(), str_find_aux(), str_find_aux(), str_format(), str_format(), str_format(), str_format(), str_lower(), str_lower(), str_lower(), str_lower(), str_pack(), str_pack(), str_rep(), str_rep(), str_rep(), str_rep(), str_reverse(), str_reverse(), str_reverse(), str_reverse(), str_sub(), str_sub(), str_sub(), str_sub(), str_upper(), str_upper(), str_upper(), str_upper(), strftimeFunc(), doctest::detail::ContextScope< L >::stringify(), stringK(), Tokenizer_set(), tonum(), upvalname(), upvalname(), upvalname(), utf8_decode(), utf8_decode(), utflen(), utflen(), Xml_pushDecode(), and Xml_pushEncode().