From c4c28a0a5e0c0485769b3ed0c1230cda6e3f5b43 Mon Sep 17 00:00:00 2001
From: Steven Danna
Date: Mon, 20 Feb 2017 14:16:26 +0000
Subject: 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
---
lib/ssl/doc/src/ssl_session_cache_api.xml | 29 ++++++++++++++++++++++-------
1 file 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 @@
-
-
+
+
delete(Cache, Key) -> _
@@ -134,7 +134,7 @@
-
+
select_session(Cache, PartialKey) -> [session()]
Selects sessions that can be reused.
@@ -150,6 +150,21 @@
+
+ size(Cache) -> integer()
+ Returns the number of sessions in the cache.
+
+ Cache = cache_ref()
+
+
+ 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.
+
+
+
+
terminate(Cache) -> _
Called by the process that handles the cache when it
@@ -178,7 +193,7 @@
-
-
-
+
+
+
--
cgit v1.2.3