Return to curl_multi_setopt.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_multi_setopt.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .TH curl_multi_setopt 3 "September 24, 2019" "libcurl 7.70.0" "libcurl Manual"
        !            23: 
        !            24: .SH NAME
        !            25: curl_multi_setopt \- set options for a curl multi handle
        !            26: .SH SYNOPSIS
        !            27: #include <curl/curl.h>
        !            28: 
        !            29: CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param);
        !            30: .SH DESCRIPTION
        !            31: \fIcurl_multi_setopt(3)\fP is used to tell a libcurl multi handle how to
        !            32: behave. By using the appropriate options to \fIcurl_multi_setopt(3)\fP, you
        !            33: can change libcurl's behaviour when using that multi handle.  All options are
        !            34: set with the \fIoption\fP followed by the parameter \fIparam\fP. That
        !            35: parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject
        !            36: pointer\fP or a \fBcurl_off_t\fP type, depending on what the specific option
        !            37: expects. Read this manual carefully as bad input values may cause libcurl to
        !            38: behave badly!  You can only set one option in each function call.
        !            39: 
        !            40: .SH OPTIONS
        !            41: .IP CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE
        !            42: See \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP
        !            43: .IP CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE
        !            44: See \fICURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)\fP
        !            45: .IP CURLMOPT_MAX_HOST_CONNECTIONS
        !            46: See \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP
        !            47: .IP CURLMOPT_MAX_PIPELINE_LENGTH
        !            48: See \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP
        !            49: .IP CURLMOPT_MAX_TOTAL_CONNECTIONS
        !            50: See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP
        !            51: .IP CURLMOPT_MAXCONNECTS
        !            52: See \fICURLMOPT_MAXCONNECTS(3)\fP
        !            53: .IP CURLMOPT_PIPELINING
        !            54: See \fICURLMOPT_PIPELINING(3)\fP
        !            55: .IP CURLMOPT_PIPELINING_SITE_BL
        !            56: See \fICURLMOPT_PIPELINING_SITE_BL(3)\fP
        !            57: .IP CURLMOPT_PIPELINING_SERVER_BL
        !            58: See \fICURLMOPT_PIPELINING_SERVER_BL(3)\fP
        !            59: .IP CURLMOPT_PUSHFUNCTION
        !            60: See \fICURLMOPT_PUSHFUNCTION(3)\fP
        !            61: .IP CURLMOPT_PUSHDATA
        !            62: See \fICURLMOPT_PUSHDATA(3)\fP
        !            63: .IP CURLMOPT_SOCKETFUNCTION
        !            64: See \fICURLMOPT_SOCKETFUNCTION(3)\fP
        !            65: .IP CURLMOPT_SOCKETDATA
        !            66: See \fICURLMOPT_SOCKETDATA(3)\fP
        !            67: .IP CURLMOPT_TIMERFUNCTION
        !            68: See \fICURLMOPT_TIMERFUNCTION(3)\fP
        !            69: .IP CURLMOPT_TIMERDATA
        !            70: See \fICURLMOPT_TIMERDATA(3)\fP
        !            71: .IP CURLMOPT_MAX_CONCURRENT_STREAMS
        !            72: See \fICURLMOPT_MAX_CONCURRENT_STREAMS(3)\fP
        !            73: .SH RETURNS
        !            74: The standard CURLMcode for multi interface error codes. Note that it returns a
        !            75: CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl
        !            76: doesn't know of.
        !            77: .SH AVAILABILITY
        !            78: This function was added in libcurl 7.15.4.
        !            79: .SH "SEE ALSO"
        !            80: .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
        !            81: .BR curl_multi_socket "(3), " curl_multi_info_read "(3)"