#include "curl.h"

Include dependency graph for multi.h:

This graph shows which files directly or indirectly include this file:

Classes
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_multi_socket (CURLM multi_handle, curl_socket_t s, int running_handles)

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_socket_all (CURLM multi_handle, 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 char *	curl_pushheader_bynum (struct curl_pushheaders *h, size_t num)

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

Macro Definition Documentation

◆ CURL_CSELECT_ERR

#define CURL_CSELECT_ERR 0x04

Definition at line 297 of file multi.h.

◆ CURL_CSELECT_IN

#define CURL_CSELECT_IN 0x01

Definition at line 295 of file multi.h.

◆ CURL_CSELECT_OUT

#define CURL_CSELECT_OUT 0x02

Definition at line 296 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 336 of file multi.h.

◆ CURL_POLL_IN

#define CURL_POLL_IN 1

Definition at line 288 of file multi.h.

◆ CURL_POLL_INOUT

#define CURL_POLL_INOUT 3

Definition at line 290 of file multi.h.

◆ CURL_POLL_NONE

#define CURL_POLL_NONE 0

Definition at line 287 of file multi.h.

◆ CURL_POLL_OUT

#define CURL_POLL_OUT 2

Definition at line 289 of file multi.h.

◆ CURL_POLL_REMOVE

#define CURL_POLL_REMOVE 4

Definition at line 291 of file multi.h.

◆ CURL_PUSH_DENY

#define CURL_PUSH_DENY 1

Definition at line 440 of file multi.h.

◆ CURL_PUSH_ERROROUT

#define CURL_PUSH_ERROROUT 2 /* added in 7.72.0 */

Definition at line 441 of file multi.h.

◆ CURL_PUSH_OK

#define CURL_PUSH_OK 0

Definition at line 439 of file multi.h.

◆ CURL_SOCKET_TIMEOUT

#define CURL_SOCKET_TIMEOUT CURL_SOCKET_BAD

Definition at line 293 of file multi.h.

◆ CURL_WAIT_POLLIN

#define CURL_WAIT_POLLIN 0x0001

Definition at line 114 of file multi.h.

◆ CURL_WAIT_POLLOUT

#define CURL_WAIT_POLLOUT 0x0004

Definition at line 116 of file multi.h.

◆ CURL_WAIT_POLLPRI

#define CURL_WAIT_POLLPRI 0x0002

Definition at line 115 of file multi.h.

◆ CURLM_CALL_MULTI_SOCKET

#define CURLM_CALL_MULTI_SOCKET CURLM_CALL_MULTI_PERFORM

Definition at line 87 of file multi.h.

◆ CURLPIPE_HTTP1

#define CURLPIPE_HTTP1 1L

Definition at line 91 of file multi.h.

◆ CURLPIPE_MULTIPLEX

#define CURLPIPE_MULTIPLEX 2L

Definition at line 92 of file multi.h.

◆ CURLPIPE_NOTHING

#define CURLPIPE_NOTHING 0L

Definition at line 90 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 316 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 450 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 299 of file multi.h.

◆ CURLM

typedef void CURLM

Definition at line 60 of file multi.h.

◆ CURLMsg

typedef struct CURLMsg CURLMsg

Definition at line 109 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 63 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're 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 351 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 94 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_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_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()

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

◆ 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_socket_all()

CURL_EXTERN CURLMcode curl_multi_socket_all	(	CURLM *	multi_handle,
		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_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
	)

Classes

Macros

Typedefs

Enumerations

Functions