docs/libcurl/opts/CURLMOPT_PIPELINING_SERVER_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 http://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_SERVER_BL 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_PIPELINING_SERVER_BL \- pipelining server blacklist
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING_SERVER_BL, char **servers);
  30 .SH DESCRIPTION
  31 Pass a \fBservers\fP array of char *, ending with a NULL entry. This is a list
  32 of server types prefixes (in the Server: HTTP header) that are blacklisted
  33 from pipelining, i.e server types that are known to not support HTTP
  34 pipelining. The array is copied by libcurl.
  35
  36 Note that the comparison matches if the Server: header begins with the string
  37 in the blacklist, i.e "Server: Ninja 1.2.3" and "Server: Ninja 1.4.0" can
  38 both be blacklisted by having "Ninja" in the backlist.
  39
  40 Pass a NULL pointer to clear the blacklist.
  41 .SH DEFAULT
  42 The default value is NULL, which means that there is no blacklist.
  43 .SH PROTOCOLS
  44 .SH EXAMPLE
  45 .nf
  46   server_blacklist[] =
  47   {
  48     "Microsoft-IIS/6.0",
  49     "nginx/0.8.54",
  50     NULL
  51   };
  52
  53   curl_multi_setopt(m, CURLMOPT_PIPELINE_SERVER_BL, server_blacklist);
  54 .fi
  55 .SH AVAILABILITY
  56 Added in 7.30.0
  57 .SH RETURN VALUE
  58 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  59 .SH "SEE ALSO"
  60 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_PIPELINING_SITE_BL "(3), "