X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fsession_shared.xml;h=8b0ad1cf83c362ecedf2a800f9d57717db10516f;hb=586d78659d671683f33ec55f4a7d32b28e345ccd;hp=a5d545143d48c977c75738fc4d38ec39ebfa2c11;hpb=6ce31309381822f3fe2a5364be1cd73a7472d62f;p=metaproxy-moved-to-github.git

diff --git a/doc/session_shared.xml b/doc/session_shared.xml
index a5d5451..8b0ad1c 100644
--- a/doc/session_shared.xml
+++ b/doc/session_shared.xml
@@ -1,4 +1,4 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
  <!ENTITY % idcommon SYSTEM "common/common.ent">
@@ -15,13 +15,13 @@
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>session_shared</refname>
-  <refpurpose> Metaproxy Module for sharing system ressorces between 
+  <refpurpose> Metaproxy Module for sharing system ressorces between
    threads</refpurpose>
  </refnamediv>
- 
+
  <refsect1><title>DESCRIPTION</title>
   <para>
    This filter implements global sharing of
@@ -61,12 +61,23 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry><term>Session max</term>
+     <listitem>
+      <para>
+       Specifiers maximum number of sessions to any particular
+       target. If this number (limit) is reached, the session_shared
+       module will re-use result sets even if TTL is not met.
+       Failing that the session_shared will return a diagnostic.
+       Default value is 100 sessions.
+      </para>
+     </listitem>
+    </varlistentry>
     <varlistentry><term>Result-Set TTL</term>
      <listitem>
       <para>
        When a backend session result-set is not in use for more than this
        amount of time, given in seconds, it will be deleted/reused.
-       Default value is 10 seconds.
+       Default value is 30 seconds.
       </para>
      </listitem>
     </varlistentry>
@@ -80,6 +91,17 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry><term>Result-Set restart</term>
+     <listitem>
+      <para>
+       Boolean which specifies whether session_shared should to try to
+       recover a failed search. If a search results in diagnostic 2:
+       temporary system error, or a negative hit count, the search
+       will be performed once again on another or new Z39.50 session.
+       Default value is true (enabled).
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
@@ -87,24 +109,24 @@
  <refsect1><title>SCHEMA</title>
    <literallayout><xi:include
 		     xi:href="../xml/schema/filter_session_shared.rnc"
-		     xi:parse="text"  
+		     xi:parse="text"
 		     xmlns:xi="http://www.w3.org/2001/XInclude" />
    </literallayout>
  </refsect1>
- 
+
  <refsect1><title>EXAMPLES</title>
   <para>
    Configuration:
    <screen><![CDATA[
     <filter type="session_shared">
-     <resultset ttl="10" max="3"/>
-     <session ttl="30"/>
+     <resultset ttl="10" max="3" restart="true"/>
+     <session ttl="30" max="100"/>
     </filter>
 ]]>
    </screen>
   </para>
- </refsect1> 
- 
+ </refsect1>
+
  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
@@ -113,7 +135,7 @@
    </citerefentry>
   </para>
  </refsect1>
- 
+
  &copyright;
 </refentry>