aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteven Danna <[email protected]>2017-02-20 14:16:26 +0000
committerSteven Danna <[email protected]>2017-02-21 13:36:49 +0000
commitc4c28a0a5e0c0485769b3ed0c1230cda6e3f5b43 (patch)
treec73345053b5bb313e06714b7ab27e7c43ad6d186
parent8f0cfd160505e5ac6c100db7d1294c2e63dc0cbb (diff)
downloadotp-c4c28a0a5e0c0485769b3ed0c1230cda6e3f5b43.tar.gz
otp-c4c28a0a5e0c0485769b3ed0c1230cda6e3f5b43.tar.bz2
otp-c4c28a0a5e0c0485769b3ed0c1230cda6e3f5b43.zip
Document ssl_session_cache_api's size/1 callback
The size/1 callback was added as a non-optional callback in 42b8a29dbae1d626f32bc16dd81a129caf741138 but wasn't added to the documentation for the ssl_session_cache_api behavior. Signed-off-by: Steven Danna <[email protected]>
-rw-r--r--lib/ssl/doc/src/ssl_session_cache_api.xml29
1 files changed, 22 insertions, 7 deletions
diff --git a/lib/ssl/doc/src/ssl_session_cache_api.xml b/lib/ssl/doc/src/ssl_session_cache_api.xml
index b85d8fb284..1b41eae89d 100644
--- a/lib/ssl/doc/src/ssl_session_cache_api.xml
+++ b/lib/ssl/doc/src/ssl_session_cache_api.xml
@@ -11,7 +11,7 @@
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -62,8 +62,8 @@
</taglist>
</section>
-
- <funcs>
+
+ <funcs>
<func>
<name>delete(Cache, Key) -> _</name>
@@ -134,7 +134,7 @@
</p>
</desc>
</func>
-
+
<func>
<name>select_session(Cache, PartialKey) -> [session()]</name>
<fsummary>Selects sessions that can be reused.</fsummary>
@@ -151,6 +151,21 @@
</func>
<func>
+ <name>size(Cache) -> integer()</name>
+ <fsummary>Returns the number of sessions in the cache.</fsummary>
+ <type>
+ <v>Cache = cache_ref()</v>
+ </type>
+ <desc>
+ <p>Returns the number of sessions in the cache. If size
+ exceeds the maximum number of sessions, the current cache
+ entries will be invalidated regardless of their remaining
+ lifetime. Is to be callable from any process.
+ </p>
+ </desc>
+ </func>
+
+ <func>
<name>terminate(Cache) -> _</name>
<fsummary>Called by the process that handles the cache when it
is about to terminate.</fsummary>
@@ -178,7 +193,7 @@
</p>
</desc>
</func>
-
- </funcs>
-
+
+ </funcs>
+
</erlref>