opts: made stand-alone man-pages for several multi options

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(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

\fBcurl_off_t\fP type, depending on what the specific option expects. Read

this manual carefully as bad input values may cause libcurl to behave badly!

You can only set one option in each function call.

\fIcurl_multi_setopt(3)\fP is used to tell a libcurl multi handle how to

behave. By 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 \fBcurl_off_t\fP type, depending on what the specific option

expects. Read this manual carefully as bad input values may cause libcurl to

behave badly!  You can only set one option in each function call.

.SH OPTIONS

.IP CURLMOPT_SOCKETFUNCTION

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at http://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLMOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"

.SH NAME

CURLMOPT_MAXCONNECTS \- set size of connection cache

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_MAXCONNECTS, long max);

.SH DESCRIPTION

Pass a long indicating the \fBmax\fP. The set number will be used as the

maximum amount of simultaneously open connections that libcurl may keep in its

connection cache after completed use. By default libcurl will enlarge the size

for each added easy handle to make it fit 4 times the number of added easy

handles.

By setting this option, you can prevent the cache size from growing beyond the

limit set by you.

When the cache is full, curl closes the oldest one in the cache to prevent the

number of open connections from increasing.

This option is for the multi handle's use only, when using the easy interface

you should instead use the \fICURLOPT_MAXCONNECTS(3)\fP option.

See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP for limiting the number of active

connections.

.SH DEFAULT

See DESCRIPTION

.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.16.3

.SH RETURN VALUE

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "

.BR CURLOPT_MAXCONNECTS "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at http://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLMOPT_MAX_HOST_CONNECTIONS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"

.SH NAME

CURLMOPT_MAX_HOST_CONNECTIONS \- set max number of connections to a single host

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_MAX_HOST_CONNECTIONS, long max);

.SH DESCRIPTION

Pass a long to indicate \fBmax\fP. The set number will be used as the maximum

amount of simultaneously open connections to a single host. For each new

session to a host, libcurl will open a new connection up to the limit set by

\fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP. When the limit is reached, the

sessions will be pending until a connection becomes available. If

\fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to pipeline if the

host is capable of it.

The default \fBmax\fP value is 0, unlimited.  However, for backwards

compatibility, setting it to 0 when \fICURLMOPT_PIPELINING(3)\fP is 1 will not

be treated as unlimited. Instead it will open only 1 connection and try to

pipeline on it.

.SH DEFAULT

0

.SH PROTOCOLS

HTTP(S)

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.30.0

.SH RETURN VALUE

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_TOTAL_CONNECTIONS "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at http://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLMOPT_PIPELINING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"

.SH NAME

CURLMOPT_PIPELINING \- enable/disable HTTP pipelining

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_PIPELINING, bool onoff);

.SH DESCRIPTION

Set the \fBonoff\fP parameter to 1 to make libcurl use HTTP pipelining for

HTTP transfers done using this multi handle, as far as possible. This means

that if you add a second request that can use an already existing connection,

the second request will be \&"piped" on the same connection rather than being

executed in parallel.

When using pipelining, there are also several other related options that are

interesting to tweak and adjust to alter how libcurl spreads out requests on

different connections or not etc.

.SH DEFAULT

0 (off)

.SH PROTOCOLS

HTTP(S)

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.16.0

.SH RETURN VALUE

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "

.BR CURLMOPT_PIPELINING_SITE_BL "(3), "

.BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "

.BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "

.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "

.BR CURLMOPT_MAXCONNECTS "(3), "

.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at http://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLMOPT_SOCKETDATA 3 "3 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"

.SH NAME

CURLMOPT_SOCKETDATA \- custom pointer passed to the socket callback

.SH SYNOPSIS

.nf

#include <curl/curl.h>

CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_SOCKETDATA, void *pointer);

.SH DESCRIPTION

A data \fIpointer\fP to pass to the socket callback set with the

\fICURLMOPT_SOCKETFUNCTION(3)\fP option.

This pointer will not be touched by libcurl but will only be passed in to the

socket callbacks's \fBuserp\fP argument.

.SH DEFAULT

NULL

.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.15.4

.SH RETURN VALUE

Returns CURLM_OK.

.SH "SEE ALSO"

.BR CURLMOPT_SOCKETFUNCTION "(3), " curl_multi_socket_action "(3), "

.BR CURLMOPT_TIMERFUNCTION "(3) "