X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Ffrontend_net.xml;h=fa6fcd13c7ec0d526ddab3869b73efdce4286e0e;hb=f150117aba7cd6df46f63449fea1fee085ba899b;hp=c229fda66d815de8c011a1309e55cfed4612eaa1;hpb=a195993d409a326e940814b4ac9ebd2f7eae0471;p=metaproxy-moved-to-github.git diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml index c229fda..fa6fcd1 100644 --- a/doc/frontend_net.xml +++ b/doc/frontend_net.xml @@ -1,40 +1,133 @@ - + + %idcommon; ]> - - + + + Metaproxy + Index Data + + frontend_net 3mp - Metaproxy Module - - + Metaproxy Module + + frontend_net - network server + Metaproxy Network Server module that accepts Z39.50 and + HTTP requests - + DESCRIPTION This is a frontend module. Listens on one or more ports and sends HTTP/Z39.50 messages to other filters. - + + CONFIGURATION + + Element port is a repeating element (1 or more). The + text content specifies a listening port. A few attributes may be + given for each port element. Attribute route specifies + the route to use for the port. Attribute max_recv_bytes + specifies maximum package size that YAZ should accept (it calls + cs_set_max_recv_bytes function of YAZ). + + + Element threads is an optional element. The + text content specifies number of worker threads for the following + filters to use. The default value is 5 (5 worker threads). + + + Element max-threads is an optional element. The + text content specifies maximum number of worker threads for the following + filters to use. By default the thread count is fixed. + By using this setting with a higher value than the treads + setting extra worker threads will be added as necessary. + + + Element stack-size is an optional element. The + text content specifies stack size in kilo bytes for worker threads. + If omitted, the system default stack size for threads is used. + + + Element timeout is an optional element. The + text content is treated as an integer that specifies the session timeout + in seconds for a client session (using the frontend net filter). The + default value is 300 (5 minutes). + + + Element connect-max is an optional repeatable element. + The text content is treated as an integer that specifies maximum number + of accepted TCP sessions from the same original IP. A value of 0 + means unlimited (no limit). The attribute ip + specifies an IP-pattern to match. If the IP pattern is matched, the + limit takes effect. By repeating this element with different IP + patterns, limits may be configured "per-IP". If no patterns are + matched, no limit takes place. The IP pattern is a glob pattern. + Blanks in a pattern may be used to provide alternatives. + For example: + ip="::1 127*" would match ::1 or + 127.0.0.1 , but not 128.0.0.1. + + + Element http-req-max is an optional repeatable element. + The text content is treated as an integer that specifies maximum number + of accepted HTTP requests from the same original IP. A value of 0 + means unlimited (no limit). The attribute ip + specifies an IP-pattern to match. If the IP pattern is matched, the + limit takes effect. By repeating this element with different IP + patterns, limits may be configured "per-IP". If no patterns are + matched, no limit takes place. The IP pattern is a glob pattern. + Blanks in a pattern may be used to provide alternatives. + + + Element message is an optional element. If + given and non-empty logging is performed by the frontend_net filter + (to the log file as given ny option -l). + + + Element stat-req is an optional element. It + specifies a URL path that triggers a report to be generated by + the frontend_net filter. By default this report is disabled (same + as empty value). The value itself is the path and should be prefixed + with a slash. For example /fn_stat. + + + + SCHEMA + + + + EXAMPLES A typical configuration looks like this: - @:9000 10 + @:9000 + 100 + + 10000 + + 100 + FN + /fn_stat ]]> - - + + SEE ALSO @@ -43,21 +136,13 @@ - + ©right;