.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NetSDS::Session 3pm"
.TH NetSDS::Session 3pm "2021-12-26" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
NetSDS::Session \- memcached based session storage API
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use NetSDS::Session;
\&
\&        # Connecting to Memcached server
\&        my $sess = NetSDS::Session\->new(
\&                host => \*(Aq12.34.56.78\*(Aq,
\&                port => \*(Aq12345\*(Aq,
\&        );
\&
\&        ...
\&
\&        # Retrieve session key somehow
\&        $session_key = $cgi\->param(\*(Aqsess_key\*(Aq);
\&
\&        $sess\->open($session_key);
\&
\&        my $filter = $sess\->get(\*(Aqfilter\*(Aq);
\&        ...
\&        $sess\->set(\*(Aqfilter\*(Aq, $new_filter);
\&        ...
\&        $sess\->close();
\&
\&        1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`NetSDS::Session\*(C'\fR module provides \s-1API\s0 to session data storage based on Memcached server.
.PP
Each session represented as hash reference structure identified by \s-1UUID\s0 string.
Most reasonable usage of this module is a temporary data storing for web based \s-1GUI\s0
between \s-1HTTP\s0 requests. However it's possible to find some other tasks.
.PP
Internally session structure is transformed to/from \s-1JSON\s0 string when interacting with Memcached.
.SH "CLASS API"
.IX Header "CLASS API"
.IP "\fBnew(%params)\fR \- class constructor" 4
.IX Item "new(%params) - class constructor"
Constructor establish connection to memcached server and set default session parameters.
.Sp
Parameters:
.Sp
.Vb 2
\&        * host \- memcached server hostname or IP address (default: 127.0.0.1)
\&        * port \- memcached server TCP port (default: 11211)
.Ve
.Sp
Example:
.Sp
.Vb 4
\&        my $sess_hdl = NetSDS::Session\->new(
\&                host => \*(Aq12.34.56.78\*(Aq,
\&                port => \*(Aq99999\*(Aq,
\&        );
.Ve
.IP "\fBopen($sess_id)\fR \- open session" 4
.IX Item "open($sess_id) - open session"
Retrieve session data from server by session key (\s-1UUID\s0 string)
.Sp
If no session exists then empty hashref is returned.
.IP "\fB\fBid()\fB\fR \- get session id" 4
.IX Item "id() - get session id"
Returns current session id.
.Sp
Example:
.Sp
.Vb 1
\&        my $sess_id = $sess\->id();
.Ve
.IP "\fBset($key, \f(CB$value\fB)\fR \- set session parameter" 4
.IX Item "set($key, $value) - set session parameter"
Set new session parameter value identified by it's key.
.Sp
Example:
.Sp
.Vb 1
\&        $sess\->set(\*(Aqorder\*(Aq, \*(Aqid desc\*(Aq);
.Ve
.IP "\fBget($key)\fR \- get session parameter" 4
.IX Item "get($key) - get session parameter"
Return session parameter value by it's key.
.Sp
Example:
.Sp
.Vb 1
\&        my $order = $sess\->get(\*(Aqorder\*(Aq);
.Ve
.IP "\fBdelete($key)\fR \- delete session parameter by key" 4
.IX Item "delete($key) - delete session parameter by key"
Delete session parameter by it's key.
.Sp
Returns updated session data as hash reference.
.Sp
Example:
.Sp
.Vb 1
\&        $sess\->delete(\*(Aqorder\*(Aq);
.Ve
.IP "\fB\fBclear()\fB\fR \- clear session data" 4
.IX Item "clear() - clear session data"
This method clears all session data.
.Sp
Example:
.Sp
.Vb 1
\&        $sess\->clear();
.Ve
.IP "\fB\fBsync()\fB\fR \- save session" 4
.IX Item "sync() - save session"
Synchronize session data on Memcached server.
.Sp
Example:
.Sp
.Vb 1
\&        $sess\->sync();
.Ve
.IP "\fB\fBclose()\fB\fR \- save and close session" 4
.IX Item "close() - save and close session"
This method save all data to server and clear current session id and data from object.
.Sp
Example:
.Sp
.Vb 1
\&        $session\->close();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Cache::Memcached::Fast \- \s-1XS\s0 implementation of Memcached \s-1API\s0
.IP "\(bu" 4
\&\s-1JSON\s0 \- \s-1JSON\s0 encoding/decoding \s-1API\s0
.SH "AUTHORS"
.IX Header "AUTHORS"
Michael Bochkaryov <misha@rattler.kiev.ua>
.SH "THANKS"
.IX Header "THANKS"
Yana Kornienko \- for initial module implementation
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2008\-2009 Net Style Ltd.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0  02111\-1307  \s-1USA\s0