GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Dancer2::Core::Session(3) User Contributed Perl Documentation Dancer2::Core::Session(3)

Dancer2::Core::Session - class to represent any session object

version 0.400000

A session object encapsulates anything related to a specific session: its ID, its data, and its expiration.

It is completely agnostic of how it will be stored, this is the role of a factory that consumes Dancer2::Core::Role::SessionFactory to know about that.

Generally, session objects should not be created directly. The correct way to get a new session object is to call the "create()" method on a session engine that implements the SessionFactory role. This is done automatically by the app object if a session engine is defined.

The identifier of the session object. Required. By default, Dancer2::Core::Role::SessionFactory sets this to a randomly-generated, guaranteed-unique string.

This attribute can be modified if your Session implementation requires this.

Contains the data of the session (Hash).

Number of seconds for the expiry of the session cookie. Don't add the current timestamp to it, will be done automatically.

Default is no expiry (session cookie will leave for the whole browser's session).

For a lifetime of one hour:

  expires => 3600

Boolean value for whether data in the session has been modified.

Reader on the session data

    my $value = $session->read('something');

Returns "undef" if the key does not exist in the session.

Writer on the session data

  $session->write('something', $value);

Sets "is_dirty" to true. Returns $value.

Deletes a key from session data

  $session->delete('something');

Sets "is_dirty" to true. Returns the value deleted from the session.

Dancer Core Developers

This software is copyright (c) 2022 by Alexis Sukrieh.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2022-03-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.