GFS: Allow multiple listenrefs YAZ-554

[yaz-moved-to-github.git] / doc / gfs-virtual.xml

diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml
index bf9eac9..1250331 100644 (file)
--- a/doc/gfs-virtual.xml
+++ b/doc/gfs-virtual.xml
@@ -1,5 +1,4 @@
-<!-- 
-   $Id: gfs-virtual.xml,v 1.5 2006-04-24 12:41:00 marc Exp $
+<!--

    Description of the virtual host mechanism in YAZ GFS
    Included in both manual and man page for yaz-ztest
 -->
    Description of the virtual host mechanism in YAZ GFS
    Included in both manual and man page for yaz-ztest
 -->

@@ -30,7 +29,7 @@
 </note>
 <para>
  The YAZ frontend server uses XML to describe the backend
 </note>
 <para>
  The YAZ frontend server uses XML to describe the backend

- configurations. Command-line option <literal>-f</literal> 
+ configurations. Command-line option <literal>-f</literal>

  specifies filename of the XML configuration.
 </para>
 <para>
  specifies filename of the XML configuration.
 </para>
 <para>

@@ -40,14 +39,14 @@
 </para>
 <para>
  The <literal>listen</literal> describes listener (transport end point),
 </para>
 <para>
  The <literal>listen</literal> describes listener (transport end point),

- such as TCP/IP, Unix file socket or SSL server. Content for 
+ such as TCP/IP, Unix file socket or SSL server. Content for

  a listener:
  <variablelist>
   <varlistentry><term>CDATA (required)</term>
    <listitem>
     <para>
      The CDATA for the <literal>listen</literal> element holds the
  a listener:
  <variablelist>
   <varlistentry><term>CDATA (required)</term>
    <listitem>
     <para>
      The CDATA for the <literal>listen</literal> element holds the

-     listener string, such as <literal>tcp:@:210</literal>, 
+     listener string, such as <literal>tcp:@:210</literal>,

      <literal>tcp:server1:2100</literal>,
      etc.
     </para>
      <literal>tcp:server1:2100</literal>,
      etc.
     </para>

@@ -85,10 +84,11 @@
   <varlistentry><term>attribute <literal>listenref</literal> (optional)</term>
    <listitem>
     <para>
   <varlistentry><term>attribute <literal>listenref</literal> (optional)</term>
    <listitem>
     <para>

-     Specifies listener for this server. If this attribute is not
-     given, the server is accessible from all listener. In order
-     for the server to be used for real, howeever, the virtual host
-     must match (if specified in the configuration).
+     Specifies one or more listeners for this server. Each server ID is
+     separated by a comma.
+     If this attribute is not given, the server is accessible from all
+     listeners. In order for the server to be used for real, however, the
+     virtual host must match if specified in the configuration.

     </para>
    </listitem>
   </varlistentry>
     </para>
    </listitem>
   </varlistentry>

@@ -130,7 +130,17 @@
     <para>
      Specifies a filename that includes CQL to RPN conversion for this
      backend server. See &reference-tools-cql-map;
     <para>
      Specifies a filename that includes CQL to RPN conversion for this
      backend server. See &reference-tools-cql-map;

-     If given, the backend server will only "see" a Type-1/RPN query. 
+     If given, the backend server will only "see" a Type-1/RPN query.
+    </para>
+   </listitem>
+  </varlistentry>
+
+  <varlistentry><term>element <literal>ccl2rpn</literal> (optional)</term>
+   <listitem>
+    <para>
+     Specifies a filename that includes CCL to RPN conversion for this
+     backend server. See &reference-tools-ccl-qualifiers;
+     If given, the backend server will only "see" a Type-1/RPN query.

     </para>
    </listitem>
   </varlistentry>
     </para>
    </listitem>
   </varlistentry>

@@ -145,7 +155,7 @@
     </para>
    </listitem>
   </varlistentry>
     </para>
    </listitem>
   </varlistentry>

-   
+

   <varlistentry><term>element <literal>docpath</literal> (optional)</term>
    <listitem>
     <para>
   <varlistentry><term>element <literal>docpath</literal> (optional)</term>
    <listitem>
     <para>

@@ -158,7 +168,7 @@
     </para>
    </listitem>
   </varlistentry>
     </para>
    </listitem>
   </varlistentry>

-   
+

   <varlistentry><term>element <literal>explain</literal> (optional)</term>
    <listitem>
     <para>
   <varlistentry><term>element <literal>explain</literal> (optional)</term>
    <listitem>
     <para>

@@ -169,9 +179,32 @@
     </para>
    </listitem>
   </varlistentry>
     </para>
    </listitem>
   </varlistentry>

+
+  <varlistentry><term>element <literal>maximumrecordsize</literal> (optional)</term>
+   <listitem>
+    <para>
+     Specifies maximum record size/message size, in bytes. This
+     value also servers as maximum size of <emphasis>incoming</emphasis>
+     packages (for Record Updates etc). It's the same value as that
+     given by the <literal>-k</literal> option.
+    </para>
+   </listitem>
+  </varlistentry>
+
+  <varlistentry><term>element <literal>retrievalinfo</literal> (optional)</term>
+   <listitem>
+    <para>
+     Enables the retrieval facility supporting conversions and
+     specifications of record formats/types.
+     See <xref linkend="tools.retrieval"/> for
+     more information.
+    </para>
+   </listitem>
+  </varlistentry>
+

  </variablelist>
 </para>
  </variablelist>
 </para>

- 
+

 <para>
  The XML below configures a server that accepts connections from
  two ports, TCP/IP port 9900 and a local UNIX file socket.
 <para>
  The XML below configures a server that accepts connections from
  two ports, TCP/IP port 9900 and a local UNIX file socket.

@@ -188,7 +221,7 @@
     <directory>/var/www/s1</directory>
     <config>config.cfg</config>
   </server>
     <directory>/var/www/s1</directory>
     <config>config.cfg</config>
   </server>

-  <server id="server2">
+  <server id="server2" listenref="public,internal">

     <host>server2.mydomain</host>
     <directory>/var/www/s2</directory>
     <config>config.cfg</config>
     <host>server2.mydomain</host>
     <directory>/var/www/s2</directory>
     <config>config.cfg</config>

@@ -211,9 +244,11 @@
 <para>
  There are three configured backend servers. The first two
  servers, <literal>"server1"</literal> and <literal>"server2"</literal>,
 <para>
  There are three configured backend servers. The first two
  servers, <literal>"server1"</literal> and <literal>"server2"</literal>,

- can be reached by both listener addresses - since
- no <literal>listenref</literal> attribute is specified.
- In order to distinguish between the two a virtual host has
+ can be reached by both listener addresses.
+ <literal>"server1"</literal> is reached by all (two) since no
+  <literal>listenref</literal> attribute is specified.
+ <literal>"server2"</literal> is reached by the two listeners specified.
+ In order to distinguish between the two, a virtual host has

  been specified for each of server in the <literal>host</literal>
  elements.
 </para>
  been specified for each of server in the <literal>host</literal>
  elements.
 </para>

@@ -227,9 +262,17 @@
  via listener <literal>"internal"</literal>.
 </para>
 
  via listener <literal>"internal"</literal>.
 </para>
 

-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file

 Local variables:
 Local variables:

-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t

 End:
 -->
 End:
 -->

-