X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fsession_shared.xml;h=8b0ad1cf83c362ecedf2a800f9d57717db10516f;hb=586d78659d671683f33ec55f4a7d32b28e345ccd;hp=5bc35ca335a8c5564dca4e0cd77740a8f199f240;hpb=a195993d409a326e940814b4ac9ebd2f7eae0471;p=metaproxy-moved-to-github.git diff --git a/doc/session_shared.xml b/doc/session_shared.xml index 5bc35ca..8b0ad1c 100644 --- a/doc/session_shared.xml +++ b/doc/session_shared.xml @@ -1,40 +1,132 @@ - + + %idcommon; ]> - - + + + Metaproxy + Index Data + + session_shared 3mp - Metaproxy Module + Metaproxy Module - + session_shared - Module for sharing result-sets etc. between threads + Metaproxy Module for sharing system ressorces between + threads - + DESCRIPTION - This module is experimental and NOT SUPPORTED. When complete, it - will enable Metaproxy to share resources such as result-sets - between multiple threads, yielding performance improvements. + This filter implements global sharing of + result sets (i.e. between threads and therefore between + clients), yielding performance improvements especially when + incoming requests are from a stateless environment such as a + web-server, in which the client process representing a session + might be any one of many. + It performs the following actions: + + + + Reduce the number of backend server sessions. + + + + + Reduce the number of initializations with backend servers. + + + + + Optimize the use of result-sets. + + + + + + Configurable values: + + Session TTL + + + When a backend session is idle for more than this amount of + time, given in seconds, it will be closed. Default value + is 90 seconds. + + + + Session max + + + 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. + + + + Result-Set TTL + + + 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 30 seconds. + + + + Result-Set max + + + This specifies the maximum number of result-sets in use by + a backend. The number only applies to targets/servers with named + result sets. Targets that do not support named result sets + may only have one active result set. Default value is 10. + + + + Result-Set restart + + + 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). + + + + + SCHEMA + + + + EXAMPLES - A typical configuration looks like this: + Configuration: - ### Not yet defined + + ]]> - - + + SEE ALSO @@ -43,21 +135,13 @@ - + ©right;