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 ]>
   5 <!-- $Id: session_shared.xml,v 1.5 2007-01-18 09:12:00 adam Exp $ -->
   6 <refentry>
   7  <refmeta>
   8   <refentrytitle>session_shared</refentrytitle>
   9   <manvolnum>3mp</manvolnum>
  10   <refmiscinfo>Metaproxy Module</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>session_shared</refname>
  15   <refpurpose>Module for sharing result-sets etc. between threads</refpurpose>
  16  </refnamediv>
  17
  18  <refsect1><title>DESCRIPTION</title>
  19   <para>
  20    This module allows many Z39.50 frontend sessions to share
  21    a number of backend sessions. The purpose is this filter is to:
  22    <itemizedlist>
  23     <listitem>
  24      <para>
  25       Reduce the number of backend server sessions.
  26      </para>
  27     </listitem>
  28     <listitem>
  29      <para>
  30       Reduce number of Initializations with backend servers.
  31      </para>
  32     </listitem>
  33     <listitem>
  34      <para>
  35       Optimize the use of result-sets.
  36       </para>
  37      </listitem>
  38    </itemizedlist>
  39   </para>
  40   <para>
  41    Configurable values:
  42    <variablelist>
  43     <varlistentry><term>Session TTL</term>
  44      <listitem>
  45       <para>
  46        When a backend session is idle for more than this amount of
  47        time, given in seconds, it will be closed. Default value
  48        is 90 seconds.
  49       </para>
  50      </listitem>
  51     </varlistentry>
  52     <varlistentry><term>Result-Set TTL</term>
  53      <listitem>
  54       <para>
  55        When a backend session result-set is not in use for more than this
  56        amount of time, given in seconds, it will be deleted/reused.
  57        Default value is 10 seconds.
  58       </para>
  59      </listitem>
  60     </varlistentry>
  61     <varlistentry><term>Result-Set max</term>
  62      <listitem>
  63       <para>
  64        This specifies the maximum number of result-sets in use by
  65        a backend. The number only applies to targets/servers with named
  66        result sets. Targets that do not support named result sets
  67        may only have one active result set. Default value is 10.
  68       </para>
  69      </listitem>
  70     </varlistentry>
  71    </variablelist>
  72   </para>
  73  </refsect1>
  74
  75  <refsect1><title>EXAMPLES</title>
  76   <para>
  77    Configuration:
  78    <screen><![CDATA[
  79     <filter type="session_shared">
  80      <resultset ttl="10" max="3"/>
  81      <session ttl="30"/>
  82     </filter>
  83 ]]>
  84    </screen>
  85   </para>
  86  </refsect1>
  87
  88  <refsect1><title>SEE ALSO</title>
  89   <para>
  90    <citerefentry>
  91     <refentrytitle>metaproxy</refentrytitle>
  92     <manvolnum>1</manvolnum>
  93    </citerefentry>
  94   </para>
  95  </refsect1>
  96
  97  &copyright;
  98 </refentry>
  99
 100 <!-- Keep this comment at the end of the file
 101 Local variables:
 102 mode: sgml
 103 sgml-omittag:t
 104 sgml-shorttag:t
 105 sgml-minimize-attributes:nil
 106 sgml-always-quote-attributes:t
 107 sgml-indent-step:1
 108 sgml-indent-data:t
 109 sgml-parent-document:nil
 110 sgml-local-catalogs: nil
 111 sgml-namecase-general:t
 112 End:
 113 -->