Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dancer::session::abstract(3pm) [debian man page]

Dancer::Session::Abstract(3pm)				User Contributed Perl Documentation			    Dancer::Session::Abstract(3pm)

NAME

       Dancer::Session::Abstract - abstract class for session engine

SPEC

       role
	   A Dancer::Session object represents a session engine and should provide anything needed to manipulate a session, whatever its storing
	   engine is.

       id  The session id will be written to a cookie, by default named "dancer.session", it is assumed that a client must accept cookies to be
	   able to use a session-aware Dancer webapp. (The cookie name can be change using the "session_name" config setting.)

       storage engine
	   When the session engine is enabled, a before filter takes care to initialize the appropriate session engine (according to the setting
	   "session").

	   Then, the filter looks for a cookie named "dancer.session" (or whatever you've set the "session_name" setting to, if you've used it) in
	   order to retrieve the current session object. If not found, a new session object is created and its id written to the cookie.

	   Whenever a session call is made within a route handler, the singleton representing the current session object is modified.

	   After terminating the request, a flush is made to the session object.

DESCRIPTION

       This virtual class describes how to build a session engine for Dancer. This is done in order to allow multiple session storage backends
       with a common interface.

       Any session engine must inherit from Dancer::Session::Abstract and implement the following abstract methods.

   Configuration
       These settings control how a session acts.

       session_name

       The default session name is "dancer_session". This can be set in your config file:

	   setting session_name: "mydancer_session"

       session_secure

       The user's session id is stored in a cookie.  If true, this cookie will be made "secure" meaning it will only be served over https.

       session_expires

       When the session should expire.	The format is either the number of seconds in the future, or the human readable offset from "expires" in
       Dancer::Cookie.

       By default, there is no expiration.

       session_is_http_only

       This setting defaults to 1 and instructs the session cookie to be created with the "HttpOnly" option active, meaning that JavaScript will
       not be able to access to its value.

   Abstract Methods
       retrieve($id)
	   Look for a session with the given id, return the session object if found, undef if not.

       create()
	   Create a new session, return the session object.

       flush()
	   Write the session object to the storage engine.

       destroy()
	   Remove the current session object from the storage engine.

       session_name (optional)
	   Returns a string with the name of cookie used for storing the session ID.

	   You should probably not override this; the user can control the cookie name using the "session_name" setting.

   Inherited Methods
       The following methods are not supposed to be overloaded, they are generic and should be OK for each session engine.

       build_id
	   Build a new uniq id.

       read_session_id
	   Reads the "dancer.session" cookie.

       write_session_id
	   Write the current session id to the "dancer.session" cookie.

perl v5.14.2							    2012-01-27					    Dancer::Session::Abstract(3pm)

Check Out this Related Man Page

Jifty::Web::Session::JDBI(3pm)				User Contributed Perl Documentation			    Jifty::Web::Session::JDBI(3pm)

NAME

       Jifty::Web::Session - A Jifty session handler

SYNOPSIS

       In your etc/config.yml (optional):

	 framework:
	   Web:
	     # The default ($PORT is replaced by the port the app is running on)
	     SessionCookieName: JIFTY_SID_$PORT

   new
       Returns a new, empty session.

   id
       Returns the session's id if it has been loaded, or "undef" otherwise.

   create
       Creates a new row in the Jifty::Model::Session table.

   load [ID]
       Load up the current session from the given "ID", or the appropriate cookie (see "cookie_name") otherwise.  If both of those fail, creates a
       session in the database.

   load_by_kv key => value
       Load up the current session from the given (key, value) pair. If no matching session could be found, it will create a new session with the
       key, value set.	Be sure that what you're loading by is unique. If you're loading a session based on, say, a timestamp, then you're asking
       for trouble.

   get KEY [TYPE]
       Returns the value for "KEY" for the current user's session.  "TYPE", which defaults to "key", allows accessing of other namespaces in the
       session, including "metadata" and "continuation".

   set KEY => VALUE, [TYPE]
       Sets the value "VALUE" for "KEY" for the session.  "TYPE", which defaults to "key", allows values to be set in other namespaces, including
       "metadata" and "continuation". "VALUE" can be an arbitrary perl data structure -- "Jifty::Web::Session" will serialize it for you.

   remove KEY, [TYPE]
       Remove key "KEY" from the cache.  "TYPE" defaults to "key".

   remove_all
       Removes the session from the database entirely.

   continuations
       Return a hash of all the continuations in this session, keyed by the continuations' "id".

perl v5.14.2							    2010-12-08					    Jifty::Web::Session::JDBI(3pm)
Man Page