File Coverage

blib/lib/Dancer/Session/Memcached.pm

Criterion	Covered	Total	%
statement	34	41	82.9
branch	4	4	100.0
condition			n/a
subroutine	9	12	75.0
pod	5	5	100.0
total	52	62	83.8

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 should be set to C in order to use this
session engine in a Dancer application.

A mandatory setting is needed as well: C, 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.

=head1 SEE ALSO

See L for details about session usage in route handlers.

=head1 AUTHOR

Alexis Sukrieh

=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__