[sr-dev] git:andrei/tcp_tls_changes: tls: doc - removed handshake_timeout and send_timeout

Module: sip-router Branch: andrei/tcp_tls_changes Commit: 4f247030923dbb8e433441a66c557d9438316ddc URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=4f24703… Author: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Committer: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Date: Thu May 27 20:00:00 2010 +0200 tls: doc - removed handshake_timeout and send_timeout --- modules/tls/README | 26 +++++++++++--------------- modules/tls/doc/params.xml | 23 ++++++++++++----------- 2 files changed, 23 insertions(+), 26 deletions(-) diff --git a/modules/tls/README b/modules/tls/README index e2b0866..1532c9f 100644 --- a/modules/tls/README +++ b/modules/tls/README @@ -397,36 +397,32 @@ modparam("tls", "cipher_list", "HIGH") 1.8.9. send_timeout (int) - Sets the maximum interval of time after which SIP-router will give up - trying to send a message over TLS (time after a TLS send will be - aborted and the corresponding TLS connection closed). The value is in - seconds. - - The default value is 120 s. + This parameter is obsolete and cannot be used in newer TLS versions (> + sip-router 3.0). In these versions the send_timeout is replaced by + tcp_send_timeout (common with all the tcp connections). Example 10. Set send_timeout parameter ... -modparam("tls", "send_timeout", 1) +tls_send_timeout = 10 ... 1.8.10. handshake_timeout (int) - Sets the maximum interval of time after which SIP-router will give up - trying to accept a TLS connection or connect to a TLS peer. The value - is in seconds. - - The default value is 120 s. + This parameter is obsolete and cannot be used in newer TLS versions (> + sip-router 3.0). In these versions the handshake_timeout is replaced by + tcp_connect_timeout (common with all the tcp connections). Example 11. Set handshake_timeout parameter ... -modparam("tls", "handshake_timeout", 1) +tcp_connect_timeout = 60 ... 1.8.11. connection_timeout (int) Sets the amount of time after which an idle TLS connection will be - closed. This is similar to tcp_connection_lifetime. The value is - expressed in seconds. + closed, if no I/O ever occured after the initial open. If an I/O event + occurs, the timeout will be extended with tcp_connection_lifetime. The + value is expressed in seconds. The default value is 10 min. diff --git a/modules/tls/doc/params.xml b/modules/tls/doc/params.xml index b898dc5..a489243 100644 --- a/modules/tls/doc/params.xml +++ b/modules/tls/doc/params.xml @@ -201,16 +201,15 @@ modparam("tls", "cipher_list", "HIGH") <section id="send_timeout"> <title><varname>send_timeout</varname> (int)</title> <para> - Sets the maximum interval of time after which SIP-router will give up trying to send a message over TLS (time after a TLS send will be aborted and the corresponding TLS connection closed). The value is in seconds. - </para> - <para> - The default value is 120 s. + This parameter is obsolete and cannot be used in newer TLS versions + (&gt; sip-router 3.0). In these versions the send_timeout is + replaced by tcp_send_timeout (common with all the tcp connections). </para> <example> <title>Set <varname>send_timeout</varname> parameter</title> <programlisting> ... -modparam("tls", "send_timeout", 1) +tls_send_timeout = 10 ... </programlisting> </example> @@ -219,16 +218,15 @@ modparam("tls", "send_timeout", 1) <section id="handshake_timeout"> <title><varname>handshake_timeout</varname> (int)</title> <para> - Sets the maximum interval of time after which SIP-router will give up trying to accept a TLS connection or connect to a TLS peer. The value is in seconds. - </para> - <para> - The default value is 120 s. + This parameter is obsolete and cannot be used in newer TLS versions + (&gt; sip-router 3.0). In these versions the handshake_timeout is + replaced by tcp_connect_timeout (common with all the tcp connections). </para> <example> <title>Set <varname>handshake_timeout</varname> parameter</title> <programlisting> ... -modparam("tls", "handshake_timeout", 1) +tcp_connect_timeout = 60 ... </programlisting> </example> @@ -237,7 +235,10 @@ modparam("tls", "handshake_timeout", 1) <section id="connection_timeout"> <title><varname>connection_timeout</varname> (int)</title> <para> - Sets the amount of time after which an idle TLS connection will be closed. This is similar to tcp_connection_lifetime. The value is expressed in seconds. + Sets the amount of time after which an idle TLS connection will be + closed, if no I/O ever occured after the initial open. If an I/O event + occurs, the timeout will be extended with tcp_connection_lifetime. + The value is expressed in seconds. </para> <para> The default value is 10 min.