CURLMOPT_PIPELINING_SERVER_BL.3 2.5 KB

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