ne_set_request_flag.3 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. '\" t
  2. .\" Title: ne_set_request_flag
  3. .\" Author:
  4. .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  5. .\" Date: 23 September 2014
  6. .\" Manual: neon API reference
  7. .\" Source: neon 0.30.1
  8. .\" Language: English
  9. .\"
  10. .TH "NE_SET_REQUEST_FLAG" "3" "23 September 2014" "neon 0.30.1" "neon API reference"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. ne_set_request_flag, ne_get_request_flag \- set and retrieve per\-request flags
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <ne_request\&.h>
  37. .fi
  38. .ft
  39. .HP \w'void\ ne_set_request_flag('u
  40. .BI "void ne_set_request_flag(ne_request\ *" "req" ", ne_request_flag\ " "flag" ", int\ " "value" ");"
  41. .HP \w'int\ ne_get_request_flag('u
  42. .BI "int ne_get_request_flag(ne_request\ *" "req" ", ne_request_flag\ " "flag" ");"
  43. .SH "DESCRIPTION"
  44. .PP
  45. The
  46. \fBne_set_request_flag\fR
  47. function enables or disables a per\-request flag\&. Passing a non\-zero
  48. \fIvalue\fR
  49. argument enables the flag, and zero disables it\&.
  50. .PP
  51. The following flags are defined:
  52. .PP
  53. \fBNE_REQFLAG_EXPECT100\fR
  54. .RS 4
  55. enable this flag to use the "Expect: 100\-continue" feature of HTTP/1\&.1, which allows the server to process request headers without reading the entire request body\&. This saves time and bandwidth if the server gives an authentication challenge (requiring the request to be resent), but has interoperability problems with some older servers\&.
  56. .RE
  57. .PP
  58. \fBNE_REQFLAG_IDEMPOTENT\fR
  59. .RS 4
  60. disable this flag if the request uses a non\-idempotent method such as
  61. POST
  62. .RE
  63. .SH "RETURN VALUE"
  64. .PP
  65. The
  66. \fBne_get_request_flag\fR
  67. function returns zero if a flag is disabled, less than zero if the flag is not supported, or greater than zero if the flag is enabled\&.
  68. .SH "SEE ALSO"
  69. .PP
  70. ne_request_create\&.
  71. .SH "AUTHOR"
  72. .PP
  73. \fBJoe Orton\fR <\&[email protected]\&>
  74. .RS 4
  75. Author.
  76. .RE
  77. .SH "COPYRIGHT"
  78. .br