ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Guard/Guard.pm
(Generate patch)

Comparing Guard/Guard.pm (file contents):
Revision 1.11 by root, Sat Dec 13 18:51:19 2008 UTC vs.
Revision 1.13 by root, Sat Dec 13 19:14:58 2008 UTC

34 34
35=cut 35=cut
36 36
37package Guard; 37package Guard;
38 38
39no warnings;
40
39BEGIN { 41BEGIN {
40 $VERSION = '0.1'; 42 $VERSION = '0.5';
41 @ISA = qw(Exporter); 43 @ISA = qw(Exporter);
42 @EXPORT = qw(guard scope_guard); 44 @EXPORT = qw(guard scope_guard);
43 45
44 require Exporter; 46 require Exporter;
45 47
137can create multiple timers or other event watchers and only when the last 139can create multiple timers or other event watchers and only when the last
138one gets executed will the lock be unlocked. Using the C<guard>, you do 140one gets executed will the lock be unlocked. Using the C<guard>, you do
139not have to worry about catching all the places where you have to unlock 141not have to worry about catching all the places where you have to unlock
140the semaphore. 142the semaphore.
141 143
142=item Guard::cancel $guard 144=item $guard->cancel
143 145
144Calling this function will "disable" the guard object returned by the 146Calling this function will "disable" the guard object returned by the
145C<guard> function, i.e. it will free the BLOCK originally passed to 147C<guard> function, i.e. it will free the BLOCK originally passed to
146C<guard >and will arrange for the BLOCK not to be executed. 148C<guard >and will arrange for the BLOCK not to be executed.
147 149
169Therefore, whenever a guard block throws an exception, it will be caught, 171Therefore, whenever a guard block throws an exception, it will be caught,
170and this module will call the code reference stored in C<$Guard::DIED> 172and this module will call the code reference stored in C<$Guard::DIED>
171(with C<$@> set to the actual exception), which is similar to how most 173(with C<$@> set to the actual exception), which is similar to how most
172event loops handle this case. 174event loops handle this case.
173 175
176The default for C<$Guard::DIED> is to call C<warn "$@">.
177
178The C<$@> variable will be restored to its value before the guard call in
179all cases, so guards will not disturb C<$@> in any way.
180
174The code reference stored in C<$Guard::DIED> should not die (behaviour is 181The code reference stored in C<$Guard::DIED> should not die (behaviour is
175not guaranteed, but right now, the exception will simply be ignored). 182not guaranteed, but right now, the exception will simply be ignored).
176
177The default for C<$Guard::DIED> is to call C<warn "$@">.
178 183
179=head1 AUTHOR 184=head1 AUTHOR
180 185
181 Marc Lehmann <schmorp@schmorp.de> 186 Marc Lehmann <schmorp@schmorp.de>
182 http://home.schmorp.de/ 187 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines