doc/session_shared.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-session_shared">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <info><orgname>Index Data</orgname></info>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>session_shared</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>session_shared</refname>
  21   <refpurpose> Metaproxy Module for sharing system ressorces between
  22    threads</refpurpose>
  23  </refnamediv>
  24
  25  <refsect1><title>DESCRIPTION</title>
  26   <para>
  27    This filter implements global sharing of
  28    result sets (i.e. between threads and therefore between
  29    clients), yielding performance improvements especially when
  30    incoming requests are from a stateless environment such as a
  31    web-server, in which the client process representing a session
  32    might be any one of many.
  33    It performs the following actions:
  34    <itemizedlist>
  35     <listitem>
  36      <para>
  37       Reduce the number of backend server sessions.
  38      </para>
  39     </listitem>
  40     <listitem>
  41      <para>
  42       Reduce the number of initializations with backend servers.
  43      </para>
  44     </listitem>
  45     <listitem>
  46      <para>
  47       Optimize the use of result-sets.
  48       </para>
  49      </listitem>
  50    </itemizedlist>
  51   </para>
  52   <para>
  53    Configurable values:
  54    <variablelist>
  55     <varlistentry><term>Session TTL</term>
  56      <listitem>
  57       <para>
  58        When a backend session is idle for more than this amount of
  59        time, given in seconds, it will be closed. Default value
  60        is 90 seconds.
  61       </para>
  62      </listitem>
  63     </varlistentry>
  64     <varlistentry><term>Result-Set TTL</term>
  65      <listitem>
  66       <para>
  67        When a backend session result-set is not in use for more than this
  68        amount of time, given in seconds, it will be deleted/reused.
  69        Default value is 10 seconds.
  70       </para>
  71      </listitem>
  72     </varlistentry>
  73     <varlistentry><term>Result-Set max</term>
  74      <listitem>
  75       <para>
  76        This specifies the maximum number of result-sets in use by
  77        a backend. The number only applies to targets/servers with named
  78        result sets. Targets that do not support named result sets
  79        may only have one active result set. Default value is 10.
  80       </para>
  81      </listitem>
  82     </varlistentry>
  83    </variablelist>
  84   </para>
  85  </refsect1>
  86
  87  <refsect1><title>SCHEMA</title>
  88    <literallayout><xi:include
  89                      xi:href="../xml/schema/filter_session_shared.rnc"
  90                      xi:parse="text"
  91                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  92    </literallayout>
  93  </refsect1>
  94
  95  <refsect1><title>EXAMPLES</title>
  96   <para>
  97    Configuration:
  98    <screen><![CDATA[
  99     <filter type="session_shared">
 100      <resultset ttl="10" max="3"/>
 101      <session ttl="30"/>
 102     </filter>
 103 ]]>
 104    </screen>
 105   </para>
 106  </refsect1>
 107
 108  <refsect1><title>SEE ALSO</title>
 109   <para>
 110    <citerefentry>
 111     <refentrytitle>metaproxy</refentrytitle>
 112     <manvolnum>1</manvolnum>
 113    </citerefentry>
 114   </para>
 115  </refsect1>
 116
 117  &copyright;
 118 </refentry>
 119
 120 <!-- Keep this comment at the end of the file
 121 Local variables:
 122 mode: sgml
 123 sgml-omittag:t
 124 sgml-shorttag:t
 125 sgml-minimize-attributes:nil
 126 sgml-always-quote-attributes:t
 127 sgml-indent-step:1
 128 sgml-indent-data:t
 129 sgml-parent-document:nil
 130 sgml-local-catalogs: nil
 131 sgml-namecase-general:t
 132 End:
 133 -->