Peter Flanigan
and 1 contributors

Name

IPC::SRLock::Exception - Exception class

Version

0.7.$Revision: 183 $

Synopsis

Description

Implements throw and catch error semantics. Inherits from Exception::Class

Subroutines/Methods

new

Create an exception object. You probably do not want to call this directly, but indirectly through "catch" and "throw"

catch

   $e = IPC::SRLock::Exception->catch( $error );

Catches and returns a thrown exception or generates a new exception if EVAL_ERROR has been set

full_message

   $printable_string = $e->full_message

What an instance of this class stringifies to

stacktrace

   $lines = $e->stacktrace( $num_lines_to_skip );

Return the stack trace. Defaults to skipping one (the first) line of output

throw

   IPC::SRLock::Exception->throw( $error );

Create (or re-throw) an exception to be caught by the catch above. If the passed parameter is a reference it is re-thrown. If a single scalar is passed it is taken to be an error message code, a new exception is created with all other parameters taking their default values. If more than one parameter is passed the it is treated as a list and used to instantiate the new exception. The 'error' parameter must be provided in this case

throw_on_error

   IPC::SRLock::Exception->throw_on_error( $error );

Calls "catch" and if the was an exception "throw"s it

Diagnostics

None

Configuration and Environment

The $IGNORE package variable is list of methods whose presence should be suppressed in the stack trace output

Dependencies

Exception::Class
MRO::Compat
Scalar::Util

Incompatibilities

There are no known incompatibilities in this module

Bugs and Limitations

There are no known bugs in this module. The default ignore package list should be configurable. Please report problems to the address below. Patches are welcome

Author

Peter Flanigan, <Support at RoxSoft.co.uk>

License and Copyright

Copyright (c) 2010 Peter Flanigan. All rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic

This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE