.\" -*- 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 "CGI::Session::Serialize::freezethaw 3" .TH CGI::Session::Serialize::freezethaw 3 2023-07-25 "perl v5.38.0" "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 CGI::Session::Serialize::freezethaw \- serializer for CGI::Session .SH DESCRIPTION .IX Header "DESCRIPTION" This library can be used by CGI::Session to serialize session data. Uses FreezeThaw. .SH METHODS .IX Header "METHODS" .IP "freeze($class, \e%hash)" 4 .IX Item "freeze($class, %hash)" Receives two arguments. First is the class name, the second is the data to be serialized. Should return serialized string on success, undef on failure. Error message should be set using \f(CW\*(C`set_error()|CGI::Session::ErrorHandler/"set_error()"\*(C'\fR .ie n .IP "thaw($class, $string)" 4 .el .IP "thaw($class, \f(CW$string\fR)" 4 .IX Item "thaw($class, $string)" Received two arguments. First is the class name, second is the \fIfrozen\fR data string. Should return thawed data structure on success, undef on failure. Error message should be set using \f(CW\*(C`set_error()|CGI::Session::ErrorHandler/"set_error()"\*(C'\fR .SH LICENSING .IX Header "LICENSING" For support and licensing see CGI::Session