.\" -*- 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 "Razor2::Errorhandler 3pm"
.TH Razor2::Errorhandler 3pm 2024-03-07 "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
Razor::Errorhandler \- Error handling mechanism for Razor.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    package Foo;
\&
\&    use Razor::Errorhandler;
\&    @ISA = qw(Razor::Errorhandler);
\&
\&    sub alive { 
\&        ..
\&        ..
\&        return 
\&        $self\->error ("Awake, awake! Ring the alarum bell. \e
\&                       Murther and treason!", $dagger) 
\&            if $self\->murdered($king);
\&    }
\&
\&
\&    package main; 
\&
\&    use Foo;
\&    my $foo = new Foo;
\&    $foo\->alive($king) or print $foo\->errstr(); 
\&    # prints "Awake, awake! ... "
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Razor::Errorhandler encapsulates the error handling mechanism used by the
modules in Razor bundle. Razor::Errorhandler doesn't have a constructor
and is meant to be inherited. The derived modules use its two methods,
\&\fBerror()\fR and \fBerrstr()\fR, to communicate error messages to the caller.
.PP
When a method of the derived module fails, it calls \f(CW$self\fR\->\fBerror()\fR and
returns  to the caller. The error message passed to \fBerror()\fR is made
available to the caller through the \fBerrstr()\fR accessor. \fBerror()\fR also
accepts a list of sensitive data that it wipes out (undef'es) before
returning.
.PP
The caller should \fBnever\fR call \fBerrstr()\fR to check for errors. \fBerrstr()\fR
should be called only when a method indicates (usually through an undef
return value) that an error has occured. This is because \fBerrstr()\fR is
never overwritten and will always contain a value after the occurance of
first error.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "\fBerror($mesage, ($wipeme, \fR\fB$wipemetoo\fR\fB))\fR" 4
.el .IP "\fBerror($mesage, ($wipeme, \fR\f(CB$wipemetoo\fR\fB))\fR" 4
.IX Item "error($mesage, ($wipeme, $wipemetoo))"
The first argument to \fBerror()\fR is \f(CW$message\fR which is placed in
\&\f(CW$self\fR\->{errstr} and the remaining arguments are interpretted as variables
containing sensitive data that are wiped out from the memory. \fBerror()\fR
always returns undef.
.IP \fBerrstr()\fR 4
.IX Item "errstr()"
\&\fBerrstr()\fR is an accessor method for \f(CW$self\fR\->{errstr}.
.SH AUTHOR
.IX Header "AUTHOR"
Vipul Ved Prakash, <mail@vipul.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBRazor::Client\fR\|(3)