Plug

v1.8.1

Plug v1.8.1 Plug.Session.Store behaviour View Source

Specification for session stores.

Link to this section Summary

Types

cookie()

The cookie value that will be sent in cookie headers. This value should be base64 encoded to avoid security issues

session()

The session contents, the final data to be stored after it has been built with Plug.Conn.put_session/3 and the other session manipulating functions

sid()

The internal reference to the session in the store

Functions

get(store)

Gets the store name from an atom or a module

Callbacks

delete(arg0, sid, arg2)

Removes the session associated with given session id from the store

get(arg0, cookie, arg2)

Parses the given cookie

init(arg0)

Initializes the store

put(arg0, sid, any, arg3)

Stores the session associated with given session id

Link to this section Types

Link to this type

cookie() View Source 
cookie() :: binary()

The cookie value that will be sent in cookie headers. This value should be base64 encoded to avoid security issues.

Link to this type

session() View Source 
session() :: map()

The session contents, the final data to be stored after it has been built with Plug.Conn.put_session/3 and the other session manipulating functions.

Link to this type

sid() View Source 
sid() :: term() | nil

The internal reference to the session in the store.

Link to this section Functions

Link to this function

get(store) View Source

Gets the store name from an atom or a module.

iex> Plug.Session.Store.get(CustomStore)
CustomStore

iex> Plug.Session.Store.get(:cookie)
Plug.Session.COOKIE

Link to this section Callbacks

Link to this callback

delete(arg0, sid, arg2) View Source 
delete(Plug.Conn.t(), sid(), Plug.opts()) :: :ok

Removes the session associated with given session id from the store.

Link to this callback

get(arg0, cookie, arg2) View Source 
get(Plug.Conn.t(), cookie(), Plug.opts()) :: {sid(), session()}

Parses the given cookie.

Returns a session id and the session contents. The session id is any value that can be used to identify the session by the store.

The session id may be nil in case the cookie does not identify any value in the store. The session contents must be a map.

Link to this callback

init(arg0) View Source 
init(Plug.opts()) :: Plug.opts()

Initializes the store.

The options returned from this function will be given to get/3, put/4 and delete/3.

Link to this callback

put(arg0, sid, any, arg3) View Source 
put(Plug.Conn.t(), sid(), any(), Plug.opts()) :: cookie()

Stores the session associated with given session id.

If nil is given as id, a new session id should be generated and returned.