Jeff Pohlmeyer has been working with the hiperfifo.c example source code,

                                  Changelog

Daniel (12 October 2006)

- Jeff Pohlmeyer has been working with the hiperfifo.c example source code,

  and while doing so it became apparent that the current timeout system for

  the socket API really was a bit awkward since it become quite some work to

  be sure we have the correct timeout set.

  Jeff then provided the new CURLMOPT_TIMERFUNCTION that is yet another

  callback the app can set to get to know when the general timeout time

  changes and thus for an application like hiperfifo.c it makes everything a

  lot easier and nicer. There's a CURLMOPT_TIMERDATA option too of course in

  good old libcurl tradition.

  Jeff has also updated the hiperfifo.c example code to use this news.

Daniel (9 October 2006)

- Bogdan Nicula's second test case (posted Sun, 08 Oct 2006) converted to test

  case 535 and it now runs fine. Again a problem with the pipelining code not

This release includes the following changes:

 o Added CURLMOPT_TIMERFUNCTION

 o The CURLOPT_SOURCE_* options are removed and so are the --3p* command line

   options

 o curl_multi_socket() and family are suitable to start using

To get fixed in 7.16.0 (planned release: October 2006)

======================

67 - Jeff Pohlmeyer's test case

68 - Dmitriy Sergeyev's test02.c and test03.c

67 - Jeff Pohlmeyer's crashing pipelining test case

69 - 

.\" $Id$

.\"

.TH curl_multi_setopt 3 "8 Jan 2006" "libcurl 7.16.0" "libcurl Manual"

.TH curl_multi_setopt 3 "10 Oct 2006" "libcurl 7.16.0" "libcurl Manual"

.SH NAME

curl_multi_setopt \- set options for a curl multi handle

.SH SYNOPSIS

CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param);

.SH DESCRIPTION

curl_multi_setopt() is used to tell a libcurl multi handle how to behave. By

using the appropriate options to \fIcurl_multi_setopt\fP, you can change

using the appropriate options to \fIcurl_multi_setopt(3)\fP, you can change

libcurl's behaviour when using that multi handle.  All options are set with

the \fIoption\fP followed by the parameter \fIparam\fP. That parameter can be

a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject pointer\fP or a

.SH OPTIONS

.IP CURLMOPT_SOCKETFUNCTION

Pass a pointer to a function matching the curl_socket_callback prototype. The

\fIcurl_multi_socket(3)\fP functions inform the application about updates in

the socket (file descriptor) status by doing none, one or multiple calls to

the curl_socket_callback given in the \fBparam\fP argument. They update the

status with changes since the previous time a \fIcurl_multi_socket(3)\fP

function was called. If the given callback pointer is NULL, no callback will

be called. Set the callback's \fBuserp\fP argument with

\fICURLMOPT_SOCKETDATA\fP.  See \fIcurl_multi_socket(3)\fP for more callback

details.

Pass a pointer to a function matching the \fBcurl_socket_callback\fP

prototype. The \fIcurl_multi_socket(3)\fP functions inform the application

about updates in the socket (file descriptor) status by doing none, one or

multiple calls to the curl_socket_callback given in the \fBparam\fP

argument. They update the status with changes since the previous time a

\fIcurl_multi_socket(3)\fP function was called. If the given callback pointer

is NULL, no callback will be called. Set the callback's \fBuserp\fP argument

with \fICURLMOPT_SOCKETDATA\fP.  See \fIcurl_multi_socket(3)\fP for more

callback details.

.IP CURLMOPT_SOCKETDATA

Pass a pointer to whatever you want passed to the curl_socket_callback's forth

argument, the userp pointer. This is not used by libcurl but only passed-thru

as-is. Set the callback pointer with \fICURLMOPT_SOCKETFUNCTION\fP.

Pass a pointer to whatever you want passed to the \fBcurl_socket_callback\fP's

forth argument, the userp pointer. This is not used by libcurl but only

passed-thru as-is. Set the callback pointer with

\fICURLMOPT_SOCKETFUNCTION\fP.

.IP CURLMOPT_PIPELINING

Pass a long set to 1 to enable or 0 to disable. Enabling pipelining on a multi

handle will make it attempt to perform HTTP Pipelining as far as possible for

can use an already existing connection, the second request will be \&"piped"

on the same connection rather than being executed in parallell. (Added in

7.16.0)

.IP CURLMOPT_TIMERFUNCTION

Pass a pointer to a function matching the \fBcurl_multi_timer_callback\fP

prototype.  This function will then be called when the timeout value

changes. The timeout value is at what latest time the application should call

one of the \&"performing" functions of the multi interface

(\fIcurl_multi_socket(3)\fP, \fIcurl_multi_socket_all(3)\fP and

\fIcurl_multi_perform(3)\fP) - to allow libcurl to keep timeouts and retries

etc to work. Libcurl attempts to limit calling this only when the fixed future

timeout time actually change. See also \fICURLMOPT_TIMERDATA\fP. This callback

can be used instead of, or in addition to, \fIcurl_multi_timeout(3)\fP. (Added

in 7.16.0)

.IP CURLMOPT_TIMERDATA

Pass a pointer to whatever you want passed to the

\fBcurl_multi_timer_callback\fP's third argument, the userp pointer.  This is

not used by libcurl but only passed-thru as-is. Set the callback pointer with

\fICURLMOPT_TIMERFUNCTION\fP. (Added in 7.16.0)

.SH RETURNS

The standard CURLMcode for multi interface error codes. Note that it returns a

CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl

                                                        pointer */

                                    void *socketp);  /* private socket

                                                        pointer */

/*

 * Name:    curl_multi_timer_callback

 *

 * Desc:    Called by libcurl whenever the library detects a change in the

 *          maximum number of milliseconds the app is allowed to wait before

 *          curl_multi_socket() or curl_multi_perform() must be called

 *          (to allow libcurl's timed events to take place).

 *

 * Returns: The callback should return zero.

 */

typedef int (*curl_multi_timer_callback)(CURLM *multi,    /* multi handle */

                                         long timeout_ms, /* see above */

                                         void *userp);    /* private callback

                                                             pointer */

CURL_EXTERN CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t s,

                                        int *running_handles);

    /* set to 1 to enable pipelining for this multi handle */

  CINIT(PIPELINING, LONG, 3),

   /* This is the timer callback function pointer */

  CINIT(TIMERFUNCTION, FUNCTIONPOINT, 4),

  /* This is the argument passed to the timer callback */

  CINIT(TIMERDATA, OBJECTPOINT, 5),

  CURLMOPT_LASTENTRY /* the last unused */

} CURLMoption;