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">
7 <refentry id="ref-session_shared">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>session_shared</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>session_shared</refname>
21 <refpurpose> Metaproxy Module for sharing system ressorces between
25 <refsect1><title>DESCRIPTION</title>
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:
37 Reduce the number of backend server sessions.
42 Reduce the number of initializations with backend servers.
47 Optimize the use of result-sets.
55 <varlistentry><term>Session TTL</term>
58 When a backend session is idle for more than this amount of
59 time, given in seconds, it will be closed. Default value
64 <varlistentry><term>Session max</term>
67 Specifiers maximum number of sessions to any particular
68 target. If this number (limit) is reached, the session_shared
69 module will re-use result sets even if TTL is not met.
70 Failing that the session_shared will return a diagnostic.
71 Default value is 100 sessions.
75 <varlistentry><term>Result-Set TTL</term>
78 When a backend session result-set is not in use for more than this
79 amount of time, given in seconds, it will be deleted/reused.
80 Default value is 30 seconds.
84 <varlistentry><term>Result-Set max</term>
87 This specifies the maximum number of result-sets in use by
88 a backend. The number only applies to targets/servers with named
89 result sets. Targets that do not support named result sets
90 may only have one active result set. Default value is 10.
98 <refsect1><title>SCHEMA</title>
99 <literallayout><xi:include
100 xi:href="../xml/schema/filter_session_shared.rnc"
102 xmlns:xi="http://www.w3.org/2001/XInclude" />
106 <refsect1><title>EXAMPLES</title>
110 <filter type="session_shared">
111 <resultset ttl="10" max="3"/>
119 <refsect1><title>SEE ALSO</title>
122 <refentrytitle>metaproxy</refentrytitle>
123 <manvolnum>1</manvolnum>
131 <!-- Keep this comment at the end of the file