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. The target element may also apply
  34    credentials to be sent to the target. This is given by the
  35    <literal>auth</literal> attribute.
  36   </para>
  37   <para>
  38    A target element is not required for multi-plexing to work.
  39    It merely serves as a way to route differently.
  40   </para>
  41   <para>
  42    If an empty
  43    <literal>&lt;hideunavailable&gt;</literal>
  44    element is placed inside the
  45    <literal>multi</literal>
  46    filter, then unavailable databases are not reported to the client,
  47    but simply ignored (unless every one of the databases is
  48    unavailable).
  49   </para>
  50   <para>
  51    If an empty
  52    <literal>&lt;hideerrors&gt;</literal>
  53    element is placed inside the
  54    <literal>multi</literal>
  55    filter, then databases that reports diagnostics are not reported back
  56    to the client, but simply ignored (unless every one of the databases report
  57    diagnostics).
  58   </para>
  59  </refsect1>
  60
  61  <refsect1><title>SCHEMA</title>
  62    <literallayout><xi:include
  63                      xi:href="../xml/schema/filter_multi.rnc"
  64                      xi:parse="text"
  65                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  66    </literallayout>
  67  </refsect1>
  68
  69  <refsect1><title>EXAMPLES</title>
  70   <para>
  71    A typical configuration looks like this:
  72    <screen><![CDATA[
  73     <filter type="multi">
  74      <target route="route1">lx2.loc.gov:210/LCDB_MARC8</target>
  75      <target route="route2">z3950.indexdata.com/gils</target>
  76      <target route="route3" auth="myuser/mypass">localhost:9999</target>
  77      <target route="other">*</target>
  78     </filter>
  79 ]]>
  80    </screen>
  81   </para>
  82
  83  </refsect1>
  84
  85  <refsect1><title>SEE ALSO</title>
  86   <para>
  87    <citerefentry>
  88     <refentrytitle>metaproxy</refentrytitle>
  89     <manvolnum>1</manvolnum>
  90    </citerefentry>
  91   </para>
  92   <para>
  93    <citerefentry>
  94     <refentrytitle>virt_db</refentrytitle>
  95     <manvolnum>3mp</manvolnum>
  96    </citerefentry>
  97   </para>
  98  </refsect1>
  99
 100  &copyright;
 101 </refentry>
 102
 103 <!-- Keep this comment at the end of the file
 104 Local variables:
 105 mode: nxml
 106 nxml-child-indent: 1
 107 End:
 108 -->