File: Memcached.pm

package info (click to toggle)
libdancer-session-memcached-perl 0.2020-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 116 kB
  • sloc: perl: 138; makefile: 2
file content (125 lines) | stat: -rw-r--r-- 2,651 bytes parent folder | download | duplicates (4)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
use strict;
use warnings;
package Dancer::Session::Memcached;
{
  $Dancer::Session::Memcached::VERSION = '0.202';
}
# ABSTRACT: Memcached-based session backend for Dancer

use base 'Dancer::Session::Abstract';

use Carp;
use Cache::Memcached;
use Dancer::Config 'setting';
use Dancer::ModuleLoader;

# static

# singleton for the Memcached hanlde
my $MEMCACHED;

sub init {
    my $self = shift;

    $self->SUPER::init(@_);

    my $servers = setting("memcached_servers");
    croak "The setting memcached_servers must be defined"
      unless defined $servers;
    $servers = [split /,/, $servers];

    # make sure the servers look good
    foreach my $s (@$servers) {
        if ($s =~ /^\d+\.\d+\.\d+\.\d+$/) {
            croak "server `$s' is invalid; port is missing, use `server:port'";
        }
    }

    $MEMCACHED = Cache::Memcached->new(servers => $servers);
}

# create a new session and return the newborn object
# representing that session
sub create {
    my ($class) = @_;
    my $self = $class->new;
    $MEMCACHED->set($self->id => $self);
    return $self;
}

# Return the session object corresponding to the given id
sub retrieve($$) { ## no critic
    my ($class, $id) = @_;
    return $MEMCACHED->get($id);
}

# instance

sub destroy {
    my ($self) = @_;
    $MEMCACHED->delete($self->id);
}

sub flush {
    my $self = shift;
    $MEMCACHED->set($self->id => $self);
    return $self;
}

1;



=pod

=head1 NAME

Dancer::Session::Memcached - Memcached-based session backend for Dancer

=head1 VERSION

version 0.202

=head1 DESCRIPTION

This module implements a session engine based on the Memcache API. Session are
stored as memcache objects via a list of Memcached servers.

=head1 CONFIGURATION

The setting B<session> should be set to C<memcached> in order to use this
session engine in a Dancer application.

A mandatory setting is needed as well: C<memcached_servers>, which should
contain a comma-separated list of reachable memecached servers (can be either 
address:port or sockets).

Here is an example configuration that uses this session engine

    session: "memcached"
    memcached_servers: "10.0.1.31:11211,10.0.1.32:11211,10.0.1.33:11211,/var/sock/memcached"

=head1 DEPENDENCY

This module depends on L<Cache::Memcached>.

=head1 SEE ALSO

See L<Dancer::Session> for details about session usage in route handlers.

=head1 AUTHOR

Alexis Sukrieh <surkia@sukria.net>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2011 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.

=cut


__END__