doc/session_shared.xml

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