X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Freference.xml;h=5fa71468c7bebc4a358c103dfb2efa2116d48c16;hp=bdbb9e36d6200dc8cf86e582fbeba4d412a8a4b6;hb=9a7e8960b79b0b9bd6df38258ecda51f42d41280;hpb=029fd8c83fa3446b8a11b30017b731c75c3465e9
diff --git a/doc/reference.xml b/doc/reference.xml
index bdbb9e3..5fa7146 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -32,7 +32,7 @@
usual YAZ address format (typically
tcp:hostname:port)
as described in
- the Addresses section of the YAZ manual.
@@ -58,14 +58,13 @@
- If the proxy receives an SRW/SRU request, the following rules are used.
+ If the proxy receives an SRU request, the following rules are used.
If default target has Explain information with a
database that matches the path of the
- HTTP request of SRW/SRU that backend server is used for
- SRW/SRU operation.
-
+ HTTP request of SRU that backend server is used for SRU operation.
+
@@ -74,13 +73,6 @@
-
-
- We know it is stupid to only check for explain in default target.
- It means that it is only possible to offer one SRW/SRU server.
- We expect to improve that in the next version of the YAZ proxy.
-
- Keep-alive Facility
@@ -199,8 +191,8 @@
The config file is XML based. The YAZ proxy must be compiled
- with libxml2 and
- libXSLT support in
+ with libxml2 and
+ libXSLT support in
order for the config file facility to be enabled.
@@ -221,13 +213,13 @@
The proxy config file must have a root element called
proxy and scoped within namespace
- xmlns="http://indexdata.dk/yazproxy/schema/0.8/.
+ xmlns="http://indexdata.dk/yazproxy/schema/0.9/.
All information except an optional XML header must be stored
within the proxy element.
<?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/">
+ <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<!-- content here .. -->
</proxy>
@@ -458,12 +450,12 @@
If attribute identifier is given that is the
- SRW/SRU record schema identifier for the resulting output record (after
+ SRU record schema identifier for the resulting output record (after
MARCXML and/or XSLT conversion).
If sub element title is given (as child element
- of syntax, then that is the official SRW/SRU
+ of syntax, then that is the official SRU
name of the resulting record schema.
@@ -504,7 +496,7 @@
explain
The explain element includes Explain information
- for SRW/SRU about the server in the target section. This
+ for SRU about the server in the target section. This
information must have a serverInfo element
with a database that this target must be available as (URL path).
For example,
@@ -519,7 +511,7 @@
]]>
- In the above case, the SRW/SRU service is available as
+ In the above case, the SRU service is available as
http://myhost.org:8000/mydatabase.
@@ -531,14 +523,14 @@
The content of the cql2rpn element specifies
the path from the working directory to a CQL-to-RPN conversion
file for the server in the target section. This element
- is required for SRW/SRU searches to operate against Z39.50
+ is required for SRU searches to operate against Z39.50
servers that don't support CQL. Most Z39.50 servers only support
Type-1/RPN so this is usually required.
See YAZ documentation for more information about the
- CQL
- to PQF conversion. See also the
+ CQL to PQF conversion.
+ See also the
pqf.properties in the etc
(or prefix/share/yazproxy)
directory of the YAZ proxy distribution.
@@ -614,7 +606,7 @@
If this is specified the proxy will act as a Z39.50 server
- supporting character set negotiation. And in SRW/SRU mode
+ supporting character set negotiation. And in SRU mode
it will convert from UTF-8 (UNICODE) to this native character
set (if possible).
@@ -638,8 +630,8 @@
- Using the
- bash shell, you can set the limit with
+ Using the bash shell, you can set
+ the limit with
ulimit -nno.
Use ulimit -a to display limits.
@@ -703,6 +695,13 @@
and the size of the APDU is logged.
+
+ client-ip
+
+ Log the client IP for each log entry. By default, the client IP
+ is only logged when a new session starts.
+
+
@@ -724,7 +723,8 @@
The element max-connect is a child of element
proxy and specifies the maximum number
- of connections to be initiated within the last minute.
+ of connections to be initiated within the last minute (or
+ value of period-connect.
If the maximum number is reached the proxy will terminate the
@@ -737,11 +737,26 @@
The element max-connect is a child of element
proxy and specifies the limit of number
- of connections to be initiated within the last minute.
+ of connections to be initiated within the last minute (or
+ value of period-connect.
+
+
+ If the maximum number is reached the proxy delays the first operation
+ in the session by one second.
+
+
+
+
+ period-connect
+
+ The element period-connect is a child of element
+ proxy and specifies period - in the number of seconds
+ that limit-connect and
+ max-connect
+ should measure connections.
- If the maximum number is reached the proxy delay the first operatation
- in the session (Thus delaying the connection).
+ If period-connect is omitted, 60 seconds is used.
@@ -801,7 +816,7 @@
The categoryTypeId is either
OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
for proxy target and proxy cookie respectively. The
- integer element category is set to 0.
+ categoryValue is set to 1.
The value proxy and cookie is stored in element
characterInfo of the information
choice.
@@ -817,7 +832,7 @@