From 1776467988178ff24376499747fed836b1765e1d Mon Sep 17 00:00:00 2001 From: xsipewe Date: Mon, 16 Mar 2015 14:18:41 +0100 Subject: ssl: Editorial updates --- lib/ssl/doc/src/ssl_session_cache_api.xml | 115 +++++++++++++++++------------- 1 file changed, 64 insertions(+), 51 deletions(-) (limited to 'lib/ssl/doc/src/ssl_session_cache_api.xml') diff --git a/lib/ssl/doc/src/ssl_session_cache_api.xml b/lib/ssl/doc/src/ssl_session_cache_api.xml index 9f87d31e90..39db03c91c 100644 --- a/lib/ssl/doc/src/ssl_session_cache_api.xml +++ b/lib/ssl/doc/src/ssl_session_cache_api.xml @@ -21,6 +21,10 @@ ssl + + + + ssl_session_cache_api.xml ssl_session_cache_api @@ -28,35 +32,43 @@ that the data storage scheme can be replaced by defining a new callback module implementing this API. +
- Common Data Types + DATA TYPES -

The following data types are used in the functions below: -

+

The following data types are used in the functions for + ssl_session_cache_api:

-

cache_ref() = opaque()

- -

key() = {partialkey(), session_id()}

- -

partialkey() = opaque()

- -

session_id() = binary()

+ + cache_ref() +

= opaque()

 + + key() +

= {partialkey(), session_id()}

 + + partialkey() +

= opaque()

 + + session_id() +

= binary()

 + + session() +

= opaque()

 + -

session() = opaque()

-
delete(Cache, Key) -> _ - + Deletes a cache entry. - Cache = cache_ref() - Key = key() + Cache = cache_ref() + Key = key() -

Deletes a cache entry. Will only be called from the cache +

Deletes a cache entry. Is only called from the cache handling process.

@@ -69,49 +81,50 @@ -

Calls Fun(Elem, AccIn) on successive elements of the - cache, starting with AccIn == Acc0. Fun/2 must return a new - accumulator which is passed to the next call. The function returns - the final value of the accumulator. Acc0 is returned if the cache is - empty. +

Calls Fun(Elem, AccIn) on successive elements of the + cache, starting with AccIn == Acc0. Fun/2 must + return a new accumulator, which is passed to the next call. + The function returns the final value of the accumulator. + Acc0 is returned if the cache is empty.

init(Args) -> opaque() - Return cache reference + Returns cache reference. Args = proplists:proplist() - Will always include the property {role, client | server}. Currently this - is the only predefined property, there may also be user defined properties. - See also application environment variable - session_cb_init_args - +

Includes property {role, client | server}. + Currently this is the only predefined property, + there can also be user-defined properties. See also + application environment variable + session_cb_init_args. +

Performs possible initializations of the cache and returns - a reference to it that will be used as parameter to the other - API functions. Will be called by the cache handling processes - init function, hence putting the same requirements on it as a - normal process init function. Note that this function will be - called twice when starting the ssl application, once with the - role client and once with the role server, as the ssl application - must be prepared to take on both roles. + a reference to it that is used as parameter to the other + API functions. Is called by the cache handling processes + init function, hence putting the same requirements on it + as a normal process init function. This function is + called twice when starting the ssl application, once with + the role client and once with the role server, as the ssl + application must be prepared to take on both roles.

lookup(Cache, Key) -> Entry - Looks up a cache entry. + Looks up a cache entry. - Cache = cache_ref() - Key = key() - Entry = session() | undefined + Cache = cache_ref() + Key = key() + Entry = session() | undefined -

Looks up a cache entry. Should be callable from any +

Looks up a cache entry. Is to be callable from any process.

@@ -119,14 +132,14 @@ select_session(Cache, PartialKey) -> [session()] - Selects a sessions that could be reused. + Selects sessions that can be reused. - Cache = cache_ref() - PartialKey = partialkey() - Session = session() + Cache = cache_ref() + PartialKey = partialkey() + Session = session() -

Selects a sessions that could be reused. Should be callable +

Selects sessions that can be reused. Is to be callable from any process.

@@ -137,7 +150,7 @@ Called by the process that handles the cache when it is about to terminate. - Cache = term() - as returned by init/0 + Cache = term() - as returned by init/0

Takes care of possible cleanup that is needed when the @@ -148,15 +161,15 @@ update(Cache, Key, Session) -> _ - Caches a new session or updates a already cached one. + Caches a new session or updates an already cached one. - Cache = cache_ref() - Key = key() - Session = session() + Cache = cache_ref() + Key = key() + Session = session() -

Caches a new session or updates a already cached one. Will - only be called from the cache handling process. +

Caches a new session or updates an already cached one. Is + only called from the cache handling process.

-- cgit v1.2.3