diff options
Diffstat (limited to 'lib/ssl/doc/src/ssl_session_cache_api.xml')
| -rw-r--r-- | lib/ssl/doc/src/ssl_session_cache_api.xml | 66 |
1 files changed, 37 insertions, 29 deletions
diff --git a/lib/ssl/doc/src/ssl_session_cache_api.xml b/lib/ssl/doc/src/ssl_session_cache_api.xml index 8e90ddc6bb..3067d89b13 100644 --- a/lib/ssl/doc/src/ssl_session_cache_api.xml +++ b/lib/ssl/doc/src/ssl_session_cache_api.xml @@ -33,7 +33,7 @@ <description> <p> - Defines the API for the TLS session cache so + Defines the API for the TLS session cache (pre TLS-1.3) so that the data storage scheme can be replaced by defining a new callback module implementing this API. </p> @@ -77,11 +77,11 @@ <funcs> <func> - <name since="OTP R14B">delete(Cache, Key) -> _</name> + <name since="OTP R14B">Module:delete(Cache, Key) -> _</name> <fsummary>Deletes a cache entry.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> - <v>Key = <seealso marker="#type-session_cache_key">session_cache_key() </seealso> </v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> + <v>Key = <seetype marker="#session_cache_key">session_cache_key() </seetype> </v> </type> <desc> <p>Deletes a cache entry. Is only called from the cache @@ -91,12 +91,12 @@ </func> <func> - <name since="OTP R14B">foldl(Fun, Acc0, Cache) -> Acc</name> + <name since="OTP R14B">Module:foldl(Fun, Acc0, Cache) -> Acc</name> <fsummary></fsummary> <type> <v>Fun = fun()</v> <v>Acc0 = Acc = term()</v> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> </type> <desc> <p>Calls <c>Fun(Elem, AccIn)</c> on successive elements of the @@ -105,22 +105,27 @@ The function returns the final value of the accumulator. <c>Acc0</c> is returned if the cache is empty. </p> + + <note><p>Since OTP-23.3 this functions is only used on the client side + and does not need to implemented for a server cache. + </p></note> + </desc> </func> <func> - <name since="OTP 18.0">init(Args) -> Cache </name> + <name since="OTP 18.0">Module:init(Args) -> Cache </name> <fsummary>Returns cache reference.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> - <v>Args = <seealso marker="stdlib:proplists#type-proplist">proplists:proplist()</seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> + <v>Args = <seetype marker="stdlib:proplists#proplist">proplists:proplist()</seetype></v> </type> <desc> <p>Includes property <c>{role, client | server}</c>. Currently this is the only predefined property, there can also be user-defined properties. See also application environment variable - <seealso marker="ssl_app">session_cb_init_args</seealso>. + <seeapp marker="ssl_app">session_cb_init_args</seeapp>. </p> <p>Performs possible initializations of the cache and returns a reference to it that is used as parameter to the other @@ -135,12 +140,12 @@ </func> <func> - <name since="OTP R14B">lookup(Cache, Key) -> Entry</name> + <name since="OTP R14B">Module:lookup(Cache, Key) -> Entry</name> <fsummary>Looks up a cache entry.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> - <v>Key = <seealso marker="#type-session_cache_key">session_cache_key()</seealso> </v> - <v>Session = <seealso marker="#type-session">session()</seealso> | undefined</v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> + <v>Key = <seetype marker="#session_cache_key">session_cache_key()</seetype> </v> + <v>Session = <seetype marker="#session">session()</seetype> | undefined</v> </type> <desc> <p>Looks up a cache entry. Is to be callable from any @@ -150,25 +155,28 @@ </func> <func> - <name since="OTP R14B">select_session(Cache, PartialKey) -> [Session]</name> + <name since="OTP R14B">Module:select_session(Cache, PartialKey) -> [Session]</name> <fsummary>Selects sessions that can be reused.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> - <v>PartialKey = <seealso marker="#type-partial_key"> partial_key() </seealso></v> - <v>Session = <seealso marker="#type-session">session()</seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> + <v>PartialKey = <seetype marker="#partial_key"> partial_key() </seetype></v> + <v>Session = <seetype marker="#session">session()</seetype></v> </type> <desc> - <p>Selects sessions that can be reused. Is to be callable - from any process. - </p> + <p>Selects sessions that can be reused, that is sessions that + include <c>PartialKey</c> in its key. Is to be callable from + any process.</p> + <note><p>Since OTP-23.3 This functions is only used on the client side + and does not need to implemented for a server cache. + </p></note> </desc> </func> <func> - <name since="OTP 19.3">size(Cache) -> integer()</name> + <name since="OTP 19.3">Module:size(Cache) -> integer()</name> <fsummary>Returns the number of sessions in the cache.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> </type> <desc> <p>Returns the number of sessions in the cache. If size @@ -180,11 +188,11 @@ </func> <func> - <name since="OTP R14B">terminate(Cache) -> _</name> + <name since="OTP R14B">Module:terminate(Cache) -> _</name> <fsummary>Called by the process that handles the cache when it is about to terminate.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> <d>As returned by init/0</d> </type> <desc> @@ -195,12 +203,12 @@ </func> <func> - <name since="OTP R14B">update(Cache, Key, Session) -> _</name> + <name since="OTP R14B">Module:update(Cache, Key, Session) -> _</name> <fsummary>Caches a new session or updates an already cached one.</fsummary> <type> - <v>Cache = <seealso marker="#type-session_cache_ref"> session_cache_ref() </seealso></v> - <v>Key = <seealso marker="#type-session_cache_key">session_cache_key()</seealso> </v> - <v>Session = <seealso marker="#type-session">session()</seealso></v> + <v>Cache = <seetype marker="#session_cache_ref"> session_cache_ref() </seetype></v> + <v>Key = <seetype marker="#session_cache_key">session_cache_key()</seetype> </v> + <v>Session = <seetype marker="#session">session()</seetype></v> </type> <desc> <p>Caches a new session or updates an already cached one. Is |