Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Crypt::OpenPGP::ErrorHUsereContributed Perl DocCrypt::OpenPGP::ErrorHandler(3)

NAME
       Crypt::OpenPGP::ErrorHandler - Crypt::OpenPGP error handling

SYNOPSIS
	   package Foo;
	   use Crypt::OpenPGP::ErrorHandler;
	   use base qw(	Crypt::OpenPGP::ErrorHandler );

	   sub class_method {
	       my $class = shift;
	       # Stuff happens...
	       return $class->error("Help!");
	   }

	   sub object_method {
	       my $obj = shift;
	       # Stuff happens...
	       return $obj->error("I am	no more");
	   }

	   package main;

	   Foo->class_method or	die Foo->errstr;

	   my $foo = Foo->new;
	   $foo->object_method or die $foo->errstr;

DESCRIPTION
       Crypt::OpenPGP::ErrorHandler provides an	error-handling mechanism for
       all Crypt::OpenPGP modules/classes. It is meant to be used as a base
       class for classes that wish to use its error-handling methods: derived
       classes use its two methods, error and errstr, to communicate error
       messages	back to	the calling program.

       On failure (for whatever	reason), a subclass should call	error and
       return to the caller; error itself sets the error message internally,
       then returns "undef". This has the effect of the	method that failed
       returning "undef" to the	caller.	The caller should check	for errors by
       checking	for a return value of "undef", and in this case	should call
       errstr to get the value of the error message. Note that calling errstr
       when an error has not occurred is undefined behavior and	will rarely do
       what you	want.

       As demonstrated in the SYNOPSIS (above),	error and errstr work both as
       class methods and as object methods.

USAGE
   Class->error($message)
   $object->error($message)
       Sets the	error message for either the class Class or the	object $object
       to the message $message.	Returns	"undef".

   Class->errstr
   $object->errstr
       Accesses	the last error message set in the class	Class or the object
       $object,	respectively, and returns that error message.

AUTHOR & COPYRIGHTS
       Please see the Crypt::OpenPGP manpage for author, copyright, and
       license information.

perl v5.24.1			  2009-12-11   Crypt::OpenPGP::ErrorHandler(3)

NAME | SYNOPSIS | DESCRIPTION | USAGE | AUTHOR & COPYRIGHTS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Crypt::OpenPGP::ErrorHandler&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help