diff options
| author | Ingela Anderton Andin <[email protected]> | 2016-05-27 11:08:23 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2016-05-27 11:08:23 +0200 |
| commit | 44a892ab08e11dadb841e4611e15aba970f58617 (patch) | |
| tree | d5878b1f9742606afd636f5b342f4d6420451365 | |
| parent | 48085e18c31bd303f07d9d75cff282361e38ca8b (diff) | |
| parent | a11ab6550423d48d45dfc9ed4eb35cb4bef9e5e3 (diff) | |
| download | otp-44a892ab08e11dadb841e4611e15aba970f58617.tar.gz otp-44a892ab08e11dadb841e4611e15aba970f58617.tar.bz2 otp-44a892ab08e11dadb841e4611e15aba970f58617.zip | |
Merge branch 'ingela/ssl/doc-enhancment/ERL-131'
* ingela/ssl/doc-enhancment/ERL-131:
ssl: Add default values and clarifications
| -rw-r--r-- | lib/ssl/doc/src/ssl_app.xml | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml index daa06a40fc..e50ffdbfe6 100644 --- a/lib/ssl/doc/src/ssl_app.xml +++ b/lib/ssl/doc/src/ssl_app.xml @@ -94,7 +94,10 @@ to <c>ssl:connect/[2,3]</c> and <c>ssl:listen/2</c>.</p></item> <tag><c><![CDATA[session_lifetime = integer() <optional>]]></c></tag> - <item><p>Maximum lifetime of the session data in seconds.</p></item> + <item><p>Maximum lifetime of the session data in seconds. Defaults to 24 hours which is the maximum + recommended lifetime by <url href="http://www.ietf.org/rfc/5246rfc.txt">RFC 5246</url>. However + sessions may be invalidated earlier due to the maximum limitation of the session cache table. + </p></item> <tag><c><![CDATA[session_cb = atom() <optional>]]></c></tag> <item><p>Name of the session cache callback module that implements @@ -107,16 +110,24 @@ in the session cache callback module. Defaults to <c>[]</c>.</p></item> <tag><c><![CDATA[session_cache_client_max = integer() <optional>]]></c><br/> - <c><![CDATA[session_cache_server_max = integer() <optional>]]></c></tag> - <item><p>Limits the growth of the clients/servers session cache, - if the maximum number of sessions is reached, the current cache entries will - be invalidated regardless of their remaining lifetime. Defaults to 1000. - </p></item> + <item><p>Limits the growth of the clients session cache, that is + how many sessions towards servers that are cached to be used by + new client connections. If the maximum number of sessions is + reached, the current cache entries will be invalidated + regardless of their remaining lifetime. Defaults to + 1000.</p></item> + + <tag> <c><![CDATA[session_cache_server_max = integer() <optional>]]></c></tag> + <item><p>Limits the growth of the servers session cache, that is + how many client sessions are cached by the server. If the + maximum number of sessions is reached, the current cache entries + will be invalidated regardless of their remaining + lifetime. Defaults to 1000.</p></item> <tag><c><![CDATA[ssl_pem_cache_clean = integer() <optional>]]></c></tag> <item> <p> - Number of milliseconds between PEM cache validations. + Number of milliseconds between PEM cache validations. Defaults to 2 minutes. </p> <seealso marker="ssl#clear_pem_cache-0">ssl:clear_pem_cache/0</seealso> @@ -131,7 +142,7 @@ shutdown gracefully. Defaults to 5000 milliseconds. </p> </item> - + </tag> </taglist> </section> |