.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. 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
.\" ========================================================================
.\"
.IX Title "Net::HTTPServer::Session 3"
.TH Net::HTTPServer::Session 3 2024-03-04 "perl v5.38.2" "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
Net::HTTPServer::Session
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Net::HTTPServer::Session handles server side client sessions
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Net::HTTPServer::Session provides a server side data store for client
specific sessions. It uses a cookie stored on the browser to tell
the server which session to restore to the user. This is modelled
after the PHP session concept. The session is valid for 4 hours from
the last time the cookie was sent.
.SH EXAMPLES
.IX Header "EXAMPLES"
sub pageHandler
{
my \f(CW$request\fR = shift;
.PP
.Vb 1
\& my $session = $request\->Session();
\&
\& my $response = $request\->Response();
\&
\& # Logout
\& $session\->Destroy() if $request\->Env("logout");
\&
\& $response\->Print("Hi there");
\&
\& # If the user specified a username on the URL, then save it.
\& if ($request\->Env("username"))
\& {
\& $session\->Set("username",$request\->Env("username"));
\& }
\&
\& # If there is a saved username, then use it.
\& if ($session\->Get("username"))
\& {
\& $response\->Print("Hello, ",$session\->Get("username"),"!");
\& }
\& else
\& {
\& $response\->Print("Hello, stranger!");
\& }
\&
\& $response\->Print("");
\&
\& return $response;
\&}
.Ve
.PP
The above would behave as follows:
.PP
.Vb 7
\& http://server/page \- Hello, stranger!
\& http://server/page?username=Bob \- Hello, Bob!
\& http://server/page \- Hello, Bob!
\& http://server/page?username=Fred \- Hello, Fred!
\& http://server/page \- Hello, Fred!
\& http://server/page?logout=1 \- Hello, stranger!
\& http://server/page \- Hello, stranger!
.Ve
.SH METHODS
.IX Header "METHODS"
.SS Delete(var)
.IX Subsection "Delete(var)"
Delete the specified variable from the session.
.SS \fBDestroy()\fP
.IX Subsection "Destroy()"
Destroy the session. The server side data is deleted and the cookie
will be expired.
.SS Exists(var)
.IX Subsection "Exists(var)"
Returns if the specified variable exists in the sesion.
.SS Get(var)
.IX Subsection "Get(var)"
Return the value of the specified variable from the session if it
exists, undef otherwise.
.SS Set(var,value)
.IX Subsection "Set(var,value)"
Store the specified value (scalar or reference to any Perl data
structure) in the session.
.SH AUTHOR
.IX Header "AUTHOR"
Ryan Eatmon
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2003\-2005 Ryan Eatmon . All rights
reserved. This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.