Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.44 KB

README.md

File metadata and controls

65 lines (40 loc) · 1.44 KB

Canister

An Erlang Session Management system

The standard session management system for Nitrogen

Features

  • Data Persistence (stored in mnesia)
  • Data is replicated across all connected node
  • Automatic self-healing in the event of split brain, new nodes being added to the cluster, and more.
  • Expired sessions automatically deleted accordingly

Include the dependency

Add as a rebar dependency in your rebar.config

{deps, [canister]}.

Start It

Put it in your app.src file or start it explicitly with:

application:ensure_all_started(canister).

Functionality

Save a Session Variable

canister:put(SessionID, Key, Value).

Returns: Previously stored Value or undefined

Retrieving a Session Variable

canister:get(SessionID, Key).

Returns: Value or undefined

Inspecting specific Session Info

canister:session_info(SessionID).

Retrieves all data variables as well as relevant dates and times: when it was last accessed, updated, or deleted

Configuration

See canister.config for explanation of configuration variables.

Note: session_timeout variable will also check the nitrogen and nitrogen_core app configs, just in case.

License

Copyright 2022 Jesse Gumm

MIT Licensed