ne_set_session_flag.3 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. '\" t
  2. .\" Title: ne_set_session_flag
  3. .\" Author:
  4. .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
  5. .\" Date: 23 November 2024
  6. .\" Manual: neon API reference
  7. .\" Source: neon 0.34.0
  8. .\" Language: English
  9. .\"
  10. .TH "NE_SET_SESSION_FLAG" "3" "23 November 2024" "neon 0.34.0" "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_session_flag, ne_get_session_flag \- set and retrieve session 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_session_flag('u
  40. .BI "void ne_set_session_flag(ne_session\ *" "sess" ", ne_session_flag\ " "flag" ", int\ " "value" ");"
  41. .HP \w'int\ ne_get_session_flag('u
  42. .BI "int ne_get_session_flag(ne_session\ *" "sess" ", ne_session_flag\ " "flag" ");"
  43. .SH "DESCRIPTION"
  44. .PP
  45. The
  46. \fBne_set_session_flag\fR
  47. function enables or disables a session 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_SESSFLAG_PERSIST\fR (default on)
  54. .RS 4
  55. disable this flag to prevent use of persistent connections
  56. .RE
  57. .PP
  58. \fBNE_SESSFLAG_ICYPROTO\fR (default off)
  59. .RS 4
  60. enable this flag to enable support for non\-HTTP ShoutCast\-style "ICY" responses
  61. .RE
  62. .PP
  63. \fBNE_SESSFLAG_SSLv2\fR (default on)
  64. .RS 4
  65. disable this flag to disable support for the SSLv2 protocol
  66. .RE
  67. .PP
  68. \fBNE_SESSFLAG_RFC4918\fR (default off)
  69. .RS 4
  70. enable this flag to enable support for RFC4918\-only WebDAV features; losing backwards\-compatibility with RFC2518 servers
  71. .RE
  72. .PP
  73. \fBNE_SESSFLAG_CONNAUTH\fR (default off)
  74. .RS 4
  75. enable this flag if an RFC\-violating connection\-based HTTP authentication scheme is in use
  76. .RE
  77. .PP
  78. \fBNE_SESSFLAG_TLS_SNI\fR (default off)
  79. .RS 4
  80. disable this flag if a server is used which does not correctly support the TLS SNI extension
  81. .RE
  82. .PP
  83. \fBNE_SESSFLAG_EXPECT100\fR (default off)
  84. .RS 4
  85. enable this flag to enable the request flag
  86. \fBNE_REQFLAG_EXPECT100\fR
  87. for new requests
  88. .RE
  89. .PP
  90. \fBNE_SESSFLAG_SHAREPOINT\fR (default off)
  91. .RS 4
  92. enable this flag to use various workarounds to improve interoperability with SharePoint
  93. .RE
  94. .PP
  95. \fBNE_SESSFLAG_STRICT\fR (default on)
  96. .RS 4
  97. disable this flag to parse HTTP/1\&.1 messages without strict requirements introduced in RFC 7230 and later
  98. .RE
  99. .SH "RETURN VALUE"
  100. .PP
  101. The
  102. \fBne_get_session_flag\fR
  103. 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\&.
  104. .SH "SEE ALSO"
  105. .PP
  106. ne_session_create,
  107. ne_set_request_flag\&.
  108. .SH "COPYRIGHT"
  109. .br
  110. Copyright \(co 2001-2024 Joe Orton
  111. .br