CURLMOPT_PIPELINING_SITE_BL.3 2.2 KB

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