docs/libcurl/opts/CURLMOPT_PIPELINING_SITE_BL.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 .\"
  23 .TH CURLMOPT_PIPELINING_SITE_BL 3 "February 03, 2016" "libcurl 7.59.0" "curl_multi_setopt options"
  24
  25 .SH NAME
  26 CURLMOPT_PIPELINING_SITE_BL \- pipelining host blacklist
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING_SITE_BL, char **hosts);
  31 .SH DESCRIPTION
  32 Pass a \fBhosts\fP array of char *, ending with a NULL entry. This is a list
  33 of sites that are blacklisted from pipelining, i.e sites that are known to not
  34 support HTTP pipelining. The array is copied by libcurl.
  35
  36 Pass a NULL pointer to clear the blacklist.
  37 .SH DEFAULT
  38 The default value is NULL, which means that there is no blacklist.
  39 .SH PROTOCOLS
  40 HTTP(S)
  41 .SH EXAMPLE
  42 .nf
  43   site_blacklist[] =
  44   {
  45     "www.haxx.se",
  46     "www.example.com:1234",
  47     NULL
  48   };
  49
  50   curl_multi_setopt(m, CURLMOPT_PIPELINING_SITE_BL, site_blacklist);
  51 .fi
  52 .SH AVAILABILITY
  53 Added in 7.30.0
  54 .SH RETURN VALUE
  55 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  56 .SH "SEE ALSO"
  57 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_PIPELINING_SERVER_BL "(3), "