[ViewVC] Diff of: cvs/Guard/Guard.pm

Comparing Guard/Guard.pm (file contents):
Revision 1.9 by root, Sat Dec 13 18:49:22 2008 UTC vs.
Revision 1.22 by root, Sun Jul 26 08:07:11 2009 UTC

…		…
10	# to go back to "/" no matter how myfun exits:	10	# to go back to "/" no matter how myfun exits:
11	sub myfun {	11	sub myfun {
12	scope_guard { chdir "/" };	12	scope_guard { chdir "/" };
13	chdir "/etc";	13	chdir "/etc";
14		14
15	call_function_that_might_die_or_other_fun_stuff;	15	code_that_might_die_or_does_other_fun_stuff;
16	}	16	}
		17
		18	# create an object that, when the last reference to it is gone,
		19	# invokes the given codeblock:
		20	my $guard = guard { print "destroyed!\n" };
		21	undef $guard; # probably destroyed here
17		22
18	=head1 DESCRIPTION	23	=head1 DESCRIPTION
19		24
20	This module implements so-called "guards". A guard is something (usually	25	This module implements so-called "guards". A guard is something (usually
21	an object) that "guards" a resource, ensuring that it is cleaned up when	26	an object) that "guards" a resource, ensuring that it is cleaned up when
…		…
34		39
35	=cut	40	=cut
36		41
37	package Guard;	42	package Guard;
38		43
		44	no warnings;
		45
39	BEGIN {	46	BEGIN {
40	$VERSION = '0.1';	47	$VERSION = '1.021';
41	@ISA = qw(Exporter);	48	@ISA = qw(Exporter);
42	@EXPORT = qw(guard scope_guard);	49	@EXPORT = qw(guard scope_guard);
43		50
44	require Exporter;	51	require Exporter;
45		52
…		…
101	Behaves the same as C<scope_guard>, except that instead of executing	108	Behaves the same as C<scope_guard>, except that instead of executing
102	the block on scope exit, it returns an object whose lifetime determines	109	the block on scope exit, it returns an object whose lifetime determines
103	when the BLOCK gets executed: when the last reference to the object gets	110	when the BLOCK gets executed: when the last reference to the object gets
104	destroyed, the BLOCK gets executed as with C<scope_guard>.	111	destroyed, the BLOCK gets executed as with C<scope_guard>.
105		112
106	The returned object can be copied as many times as you want.
107
108	See the EXCEPTIONS section for an explanation of how exceptions	113	See the EXCEPTIONS section for an explanation of how exceptions
109	(i.e. C<die>) are handled inside guard blocks.	114	(i.e. C<die>) are handled inside guard blocks.
110		115
111	Example: acquire a Coro::Semaphore for a second by registering a	116	Example: acquire a Coro::Semaphore for a second by registering a
112	timer. The timer callback references the guard used to unlock it again.	117	timer. The timer callback references the guard used to unlock it
		118	again. (Please ignore the fact that C<Coro::Semaphore> has a C<guard>
		119	method that does this already):
113		120
114	use Guard;	121	use Guard;
115	use AnyEvent;	122	use Coro::AnyEvent;
116	use Coro::Semaphore;	123	use Coro::Semaphore;
117		124
118	my $sem = new Coro::Semaphore;	125	my $sem = new Coro::Semaphore;
119		126
120	sub lock_for_a_second {	127	sub lock_for_a_second {
121	$sem->down;	128	$sem->down;
122	my $guard = guard { $sem->up };	129	my $guard = guard { $sem->up };
123		130
124	my $timer;	131	Coro::AnyEvent::sleep 1;
125	$timer = AnyEvent->timer (after => 1, sub {	132
126	# do something	133	# $sem->up gets executed when returning
127	undef $sem;
128	undef $timer;
129	});
130	}	134	}
131		135
132	The advantage of doing this with a guard instead of simply calling C<<	136	The advantage of doing this with a guard instead of simply calling C<<
133	$sem->down >> in the callback is that you can opt not to create the timer,	137	$sem->down >> in the callback is that you can opt not to create the timer,
134	or your code can throw an exception before it can create the timer, or you	138	or your code can throw an exception before it can create the timer (or
135	can create multiple timers or other event watchers and only when the last	139	the thread gets canceled), or you can create multiple timers or other
136	one gets executed will the lock be unlocked.	140	event watchers and only when the last one gets executed will the lock be
		141	unlocked. Using the C<guard>, you do not have to worry about catching all
		142	the places where you have to unlock the semaphore.
137		143
138	=item Guard::cancel $guard	144	=item $guard->cancel
139		145
140	Calling this function will "disable" the guard object returned by the	146	Calling this function will "disable" the guard object returned by the
141	C<guard> function, i.e. it will free the BLOCK originally passed to	147	C<guard> function, i.e. it will free the BLOCK originally passed to
142	C<guard >and will arrange for the BLOCK not to be executed.	148	C<guard >and will arrange for the BLOCK not to be executed.
143		149
144	This can be useful when you use C<guard> to create a fatal cleanup handler	150	This can be useful when you use C<guard> to create a cleanup handler to be
145	and later decide it is no longer needed.	151	called under fatal conditions and later decide it is no longer needed.
146		152
147	=cut	153	=cut
148		154
149	1;	155	1;
150		156
151	=back	157	=back
152		158
153	=head1 EXCEPTIONS	159	=head1 EXCEPTIONS
154		160
155	Guard blocks should not normally throw exceptions (that is, C<die>). After	161	Guard blocks should not normally throw exceptions (that is, C<die>). After
156	all, they are usually used to clean up after such exceptions. However, if	162	all, they are usually used to clean up after such exceptions. However,
157	something truly exceptional is happening, a guard block should be allowed	163	if something truly exceptional is happening, a guard block should of
158	to die. Also, programming errors are a large source of exceptions, and the	164	course be allowed to die. Also, programming errors are a large source of
159	programmer certainly wants to know about those.	165	exceptions, and the programmer certainly wants to know about those.
160		166
161	Since in most cases, the block executing when the guard gets executes does	167	Since in most cases, the block executing when the guard gets executed does
162	not know or does not care about the guard blocks, it makes little sense to	168	not know or does not care about the guard blocks, it makes little sense to
163	let containing code handle the exception.	169	let containing code handle the exception.
164		170
165	Therefore, whenever a guard block throws an exception, it will be caught,	171	Therefore, whenever a guard block throws an exception, it will be caught
166	and this module will call the code reference stored in C<$Guard::DIED>	172	by Guard, followed by calling the code reference stored in C<$Guard::DIED>
167	(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
168	event loops handle this case.	174	event loops handle this case.
169		175
		176	The default for C<$Guard::DIED> is to call C<warn "$@">, i.e. the error is
		177	printed as a warning and the program continues.
		178
		179	The C<$@> variable will be restored to its value before the guard call in
		180	all cases, so guards will not disturb C<$@> in any way.
		181
170	The code reference stored in C<$Guard::DIED> should not die (behaviour is	182	The code reference stored in C<$Guard::DIED> should not die (behaviour is
171	not guaranteed, but right now, the exception will simply be ignored).	183	not guaranteed, but right now, the exception will simply be ignored).
172		184
173	The default for C<$Guard::DIED> is to call C<warn "$@">.
174
175	=head1 AUTHOR	185	=head1 AUTHOR
176		186
177	Marc Lehmann <schmorp@schmorp.de>	187	Marc Lehmann <schmorp@schmorp.de>
178	http://home.schmorp.de/	188	http://home.schmorp.de/
179		189
180	=head1 THANKS	190	=head1 THANKS
181		191
182	Thanks to Marco Maisenhelder, who reminded me of the C<$Guard::DIED>	192	Thanks to Marco Maisenhelder, who reminded me of the C<$Guard::DIED>
183	solution to the problem of exceptions.	193	solution to the problem of exceptions.
184		194
		195	=head1 SEE ALSO
		196
		197	L<Scope::Guard> and L<Sub::ScopeFinalizer>, which actually implement
		198	dynamic guards only, not scoped guards, and have a lot higher CPU, memory
		199	and typing overhead.
		200
		201	L<Hook::Scope>, which has apparently never been finished and can corrupt
		202	memory when used.
		203
185	=cut	204	=cut
186		205

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing Guard/Guard.pm (file contents): Revision 1.9 by root, Sat Dec 13 18:49:22 2008 UTC vs. Revision 1.22 by root, Sun Jul 26 08:07:11 2009 UTC

Diff Legend

Comparing Guard/Guard.pm (file contents):
Revision 1.9 by root, Sat Dec 13 18:49:22 2008 UTC vs.
Revision 1.22 by root, Sun Jul 26 08:07:11 2009 UTC