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