doc/ref/sessflags.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

<refentry id="refsessflags">

  <refmeta>
    <refentrytitle>ne_set_session_flag</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname id="ne_set_session_flag">ne_set_session_flag</refname>
    <refname id="ne_get_session_flag">ne_get_session_flag</refname>
    <refpurpose>set and retrieve session flags</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>

    <funcsynopsis>

      <funcsynopsisinfo>#include &lt;ne_request.h&gt;</funcsynopsisinfo>

      <funcprototype>
        <funcdef>void <function>ne_set_session_flag</function></funcdef>
        <paramdef>ne_session *<parameter>sess</parameter></paramdef>
        <paramdef>ne_session_flag <parameter>flag</parameter></paramdef>
        <paramdef>int <parameter>value</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>ne_get_session_flag</function></funcdef>
        <paramdef>ne_session *<parameter>sess</parameter></paramdef>
        <paramdef>ne_session_flag <parameter>flag</parameter></paramdef>
      </funcprototype>

    </funcsynopsis>

  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>The <function>ne_set_session_flag</function> function
    enables or disables a session flag.  Passing a non-zero
    <parameter>value</parameter> argument enables the flag, and zero
    disables it.</para>

    <para>The following flags are defined:</para>

	<variablelist>
	  <varlistentry>
            <term><constant>NE_SESSFLAG_PERSIST</constant></term>
	    <listitem>
	      <simpara>disable this flag to prevent use of persistent
	      connections</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
            <term><constant>NE_SESSFLAG_ICYPROTO</constant></term>
	    <listitem>
	      <simpara>enable this flag to enable support for non-HTTP
	      ShoutCast-style "ICY" responses</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
            <term><constant>NE_SESSFLAG_SSLv2</constant></term>
	    <listitem>
	      <simpara>disable this flag to disable support for the SSLv2
	      protocol</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
            <term><constant>NE_SESSFLAG_RFC4918</constant></term>
	    <listitem>
	      <simpara>enable this flag to enable support for
	      RFC4918-only WebDAV features; losing
	      backwards-compatibility with RFC2518 servers</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
            <term><constant>NE_SESSFLAG_CONNAUTH</constant></term>
	    <listitem>
	      <simpara>enable this flag if an RFC-violating
	      connection-based HTTP authentication scheme is in
	      use</simpara>
	    </listitem>
	  </varlistentry>

        </variablelist>
  </refsect1>

  <refsect1>
    <title>Return value</title>

    <para>The <function>ne_get_session_flag</function> 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.</para>
  </refsect1>

  <refsect1>
    <title>See also</title>

    <para><xref linkend="ne_session_create"/>.</para>

  </refsect1>

</refentry>