DB: Add refentryinfo for man pages
[metaproxy-moved-to-github.git] / doc / load_balance.xml
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">
5      %idcommon;
6 ]>
7 <refentry id="ref-load_balance">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <info><orgname>Index Data</orgname></info>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>load_balance</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17  </refmeta>
18  
19  <refnamediv>
20   <refname>load_balance</refname>
21   <refpurpose>Metaproxy Module balancing load among multiple identical
22   Z39.50 targets</refpurpose>
23  </refnamediv>
24  
25  <refsect1><title>DESCRIPTION</title>
26   <para>
27    This filter balances load among Z39.50 targets based on statistics
28    gathered on number of open sessions and number of open package requests. 
29   </para>
30   <para>
31    The load balancing is depending on targets to be specified (vhosts).
32    Most Z39.50 clients do not specify that. For this reason, this
33    filter is mostly used as a follower to filter virt_db.
34   </para>
35  </refsect1>
36  
37  <refsect1><title>EXAMPLES</title>
38   <para>
39    This configuration offers one database, <literal>Default</literal>,
40    which is load-balanced between two backend servers.
41    <screen><![CDATA[
42     <filter type="virt_db"/>
43       <database>Default</database>
44       <target>host1:210/Default</target>
45       <target>host2:210/Default</target>
46     </filter>
47     <filter type="load_balance"/>
48 ]]>
49    </screen>
50   </para>
51   
52  </refsect1> 
53  
54  <refsect1><title>SEE ALSO</title>
55   <para>
56    <citerefentry>
57     <refentrytitle>virt_db</refentrytitle>
58     <manvolnum>3mp</manvolnum>
59    </citerefentry>
60   </para>
61  </refsect1>
62  
63  &copyright;
64 </refentry>
65
66 <!-- Keep this comment at the end of the file
67 Local variables:
68 mode: sgml
69 sgml-omittag:t
70 sgml-shorttag:t
71 sgml-minimize-attributes:nil
72 sgml-always-quote-attributes:t
73 sgml-indent-step:1
74 sgml-indent-data:t
75 sgml-parent-document:nil
76 sgml-local-catalogs: nil
77 sgml-namecase-general:t
78 End:
79 -->