CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.3 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
  24. .SH NAME
  25. CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE \- size threshold for pipelining penalty
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE,
  30. long size);
  31. .fi
  32. .SH DESCRIPTION
  33. No function since pipelining was removed in 7.62.0.
  34. Pass a long with a \fBsize\fP in bytes. If a pipelined connection is currently
  35. processing a request with a Content-Length larger than this
  36. \fICURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)\fP, that pipeline will then not be
  37. considered for additional requests, even if it is shorter than
  38. \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
  39. .SH DEFAULT
  40. The default value is 0, which means that the size penalization is inactive.
  41. .SH PROTOCOLS
  42. HTTP(S)
  43. .SH EXAMPLE
  44. .nf
  45. CURLM *m = curl_multi_init();
  46. long maxlength = 10000;
  47. curl_multi_setopt(m, CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE, maxlength);
  48. .fi
  49. .SH AVAILABILITY
  50. Added in 7.30.0
  51. .SH RETURN VALUE
  52. Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  53. .SH "SEE ALSO"
  54. .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "