View Source nova_session behaviour (nova v0.11.0)

All kind of operations on sessions is handled by the nova_session-module. The module also presents a behaviour that can be used to create customized backends for the session-data.

Summary

Callbacks

delete_value/1
delete_value/2
get_value/2
set_value/3

Functions

delete(Req)
delete(Req, Key)
generate_session_id()
get(Req, Key)
set(Req, Key, Value)

Callbacks

Link to this callback

delete_value/1

View Source 
-callback delete_value(SessionId) -> ok | {error, Reason :: atom()} when SessionId :: binary().
Link to this callback

delete_value/2

View Source 
-callback delete_value(SessionId, Key) -> ok | {error, Reason :: atom()}
                          when SessionId :: binary(), Key :: binary().
Link to this callback

get_value/2

View Source 
-callback get_value(SessionId, Key) -> {ok, Value :: any()} | {error, Reason :: atom()}
                       when SessionId :: binary(), Key :: binary().
Link to this callback

set_value/3

View Source 
-callback set_value(SessionId, Key, Value) -> ok | {error, Reason :: atom()}
                       when SessionId :: binary(), Key :: binary(), Value :: binary().

Functions

Link to this function

delete(Req)

View Source 
-spec delete(Req :: cowboy_req:req()) -> {ok, Req :: cowboy_req:req()} | {error, Reason :: atom()}.
Link to this function

delete(Req, Key)

View Source 
-spec delete(Req :: cowboy_req:req(), Key :: binary()) ->
                {ok, Req :: cowboy_req:req()} | {error, Reason :: atom()} | no_return().
Link to this function

generate_session_id()

View Source
Link to this function

get(Req, Key)

View Source 
-spec get(Req :: cowboy_req:req(), Key :: binary()) ->
             {ok, Value :: binary()} | {error, Reason :: atom()} | no_return().
Link to this function

set(Req, Key, Value)

View Source 
-spec set(Req :: cowboy_req:req(), Key :: binary(), Value :: binary()) ->
             ok | {error, Reason :: atom()} | no_return().