ssl_session_cache_api(3erl) Erlang Module Definition ssl_session_cache_api(3erl)
NAME
ssl_session_cache_api - Defines the API for the TLS session cache so
that the data storage scheme can be replaced by
defining a new callback module implementing this API.
COMMON DATA TYPES
The following data types are used in the functions below:
cache_ref() = opaque()
key() = {partialkey(), session_id()}
partialkey() = opaque()
session_id() = binary()
session() = opaque()
EXPORTS
delete(Cache, Key) -> _
Types Cache = cache_ref()
Key = key()
Deletes a cache entry. Will only be called from the cache handling process.
foldl(Fun, Acc0, Cache) -> Acc
Types
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() -> opaque()
Types
Performs possible initializations of the cache and returns a reference to it that will be used as parameter to the other api func-
tions. Will be called by the cache handling processes init function, hence putting the same requirements on it as a normal process
init function.
lookup(Cache, Key) -> Entry
Types Cache = cache_ref()
Key = key()
Entry = session() | undefined
Looks up a cache entry. Should be callable from any process.
select_session(Cache, PartialKey) -> [session()]
Types Cache = cache_ref()
PartialKey = partialkey()
Session = session()
Selects sessions that could be reused. Should be callable from any process.
terminate(Cache) -> _
Types Cache = term() - as returned by init/0
Takes care of possible cleanup that is needed when the cache handling process terminates.
update(Cache, Key, Session) -> _
Types 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.
Ericsson AB ssl 4.1.4 ssl_session_cache_api(3erl)