diff options
author | Ingela Anderton Andin <[email protected]> | 2018-09-10 11:19:42 +0200 |
---|---|---|
committer | Ingela Anderton Andin <[email protected]> | 2019-02-05 14:43:48 +0100 |
commit | e042afe54727ae490d47eae47c6d9a210f04dd47 (patch) | |
tree | 7999d1adfd7226d276903737cce6104a7230f4d2 /lib/ssl/src/ssl_session_cache_api.erl | |
parent | 949c725abcc649e508d971cbc82f5278e050db2c (diff) | |
download | otp-e042afe54727ae490d47eae47c6d9a210f04dd47.tar.gz otp-e042afe54727ae490d47eae47c6d9a210f04dd47.tar.bz2 otp-e042afe54727ae490d47eae47c6d9a210f04dd47.zip |
ssl: Use specs to generate type documentation
Diffstat (limited to 'lib/ssl/src/ssl_session_cache_api.erl')
-rw-r--r-- | lib/ssl/src/ssl_session_cache_api.erl | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/lib/ssl/src/ssl_session_cache_api.erl b/lib/ssl/src/ssl_session_cache_api.erl index b68c75a09b..5f96f905b1 100644 --- a/lib/ssl/src/ssl_session_cache_api.erl +++ b/lib/ssl/src/ssl_session_cache_api.erl @@ -23,14 +23,20 @@ -module(ssl_session_cache_api). -include("ssl_handshake.hrl"). -include("ssl_internal.hrl"). +-include("ssl_api.hrl"). --type key() :: {{host(), inet:port_number()}, session_id()} | {inet:port_number(), session_id()}. +-export_type([session_cache_key/0, session/0, partial_key/0, session_cache_ref/0]). --callback init(list()) -> db_handle(). --callback terminate(db_handle()) -> any(). --callback lookup(db_handle(), key()) -> #session{} | undefined. --callback update(db_handle(), key(), #session{}) -> any(). --callback delete(db_handle(), key()) -> any(). --callback foldl(fun(), term(), db_handle()) -> term(). --callback select_session(db_handle(), {host(), inet:port_number()} | inet:port_number()) -> [#session{}]. --callback size(db_handle()) -> integer(). +-type session_cache_ref() :: any(). +-type session_cache_key() :: {partial_key(), ssl:session_id()}. +-opaque session() :: #session{}. +-opaque partial_key() :: {ssl:host(), inet:port_number()} | inet:port_number(). + +-callback init(list()) -> session_cache_ref(). +-callback terminate(session_cache_ref()) -> any(). +-callback lookup(session_cache_ref(), session_cache_key()) -> #session{} | undefined. +-callback update(session_cache_ref(), session_cache_key(), #session{}) -> any(). +-callback delete(session_cache_ref(), session_cache_key()) -> any(). +-callback foldl(fun(), term(), session_cache_ref()) -> term(). +-callback select_session(session_cache_ref(), {ssl:host(), inet:port_number()} | inet:port_number()) -> [#session{}]. +-callback size(session_cache_ref()) -> integer(). |