[sr-dev] git:master: doc: cfg_list regenerated

Module: sip-router Branch: master Commit: 82a63cc5f484cd2030dd0caa1a22fb387defb87b URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=82a63cc… Author: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Committer: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Date: Mon Oct 4 22:41:26 2010 +0200 doc: cfg_list regenerated - added dispatcher - regenerated the docs --- doc/cfg_list/Makefile | 3 +- doc/cfg_list/cfg_dispatcher.txt | 18 ++++++++++++ doc/cfg_list/cfg_tls.txt | 44 +++++++++++++++++------------- doc/cfg_list/docbook/cfg_dispatcher.xml | 33 +++++++++++++++++++++++ doc/cfg_list/docbook/cfg_tls.xml | 13 +++++++++ doc/cfg_list/docbook/cfg_var_list.xml | 5 ++- 6 files changed, 94 insertions(+), 22 deletions(-) diff --git a/doc/cfg_list/Makefile b/doc/cfg_list/Makefile index 7af9402..ca86a8a 100644 --- a/doc/cfg_list/Makefile +++ b/doc/cfg_list/Makefile @@ -27,7 +27,8 @@ files_list= \ $(COREPATH)/modules_s/maxfwd/maxfwd.c:maxfwd \ $(COREPATH)/modules/carrierroute/config.c:carrierroute \ $(COREPATH)/modules/malloc_test/malloc_test.c:malloc_test \ - $(COREPATH)/modules/tls/tls_cfg.c:tls + $(COREPATH)/modules/tls/tls_cfg.c:tls \ + $(COREPATH)/modules_k/dispatcher/config.c:dispatcher diff --git a/doc/cfg_list/cfg_dispatcher.txt b/doc/cfg_list/cfg_dispatcher.txt new file mode 100644 index 0000000..c085f65 --- /dev/null +++ b/doc/cfg_list/cfg_dispatcher.txt @@ -0,0 +1,18 @@ +Configuration Variables for dispatcher +====================================== + + [ this file is autogenerated, do not edit ] + + + 1. dispatcher.probing_threshhold + Number of failed requests, before a destination is set to + probing.. + Default: 3. + Type: integer. + + 2. dispatcher.ping_reply_codes + Additional, valid reply codes for the OPTIONS Pinger. Default + is "". + Default: <unknown:str>. + Type: string. + diff --git a/doc/cfg_list/cfg_tls.txt b/doc/cfg_list/cfg_tls.txt index 5e67d4b..ca376aa 100644 --- a/doc/cfg_list/cfg_tls.txt +++ b/doc/cfg_list/cfg_tls.txt @@ -46,71 +46,77 @@ Configuration Variables for tls Default: <unknown:str>. Type: string. Read-only. - 8. tls.certificate + 8. tls.crl + name of the file containing the CRL (certificare revocation + list in pem format). + Default: <unknown:str>. + Type: string. Read-only. + + 9. tls.certificate name of the file containing the certificate (pem format). Default: <unknown:str>. Type: string. Read-only. - 9. tls.cipher_list +10. tls.cipher_list list of the accepted ciphers (strings separated by colons). Default: <unknown:str>. Type: string. Read-only. -10. tls.session_cache +11. tls.session_cache enables or disables the session cache. Default: 0. Range: 0 - 1. Type: integer. Read-only. -11. tls.session_id +12. tls.session_id string used for the session id. Default: <unknown:str>. Type: string. Read-only. -12. tls.config +13. tls.config tls config file name (used for the per domain options). Default: <unknown:str>. Type: string. -13. tls.log +14. tls.log tls info messages log level. Default: 3. Range: 0 - 1000. Type: integer. -14. tls.debug +15. tls.debug tls debug messages log level. Default: 3. Range: 0 - 1000. Type: integer. -15. tls.connection_timeout +16. tls.connection_timeout initial connection lifetime (in s) (obsolete). Default: 600. Range: -1 - -2147483648. Type: integer. -16. tls.disable_compression +17. tls.disable_compression if set disable the built-in OpenSSL compression. Default: 1. Range: 0 - 1. Type: integer. Read-only. -17. tls.ssl_release_buffers +18. tls.ssl_release_buffers quickly release internal OpenSSL read or write buffers. Works only for OpenSSL >= 1.0.. Default: -1. Range: -1 - 1. Type: integer. Read-only. -18. tls.ssl_free_list_max +19. tls.ssl_free_list_max maximum number of free/cached memory chunks that OpenSSL will keep per connection. Works only for OpenSSL >= 1.0.. Default: -1. Range: -1 - 1073741824. Type: integer. Read-only. -19. tls.ssl_max_send_fragment +20. tls.ssl_max_send_fragment sets the maximum number of bytes (clear text) send into one TLS record. Valid values are between 512 and 16384. Works only for OpenSSL >= 0.9.9. @@ -118,7 +124,7 @@ Configuration Variables for tls Range: -1 - 65536. Type: integer. Read-only. -20. tls.ssl_read_ahead +21. tls.ssl_read_ahead Enables read ahead, reducing the number of BIO read calls done internally by the OpenSSL library. Note that in newer tls module versions it is better to have read ahead disabled, since @@ -127,21 +133,21 @@ Configuration Variables for tls Range: -1 - 1. Type: integer. Read-only. -21. tls.low_mem_threshold1 +22. tls.low_mem_threshold1 sets the minimum amount of free memory for accepting new TLS connections (KB). Default: -1. Range: -1 - 1073741824. Type: integer. -22. tls.low_mem_threshold2 +23. tls.low_mem_threshold2 sets the minimum amount of free memory after which no more TLS operations will be attempted (even on existing connections). Default: -1. Range: -1 - 1073741824. Type: integer. -23. tls.ct_wq_max +24. tls.ct_wq_max maximum bytes queued globally for write when write has to wait due to TLS-level renegotiation (SSL_ERROR_WANT_READ) or initial TLS connection establishment (it is different from tcp.wq_max, @@ -150,7 +156,7 @@ Configuration Variables for tls Range: 0 - 1073741824. Type: integer. -24. tls.con_ct_wq_max +25. tls.con_ct_wq_max maximum bytes queued for write per connection when write has to wait due to TLS-level renegotiation (SSL_ERROR_WANT_READ) or initial TLS connection establishment (it is different from @@ -159,14 +165,14 @@ Configuration Variables for tls Range: 0 - 4194304. Type: integer. -25. tls.ct_wq_blk_size +26. tls.ct_wq_blk_size internal TLS pre-write (clear-text) queue minimum block size (advanced tunning or debugging for now). Default: 4096. Range: 1 - 65536. Type: integer. -26. tls.send_close_notify +27. tls.send_close_notify enable/disable sending a close notify TLS shutdown alert before closing the corresponding TCP connection.Note that having it enabled has a performance impact.. diff --git a/doc/cfg_list/docbook/cfg_dispatcher.xml b/doc/cfg_list/docbook/cfg_dispatcher.xml new file mode 100644 index 0000000..f05c019 --- /dev/null +++ b/doc/cfg_list/docbook/cfg_dispatcher.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- this file is autogenerated, do not edit! --> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<chapter id="config_vars.dispatcher"> + <title> Configuration Variables for dispatcher</title> + + +<section id="dispatcher.probing_threshhold"> + <title>dispatcher.probing_threshhold</title> + <para> + Number of failed requests, before a destination is set to + probing.. + </para> + <para>Default value: 3.</para> + <para>Type: integer.</para> + <para> + </para> +</section> + +<section id="dispatcher.ping_reply_codes"> + <title>dispatcher.ping_reply_codes</title> + <para> + Additional, valid reply codes for the OPTIONS Pinger. Default + is &quot;&quot;. + </para> + <para>Default value: &lt;unknown:str&gt;.</para> + <para>Type: string.</para> + <para> + </para> +</section> + +</chapter> diff --git a/doc/cfg_list/docbook/cfg_tls.xml b/doc/cfg_list/docbook/cfg_tls.xml index dd18b62..07f2c89 100644 --- a/doc/cfg_list/docbook/cfg_tls.xml +++ b/doc/cfg_list/docbook/cfg_tls.xml @@ -97,6 +97,19 @@ </para> </section> +<section id="tls.crl"> + <title>tls.crl</title> + <para> + name of the file containing the CRL (certificare revocation + list in pem format). + </para> + <para>Default value: &lt;unknown:str&gt;.</para> + <para>Type: string.</para> + <para> + Read-only. + </para> +</section> + <section id="tls.certificate"> <title>tls.certificate</title> <para> diff --git a/doc/cfg_list/docbook/cfg_var_list.xml b/doc/cfg_list/docbook/cfg_var_list.xml index 82049a3..e613a05 100644 --- a/doc/cfg_list/docbook/cfg_var_list.xml +++ b/doc/cfg_list/docbook/cfg_var_list.xml @@ -8,8 +8,8 @@ <book id="cfg_var_list" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>Runtime Configuration Variables List</title> <bookinfo><revhistory><revision> - <revnumber>sip-router git-0c430b</revnumber> - <date>Thu, 02 Sep 2010 17:54:38 +0200</date> + <revnumber>sip-router git-a1b23f</revnumber> + <date>Mon, 04 Oct 2010 20:24:11 +0200</date> <revremark> Automatically generated by: make -C doc/cfg_list all @@ -25,4 +25,5 @@ <xi:include href="cfg_carrierroute.xml"/> <xi:include href="cfg_malloc_test.xml"/> <xi:include href="cfg_tls.xml"/> + <xi:include href="cfg_dispatcher.xml"/> </book>