Change include of thread.hpp
[metaproxy-moved-to-github.git] / doc / multi.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-multi">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <info><orgname>Index Data</orgname></info>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>multi</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17  </refmeta>
18
19  <refnamediv>
20   <refname>multi</refname>
21   <refpurpose>Metaproxy Package Multiplexer Module</refpurpose>
22  </refnamediv>
23
24  <refsect1><title>DESCRIPTION</title>
25   <para>
26    This filter multiplexes packages.
27   </para>
28   <para>
29    The multi filter consists of zero or more
30    <literal>&lt;target&gt;</literal> elements.
31    If a target matches a given target specified as CDATA in the
32    target element, the multi filter will route traffic to the route
33    given by the route attribute.
34   </para>
35   <para>
36    A target element is not required for multi-plexing to work.
37    It merely serves as a way to route differently.
38   </para>
39   <para>
40    If an empty
41    <literal>&lt;hideunavailable&gt;</literal>
42    element is placed inside the
43    <literal>multi</literal>
44    filter, then unavailable databases are not reported to the client,
45    but simply ignored (unless every one of the databases is
46    unavailable).
47   </para>
48   <para>
49    If an empty
50    <literal>&lt;hideerrors&gt;</literal>
51    element is placed inside the
52    <literal>multi</literal>
53    filter, then databases that reports diagnostics are not reported back
54    to the client, but simply ignored (unless every one of the databases report
55    diagnostics).
56   </para>
57  </refsect1>
58
59  <refsect1><title>SCHEMA</title>
60    <literallayout><xi:include
61                      xi:href="../xml/schema/filter_multi.rnc"
62                      xi:parse="text"
63                      xmlns:xi="http://www.w3.org/2001/XInclude" />
64    </literallayout>
65  </refsect1>
66
67  <refsect1><title>EXAMPLES</title>
68   <para>
69    A typical configuration looks like this:
70    <screen><![CDATA[
71     <filter type="multi">
72      <target route="route1">z3950.loc.gov:7090/voyager</target>
73      <target route="route2">bagel.indexdata.dk/gils</target>
74      <target route="other">*</target>
75     </filter>
76 ]]>
77    </screen>
78   </para>
79
80  </refsect1>
81
82  <refsect1><title>SEE ALSO</title>
83   <para>
84    <citerefentry>
85     <refentrytitle>metaproxy</refentrytitle>
86     <manvolnum>1</manvolnum>
87    </citerefentry>
88   </para>
89   <para>
90    <citerefentry>
91     <refentrytitle>virt_db</refentrytitle>
92     <manvolnum>3mp</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: nxml
103 nxml-child-indent: 1
104 End:
105 -->