table of contents
other versions
- jessie 1:17.3-dfsg-4+deb8u2
- jessie-backports 1:19.2.1+dfsg-2+deb9u1~bpo8+1
- stretch 1:19.2.1+dfsg-2+deb9u2
- testing 1:21.2.5+dfsg-1
- unstable 1:21.2.6+dfsg-1
- experimental 1:22.0~rc1+dfsg-1
| ssl_session_cache_api(3erl) | Erlang Module Definition | ssl_session_cache_api(3erl) |
NAME¶
ssl_session_cache_api - TLS session cache APIDESCRIPTION¶
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.DATA TYPES¶
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()
- session() =:
- opaque()
EXPORTS¶
delete(Cache, Key) -> _
Types:
Cache = cache_ref()
Key = key()
Deletes a cache entry. Is only 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(Args) -> opaque()
Types:
Args = proplists:proplist()
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 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
Types:
Cache = cache_ref()
Key = key()
Entry = session() | undefined
Looks up a cache entry. Is to be callable from any process.
select_session(Cache, PartialKey) -> [session()]
Types:
Cache = cache_ref()
PartialKey = partialkey()
Session = session()
Selects sessions that can be reused. Is to 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 an already cached one. Is only called from the
cache handling process.
| ssl 8.1 | Ericsson AB |