Debian Codegraph @

deps/libneon/doc/ref/sessflags.xml

raw
1 <refentry id="refsessflags">
2
3 <refmeta>
4 <refentrytitle>ne_set_session_flag</refentrytitle>
5 <manvolnum>3</manvolnum>
6 </refmeta>
7
8 <refnamediv>
9 <refname id="ne_set_session_flag">ne_set_session_flag</refname>
10 <refname id="ne_get_session_flag">ne_get_session_flag</refname>
11 <refpurpose>set and retrieve session flags</refpurpose>
12 </refnamediv>
13
14 <refsynopsisdiv>
15
16 <funcsynopsis>
17
18 <funcsynopsisinfo>#include &lt;ne_request.h&gt;</funcsynopsisinfo>
19
20 <funcprototype>
21 <funcdef>void <function>ne_set_session_flag</function></funcdef>
22 <paramdef>ne_session *<parameter>sess</parameter></paramdef>
23 <paramdef>ne_session_flag <parameter>flag</parameter></paramdef>
24 <paramdef>int <parameter>value</parameter></paramdef>
25 </funcprototype>
26
27 <funcprototype>
28 <funcdef>int <function>ne_get_session_flag</function></funcdef>
29 <paramdef>ne_session *<parameter>sess</parameter></paramdef>
30 <paramdef>ne_session_flag <parameter>flag</parameter></paramdef>
31 </funcprototype>
32
33 </funcsynopsis>
34
35 </refsynopsisdiv>
36
37 <refsect1>
38 <title>Description</title>
39
40 <para>The <function>ne_set_session_flag</function> function
41 enables or disables a session flag. Passing a non-zero
42 <parameter>value</parameter> argument enables the flag, and zero
43 disables it.</para>
44
45 <para>The following flags are defined:</para>
46
47 <variablelist>
48 <varlistentry>
49 <term><constant>NE_SESSFLAG_PERSIST</constant></term>
50 <listitem>
51 <simpara>disable this flag to prevent use of persistent
52 connections</simpara>
53 </listitem>
54 </varlistentry>
55 <varlistentry>
56 <term><constant>NE_SESSFLAG_ICYPROTO</constant></term>
57 <listitem>
58 <simpara>enable this flag to enable support for non-HTTP
59 ShoutCast-style "ICY" responses</simpara>
60 </listitem>
61 </varlistentry>
62 <varlistentry>
63 <term><constant>NE_SESSFLAG_SSLv2</constant></term>
64 <listitem>
65 <simpara>disable this flag to disable support for the SSLv2
66 protocol</simpara>
67 </listitem>
68 </varlistentry>
69 <varlistentry>
70 <term><constant>NE_SESSFLAG_RFC4918</constant></term>
71 <listitem>
72 <simpara>enable this flag to enable support for
73 RFC4918-only WebDAV features; losing
74 backwards-compatibility with RFC2518 servers</simpara>
75 </listitem>
76 </varlistentry>
77 <varlistentry>
78 <term><constant>NE_SESSFLAG_CONNAUTH</constant></term>
79 <listitem>
80 <simpara>enable this flag if an RFC-violating
81 connection-based HTTP authentication scheme is in
82 use</simpara>
83 </listitem>
84 </varlistentry>
85 <varlistentry>
86 <term><constant>NE_SESSFLAG_TLS_SNI</constant></term>
87 <listitem>
88 <simpara>disable this flag if a server is used
89 which does not correctly support the TLS SNI
90 extension</simpara>
91 </listitem>
92 </varlistentry>
93 <varlistentry>
94 <term><constant>NE_SESSFLAG_EXPECT100</constant></term>
95 <listitem>
96 <simpara>enable this flag to enable the request flag
97 <constant>NE_REQFLAG_EXPECT100</constant> for new
98 requests</simpara>
99 </listitem>
100 </varlistentry>
101
102 </variablelist>
103 </refsect1>
104
105 <refsect1>
106 <title>Return value</title>
107
108 <para>The <function>ne_get_session_flag</function> function
109 returns zero if a flag is disabled, less than zero if the flag is
110 not supported, or greater than zero if the flag is enabled.</para>
111 </refsect1>
112
113 <refsect1>
114 <title>See also</title>
115
116 <para><xref linkend="ne_session_create"/>, <xref
117 linkend="ne_set_request_flag"/>.</para>
118
119 </refsect1>
120
121 </refentry>