-
Notifications
You must be signed in to change notification settings - Fork 0
/
amelinium.proto.session.html
36 lines (36 loc) · 34 KB
/
amelinium.proto.session.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>amelinium.proto.session documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script><link rel="stylesheet" type="text/css" href="css/randomseed.css" /></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Amelinium</span> <span class="project-version">1.0.1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="10_introduction.html"><div class="inner"><span>Introduction</span></div></a></li><li class="depth-1 "><a href="20_hypermedia.html"><div class="inner"><span>Hypermedia-driven</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><a href="amelinium.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>amelinium</span></div></a></li><li class="depth-2 branch"><a href="amelinium.admin.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>admin</span></div></a></li><li class="depth-2"><a href="amelinium.api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>api</span></div></a></li><li class="depth-3"><a href="amelinium.api.controller.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>controller</span></div></a></li><li class="depth-4"><a href="amelinium.api.controller.user.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>user</span></div></a></li><li class="depth-3"><a href="amelinium.api.url.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>url</span></div></a></li><li class="depth-2 branch"><a href="amelinium.app.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>app</span></div></a></li><li class="depth-2"><a href="amelinium.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>algo</span></div></div></li><li class="depth-4 branch"><a href="amelinium.auth.algo.append.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>append</span></div></a></li><li class="depth-4 branch"><a href="amelinium.auth.algo.fail.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>fail</span></div></a></li><li class="depth-4 branch"><a href="amelinium.auth.algo.pbkdf2.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>pbkdf2</span></div></a></li><li class="depth-4"><a href="amelinium.auth.algo.scrypt.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scrypt</span></div></a></li><li class="depth-3 branch"><a href="amelinium.auth.pwd.html"><div class="inner"><span class="tree" style="top: -145px;"><span class="top" style="height: 154px;"></span><span class="bottom"></span></span><span>pwd</span></div></a></li><li class="depth-3"><a href="amelinium.auth.specs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>specs</span></div></a></li><li class="depth-2"><a href="amelinium.common.html"><div class="inner"><span class="tree" style="top: -238px;"><span class="top" style="height: 247px;"></span><span class="bottom"></span></span><span>common</span></div></a></li><li class="depth-3 branch"><a href="amelinium.common.controller.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>controller</span></div></a></li><li class="depth-3"><a href="amelinium.common.oplog.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oplog</span></div></a></li><li class="depth-4"><a href="amelinium.common.oplog.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-3 branch"><a href="amelinium.common.populators.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>populators</span></div></a></li><li class="depth-3"><a href="amelinium.common.swagger.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>swagger</span></div></a></li><li class="depth-2 branch"><a href="amelinium.core.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><a href="amelinium.db.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></a></li><li class="depth-3"><a href="amelinium.db.sql.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sql</span></div></a></li><li class="depth-2 branch"><a href="amelinium.errors.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>errors</span></div></a></li><li class="depth-2"><a href="amelinium.http.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></div></li><li class="depth-4"><a href="amelinium.http.client.twilio.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>twilio</span></div></a></li><li class="depth-3 branch"><a href="amelinium.http.handler.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-3"><a href="amelinium.http.middleware.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>middleware</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.coercion.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>coercion</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.content.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>content</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.db.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.debug.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>debug</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.format.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>format</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.headers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>headers</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.language.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>language</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.lazy-req.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lazy-req</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.populators.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>populators</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.remote-ip.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>remote-ip</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.roles.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>roles</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.middleware.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-4"><a href="amelinium.http.middleware.validators.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validators</span></div></a></li><li class="depth-3 branch"><a href="amelinium.http.router.html"><div class="inner"><span class="tree" style="top: -424px;"><span class="top" style="height: 433px;"></span><span class="bottom"></span></span><span>router</span></div></a></li><li class="depth-3"><a href="amelinium.http.server.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>server</span></div></a></li><li class="depth-4 branch"><a href="amelinium.http.server.jetty.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jetty</span></div></a></li><li class="depth-4"><a href="amelinium.http.server.undertow.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>undertow</span></div></a></li><li class="depth-2"><a href="amelinium.i18n.html"><div class="inner"><span class="tree" style="top: -672px;"><span class="top" style="height: 681px;"></span><span class="bottom"></span></span><span>i18n</span></div></a></li><li class="depth-3"><a href="amelinium.i18n.pluralizers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>pluralizers</span></div></a></li><li class="depth-2 branch"><a href="amelinium.identity.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>identity</span></div></a></li><li class="depth-2 branch"><a href="amelinium.locale.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>locale</span></div></a></li><li class="depth-2 branch"><a href="amelinium.logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logging</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>model</span></div></div></li><li class="depth-3 branch"><a href="amelinium.model.confirmation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>confirmation</span></div></a></li><li class="depth-3"><a href="amelinium.model.user.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>user</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>proto</span></div></div></li><li class="depth-3 branch"><a href="amelinium.proto.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-3 branch"><a href="amelinium.proto.errors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>errors</span></div></a></li><li class="depth-3 branch"><a href="amelinium.proto.identity.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>identity</span></div></a></li><li class="depth-3 branch current"><a href="amelinium.proto.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-3"><a href="amelinium.proto.twilio.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>twilio</span></div></a></li><li class="depth-2 branch"><a href="amelinium.schemas.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>schemas</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>server</span></div></div></li><li class="depth-3"><a href="amelinium.server.ssl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ssl</span></div></a></li><li class="depth-2 branch"><a href="amelinium.system.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>system</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>types</span></div></div></li><li class="depth-3 branch"><a href="amelinium.types.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-3 branch"><a href="amelinium.types.db.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></a></li><li class="depth-3 branch"><a href="amelinium.types.errors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>errors</span></div></a></li><li class="depth-3 branch"><a href="amelinium.types.identity.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>identity</span></div></a></li><li class="depth-3 branch"><a href="amelinium.types.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-3"><a href="amelinium.types.twilio.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>twilio</span></div></a></li><li class="depth-2 branch"><a href="amelinium.utils.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="amelinium.web.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>web</span></div></a></li><li class="depth-3"><a href="amelinium.web.controller.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>controller</span></div></a></li><li class="depth-4 branch"><a href="amelinium.web.controller.admin.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>admin</span></div></a></li><li class="depth-4"><a href="amelinium.web.controller.user.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>user</span></div></a></li><li class="depth-3 branch"><a href="amelinium.web.js.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>js</span></div></a></li><li class="depth-3 branch"><a href="amelinium.web.taggers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taggers</span></div></a></li><li class="depth-3"><a href="amelinium.web.url.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>url</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="amelinium.proto.session.html#var-Sessionable"><div class="inner"><span>Sessionable</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-control"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>control</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-empty.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>empty?</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-inject"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>inject</span></div></a></li><li class="depth-2"><a href="amelinium.proto.session.html#var-session"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-1"><a href="amelinium.proto.session.html#var-SessionControl"><div class="inner"><span>SessionControl</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-config"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-control.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>control?</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-session"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-session</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-sessions"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-sessions</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-svars"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-svars</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-uvars"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-uvars</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-var"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-var</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-del-vars"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>del-vars</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-empty"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>empty</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-expired.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>expired?</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-from-db"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>from-db</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-get-active"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>get-active</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-get-var"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>get-var</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-get-vars"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>get-vars</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-handle"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>handle</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-hard-expired.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>hard-expired?</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-identify"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>identify</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-invalidate"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>invalidate</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-mem-atom"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mem-atom</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-mem-cache"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mem-cache</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-mem-handler"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mem-handler</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-put-var"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>put-var</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-put-vars"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>put-vars</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-set-active"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>set-active</span></div></a></li><li class="depth-2 branch"><a href="amelinium.proto.session.html#var-to-db"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-db</span></div></a></li><li class="depth-2"><a href="amelinium.proto.session.html#var-token-ok.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>token-ok?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">amelinium.proto.session</h1><h4 class="added">added in 1.0.0</h4><div class="doc"><div class="markdown"><p>amelinium service, session protocols.</p>
</div></div><div class="public anchor" id="var-Sessionable"><h3>Sessionable</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>This protocol is used to access session data.</p>
</div></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-control"><h3>control</h3><div class="usage"><code>(control src)</code><code>(control src session-key)</code></div><div class="doc"><div class="markdown"><p>Returns a session control object (satisfying the <code>SessionControl</code> protocol) used to reach session configuration and internal operations.</p>
</div></div></div><div class="public anchor" id="var-empty.3F"><h3>empty?</h3><div class="usage"><code>(empty? src)</code><code>(empty? src session-key)</code></div><div class="doc"><div class="markdown"><p>Returns <code>false</code> is <code>src</code> contains a session or is a session, and the session has usable identifier set (<code>:id</code> or <code>:err-id</code> field is set) or has the <code>:error</code> field set. Optional <code>session-key</code> can be given to express a key in associative structure (defaults to <code>:session</code>).</p>
</div></div></div><div class="public anchor" id="var-inject"><h3>inject</h3><div class="usage"><code>(inject dst smap)</code><code>(inject dst smap session-key)</code></div><div class="doc"><div class="markdown"><p>Returns an object updated with session record of type <code>Session</code> under an optional <code>session-key</code> if session is to be put into an associative structure (defaults to <code>:session</code>).</p>
</div></div></div><div class="public anchor" id="var-session"><h3>session</h3><div class="usage"><code>(session src)</code><code>(session src session-key)</code></div><div class="doc"><div class="markdown"><p>Returns a session record of type <code>Session</code> on a basis of configuration source provided and an optional <code>session-key</code> if session must be looked in an associative structure (defaults to <code>:session</code>).</p>
</div></div></div></div></div><div class="src-link"><a href="https://github.com/randomseed-io/amelinium/tree/1.0.1/src/amelinium/proto/session.clj#L144">view source</a></div></div><div class="public anchor" id="var-SessionControl"><h3>SessionControl</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>This protocol promises access to session configuration data and basic actions which are configuration-dependent. The operations should keep access to settings and/or dynamically generated functions using lexical closures. Therefore, this protocol should later be reified, after settings are parsed, and the anonymous object with implementations should be stored in all created <code>Session</code> records, in their <code>:control</code> fields.</p>
</div></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-config"><h3>config</h3><div class="usage"><code>(config c)</code><code>(config c s-k)</code></div><div class="doc"><div class="markdown"><p>Gets a session configuration settings.</p>
</div></div></div><div class="public anchor" id="var-control.3F"><h3>control?</h3><div class="usage"><code>(control? c)</code><code>(control? c s-k)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if the given object is an instance of a class implementing <code>SessionControl</code> protocol (directly or indirectly).</p>
</div></div></div><div class="public anchor" id="var-del-session"><h3>del-session</h3><div class="usage"><code>(del-session c db-sid)</code><code>(del-session c)</code></div><div class="doc"><div class="markdown"><p>Deletes a session from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-del-sessions"><h3>del-sessions</h3><div class="usage"><code>(del-sessions c uid)</code><code>(del-sessions c)</code></div><div class="doc"><div class="markdown"><p>Deletes all user’s sessions from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-del-svars"><h3>del-svars</h3><div class="usage"><code>(del-svars c db-sid)</code><code>(del-svars c)</code></div><div class="doc"><div class="markdown"><p>Deletes all session variables from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-del-uvars"><h3>del-uvars</h3><div class="usage"><code>(del-uvars c uid)</code><code>(del-uvars c)</code></div><div class="doc"><div class="markdown"><p>Deletes all user’s session variables from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-del-var"><h3>del-var</h3><div class="usage"><code>(del-var c db-sid k)</code><code>(del-var c k)</code></div><div class="doc"><div class="markdown"><p>Deletes session variable from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-del-vars"><h3>del-vars</h3><div class="usage"><code>(del-vars c db-sid ks)</code><code>(del-vars c ks)</code></div><div class="doc"><div class="markdown"><p>Deletes session variables from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-empty"><h3>empty</h3><div class="usage"><code>(empty c)</code><code>(empty c s-k)</code></div><div class="doc"><div class="markdown"><p>Returns an empty session with the <code>:control</code> field populated.</p>
</div></div></div><div class="public anchor" id="var-expired.3F"><h3>expired?</h3><div class="usage"><code>(expired? c)</code><code>(expired? c t)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if expiration time was exceeded for <code>t</code>.</p>
</div></div></div><div class="public anchor" id="var-from-db"><h3>from-db</h3><div class="usage"><code>(from-db c db-sid ip)</code><code>(from-db c db-sid)</code><code>(from-db c)</code></div><div class="doc"><div class="markdown"><p>Gets the session data from a database.</p>
</div></div></div><div class="public anchor" id="var-get-active"><h3>get-active</h3><div class="usage"><code>(get-active c db-sid ip)</code><code>(get-active c db-sid)</code><code>(get-active c)</code></div><div class="doc"><div class="markdown"><p>Gets the session last active time from a database.</p>
</div></div></div><div class="public anchor" id="var-get-var"><h3>get-var</h3><div class="usage"><code>(get-var c db-sid k)</code><code>(get-var c k)</code></div><div class="doc"><div class="markdown"><p>Gets session variable from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-get-vars"><h3>get-vars</h3><div class="usage"><code>(get-vars c db-sid ks)</code><code>(get-vars c ks)</code></div><div class="doc"><div class="markdown"><p>Gets session variables from a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-handle"><h3>handle</h3><div class="usage"><code>(handle c sid db-sid ip)</code><code>(handle c sid ip)</code><code>(handle c sid)</code><code>(handle c)</code></div><div class="doc"><div class="markdown"><p>Obtains a session from a database and creates its object.</p>
</div></div></div><div class="public anchor" id="var-hard-expired.3F"><h3>hard-expired?</h3><div class="usage"><code>(hard-expired? c)</code><code>(hard-expired? c t)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if hard-expiration time was exceeded for <code>t</code>.</p>
</div></div></div><div class="public anchor" id="var-identify"><h3>identify</h3><div class="usage"><code>(identify c req)</code><code>(identify c)</code></div><div class="doc"><div class="markdown"><p>Extracts session ID.</p>
</div></div></div><div class="public anchor" id="var-invalidate"><h3>invalidate</h3><div class="usage"><code>(invalidate c db-sid ip)</code><code>(invalidate c db-sid)</code><code>(invalidate c)</code></div><div class="doc"><div class="markdown"><p>Invalidates internal cache.</p>
</div></div></div><div class="public anchor" id="var-mem-atom"><h3>mem-atom</h3><div class="usage"><code>(mem-atom c)</code></div><div class="doc"><div class="markdown"><p>Returns an Atom object keeping reference to a cache object associated with memoized session handler.</p>
</div></div></div><div class="public anchor" id="var-mem-cache"><h3>mem-cache</h3><div class="usage"><code>(mem-cache c)</code></div><div class="doc"><div class="markdown"><p>Returns a cache object associated with memoized session handler.</p>
</div></div></div><div class="public anchor" id="var-mem-handler"><h3>mem-handler</h3><div class="usage"><code>(mem-handler c)</code><code>(mem-handler c s-k)</code></div><div class="doc"><div class="markdown"><p>Returns memoized handler function used by <code>handle</code>.</p>
</div></div></div><div class="public anchor" id="var-put-var"><h3>put-var</h3><div class="usage"><code>(put-var c db-sid k v)</code><code>(put-var c k v)</code></div><div class="doc"><div class="markdown"><p>Puts session variable into a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-put-vars"><h3>put-vars</h3><div class="usage"><code>(put-vars c db-sid kvs)</code><code>(put-vars c kvs)</code></div><div class="doc"><div class="markdown"><p>Puts session variables into a persistent storage.</p>
</div></div></div><div class="public anchor" id="var-set-active"><h3>set-active</h3><div class="usage"><code>(set-active c db-sid ip t)</code><code>(set-active c db-sid ip)</code><code>(set-active s ip)</code><code>(set-active s)</code></div><div class="doc"><div class="markdown"><p>Sets the session last active time in a database.</p>
</div></div></div><div class="public anchor" id="var-to-db"><h3>to-db</h3><div class="usage"><code>(to-db c smap)</code></div><div class="doc"><div class="markdown"><p>Puts the session data into a database.</p>
</div></div></div><div class="public anchor" id="var-token-ok.3F"><h3>token-ok?</h3><div class="usage"><code>(token-ok? c plain enc)</code></div><div class="doc"><div class="markdown"><p>Checks if the security token is valid.</p>
</div></div></div></div></div><div class="src-link"><a href="https://github.com/randomseed-io/amelinium/tree/1.0.1/src/amelinium/proto/session.clj#L16">view source</a></div></div></div></body></html>