initial and still basic curl multi interface documentation

.\" $Id$

.\"

.TH curl_multi_add_handle 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"

.SH NAME

curl_multi_add_handle - add an easy handle to a multi session

.SH SYNOPSIS

#include <curl/curl.h>

CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);

.ad

.SH DESCRIPTION

Adds a standard easy handle to the multi stack. This will make this multi

handle control the specified easy handle.

.SH RETURN VALUE

CURLMcode type, general libcurl multi interface error code.

.SH "SEE ALSO"

.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"

.\" $Id$

.\"

.TH curl_multi_cleanup 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"

.SH NAME

curl_multi_cleanup - close down a multi session

.SH SYNOPSIS

.B #include <curl/curl.h>

.sp

.BI "CURLMcode curl_multi_cleanup( CURLM *multi_handle );"

.ad

.SH DESCRIPTION

Cleans up and removes a whole multi stack. It does not free or touch any

individual easy handles in any way - they still need to be closed

individually, using the usual curl_easy_cleanup() way.

.SH RETURN VALUE

CURLMcode type, general libcurl multi interface error code.

.SH "SEE ALSO"

.BR curl_multi_init "(3)," curl_easy_cleanup "(3)," curl_easy_init "(3)"

.\" $Id$

.\"

.TH curl_multi_fdset 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"

.SH NAME

curl_multi_fdset - add an easy handle to a multi session

.SH SYNOPSIS

#include <curl/curl.h>

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);

.ad

.SH DESCRIPTION

This function extracts file descriptor information from a given multi_handle.

libcurl returns its fd_set sets. The application can use these to select() or

poll() on. The curl_multi_perform() function should be called as soon as one

of them are ready to be read from or written to.

.SH RETURN VALUE

CURLMcode type, general libcurl multi interface error code.

.SH "SEE ALSO"

.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"

.\" $Id$

.\"

.TH curl_multi_info_read 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"

.SH NAME

curl_multi_info_read - read multi stack informationals

.SH SYNOPSIS

#include <curl/curl.h>

CURLMsg *curl_multi_info_read( CURLM *multi_handle,

                               int *msgs_in_queue);

.ad

.SH DESCRIPTION

Ask the multi handle if there's any messages/informationals from the

individual transfers. Messages include informationals such as an error code

from the transfer or just the fact that a transfer is completed. More details

on these should be written down as well.

Repeated calls to this function will return a new struct each time, until a

special "end of msgs" struct is returned as a signal that there is no more to

get at this point. The integer pointed to with \fImsgs_in_queue\fP will

contain the number of remaining messages after this function was called.

The data the returned pointer points to will not survive calling

curl_multi_cleanup().

The 'CURLMsg' struct is very simple and only contain very basic informations.

If more involved information is wanted, the particular "easy handle" in

present in that struct and can thus be used in subsequent regular

curl_easy_getinfo() calls (or similar).

.SH "RETURN VALUE"

A pointer to a filled-in struct, or NULL if it failed or ran out of

structs. It also writes the number of messages left in the queue (after this

read) in the integer the second argument points to.

.SH "SEE ALSO"

.BR curl_multi_cleanup "(3)," curl_multi_init "(3)," curl_multi_perform "(3)"

.\" $Id$

.\"

.TH curl_multi_init 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"

.SH NAME

curl_multi_init - Start a multi session

.SH SYNOPSIS

.B #include <curl/curl.h>

.sp

.BI "CURLM *curl_multi_init( );"

.ad

.SH DESCRIPTION

This function returns a CURLM handle to be used as input to all the other

multi-functions. This init call MUST have a corresponding call to

\fIcurl_multi_cleanup\fP when the operation is complete.

.SH RETURN VALUE

If this function returns NULL, something went wrong and you cannot use the

other curl functions.

.SH "SEE ALSO"

.BR curl_multi_cleanup "(3)," curl_global_init "(3)," curl_easy_init "(3)"

.SH BUGS

Surely there are some, you tell me!