CURLMOPT_PIPELINING_SERVER_BL.3 2.3 KB

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