CURLMOPT_PIPELINING_SITE_BL.3 2.1 KB

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