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

Comparing Coro/Coro.pm (file contents):
Revision 1.134 by root, Sat Sep 22 14:42:56 2007 UTC vs.
Revision 1.211 by root, Mon Nov 10 00:02:29 2008 UTC

…		…
2		2
3	Coro - coroutine process abstraction	3	Coro - coroutine process abstraction
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use Coro;	7	use Coro;
8		8
9	async {	9	async {
10	# some asynchronous thread of execution	10	# some asynchronous thread of execution
		11	print "2\n";
		12	cede; # yield back to main
		13	print "4\n";
11	};	14	};
12		15	print "1\n";
13	# alternatively create an async coroutine like this:	16	cede; # yield to coroutine
14		17	print "3\n";
15	sub some_func : Coro {	18	cede; # and again
16	# some more async code	19
17	}	20	# use locking
18		21	use Coro::Semaphore;
19	cede;	22	my $lock = new Coro::Semaphore;
		23	my $locked;
		24
		25	$lock->down;
		26	$locked = 1;
		27	$lock->up;
20		28
21	=head1 DESCRIPTION	29	=head1 DESCRIPTION
22		30
23	This module collection manages coroutines. Coroutines are similar	31	This module collection manages coroutines. Coroutines are similar to
24	to threads but don't run in parallel at the same time even on SMP	32	threads but don't (in general) run in parallel at the same time even
25	machines. The specific flavor of coroutine used in this module also	33	on SMP machines. The specific flavor of coroutine used in this module
26	guarantees you that it will not switch between coroutines unless	34	also guarantees you that it will not switch between coroutines unless
27	necessary, at easily-identified points in your program, so locking and	35	necessary, at easily-identified points in your program, so locking and
28	parallel access are rarely an issue, making coroutine programming much	36	parallel access are rarely an issue, making coroutine programming much
29	safer than threads programming.	37	safer and easier than threads programming.
30		38
31	(Perl, however, does not natively support real threads but instead does a	39	Unlike a normal perl program, however, coroutines allow you to have
32	very slow and memory-intensive emulation of processes using threads. This	40	multiple running interpreters that share data, which is especially useful
33	is a performance win on Windows machines, and a loss everywhere else).	41	to code pseudo-parallel processes and for event-based programming, such as
		42	multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to
		43	learn more.
		44
		45	Coroutines are also useful because Perl has no support for threads (the so
		46	called "threads" that perl offers are nothing more than the (bad) process
		47	emulation coming from the Windows platform: On standard operating systems
		48	they serve no purpose whatsoever, except by making your programs slow and
		49	making them use a lot of memory. Best disable them when building perl, or
		50	aks your software vendor/distributor to do it for you).
34		51
35	In this module, coroutines are defined as "callchain + lexical variables +	52	In this module, coroutines are defined as "callchain + lexical variables +
36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,	53	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
37	its own set of lexicals and its own set of perls most important global	54	its own set of lexicals and its own set of perls most important global
38	variables.	55	variables (see L<Coro::State> for more configuration).
39		56
40	=cut	57	=cut
41		58
42	package Coro;	59	package Coro;
43		60
44	use strict;	61	use strict qw(vars subs);
45	no warnings "uninitialized";	62	no warnings "uninitialized";
46		63
47	use Coro::State;	64	use Coro::State;
48		65
49	use base qw(Coro::State Exporter);	66	use base qw(Coro::State Exporter);
50		67
51	our $idle; # idle handler	68	our $idle; # idle handler
52	our $main; # main coroutine	69	our $main; # main coroutine
53	our $current; # current coroutine	70	our $current; # current coroutine
54		71
55	our $VERSION = '3.7';	72	our $VERSION = 4.9;
56		73
57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);	74	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58	our %EXPORT_TAGS = (	75	our %EXPORT_TAGS = (
59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	76	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60	);	77	);
61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));	78	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62		79
63	{
64	my @async;
65	my $init;
66
67	# this way of handling attributes simply is NOT scalable ;()
68	sub import {
69	no strict 'refs';
70
71	Coro->export_to_level (1, @_);
72
73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
75	my ($package, $ref) = (shift, shift);
76	my @attrs;
77	for (@_) {
78	if ($_ eq "Coro") {
79	push @async, $ref;
80	unless ($init++) {
81	eval q{
82	sub INIT {
83	&async(pop @async) while @async;
84	}
85	};
86	}
87	} else {
88	push @attrs, $_;
89	}
90	}
91	return $old ? $old->($package, $ref, @attrs) : @attrs;
92	};
93	}
94
95	}
96
97	=over 4	80	=over 4
98		81
99	=item $main	82	=item $Coro::main
100		83
101	This coroutine represents the main program.	84	This variable stores the coroutine object that represents the main
		85	program. While you cna C<ready> it and do most other things you can do to
		86	coroutines, it is mainly useful to compare again C<$Coro::current>, to see
		87	whether you are running in the main program or not.
102		88
103	=cut	89	=cut
104		90
105	$main = new Coro;	91	$main = new Coro;
106		92
107	=item $current (or as function: current)	93	=item $Coro::current
108		94
109	The current coroutine (the last coroutine switched to). The initial value	95	The coroutine object representing the current coroutine (the last
		96	coroutine that the Coro scheduler switched to). The initial value is
110	is C<$main> (of course).	97	C<$main> (of course).
111		98
112	This variable is B<strictly> I<read-only>. It is provided for performance	99	This variable is B<strictly> I<read-only>. You can take copies of the
113	reasons. If performance is not essential you are encouraged to use the	100	value stored in it and use it as any other coroutine object, but you must
114	C<Coro::current> function instead.	101	not otherwise modify the variable itself.
115		102
116	=cut	103	=cut
117		104
118	$main->{desc} = "[main::]";	105	$main->{desc} = "[main::]";
119		106
120	# maybe some other module used Coro::Specific before...	107	# maybe some other module used Coro::Specific before...
121	$main->{specific} = $current->{specific}	108	$main->{_specific} = $current->{_specific}
122	if $current;	109	if $current;
123		110
124	_set_current $main;	111	_set_current $main;
125		112
126	sub current() { $current }	113	sub current() { $current } # [DEPRECATED]
127		114
128	=item $idle	115	=item $Coro::idle
129		116
130	A callback that is called whenever the scheduler finds no ready coroutines	117	This variable is mainly useful to integrate Coro into event loops. It is
131	to run. The default implementation prints "FATAL: deadlock detected" and	118	usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is
132	exits, because the program has no other way to continue.	119	pretty low-level functionality.
		120
		121	This variable stores a callback that is called whenever the scheduler
		122	finds no ready coroutines to run. The default implementation prints
		123	"FATAL: deadlock detected" and exits, because the program has no other way
		124	to continue.
133		125
134	This hook is overwritten by modules such as C<Coro::Timer> and	126	This hook is overwritten by modules such as C<Coro::Timer> and
135	C<Coro::Event> to wait on an external event that hopefully wake up a	127	C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
136	coroutine so the scheduler can run it.	128	coroutine so the scheduler can run it.
137		129
		130	Note that the callback I<must not>, under any circumstances, block
		131	the current coroutine. Normally, this is achieved by having an "idle
		132	coroutine" that calls the event loop and then blocks again, and then
		133	readying that coroutine in the idle handler.
		134
		135	See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this
		136	technique.
		137
138	Please note that if your callback recursively invokes perl (e.g. for event	138	Please note that if your callback recursively invokes perl (e.g. for event
139	handlers), then it must be prepared to be called recursively.	139	handlers), then it must be prepared to be called recursively itself.
140		140
141	=cut	141	=cut
142		142
143	$idle = sub {	143	$idle = sub {
144	require Carp;	144	require Carp;
…		…
151	# free coroutine data and mark as destructed	151	# free coroutine data and mark as destructed
152	$self->_destroy	152	$self->_destroy
153	or return;	153	or return;
154		154
155	# call all destruction callbacks	155	# call all destruction callbacks
156	$_->(@{$self->{status}})	156	$_->(@{$self->{_status}})
157	for @{(delete $self->{destroy_cb}) \|\| []};	157	for @{ delete $self->{_on_destroy} \|\| [] };
158	}	158	}
159		159
160	# this coroutine is necessary because a coroutine	160	# this coroutine is necessary because a coroutine
161	# cannot destroy itself.	161	# cannot destroy itself.
162	my @destroy;	162	my @destroy;
…		…
168	while @destroy;	168	while @destroy;
169		169
170	&schedule;	170	&schedule;
171	}	171	}
172	};	172	};
173	$manager->desc ("[coro manager]");	173	$manager->{desc} = "[coro manager]";
174	$manager->prio (PRIO_MAX);	174	$manager->prio (PRIO_MAX);
175		175
176	# static methods. not really.
177
178	=back	176	=back
179		177
180	=head2 STATIC METHODS	178	=head2 SIMPLE COROUTINE CREATION
181
182	Static methods are actually functions that operate on the current coroutine only.
183		179
184	=over 4	180	=over 4
185		181
186	=item async { ... } [@args...]	182	=item async { ... } [@args...]
187		183
188	Create a new asynchronous coroutine and return it's coroutine object	184	Create a new coroutine and return it's coroutine object (usually
189	(usually unused). When the sub returns the new coroutine is automatically	185	unused). The coroutine will be put into the ready queue, so
		186	it will start running automatically on the next scheduler run.
		187
		188	The first argument is a codeblock/closure that should be executed in the
		189	coroutine. When it returns argument returns the coroutine is automatically
190	terminated.	190	terminated.
		191
		192	The remaining arguments are passed as arguments to the closure.
		193
		194	See the C<Coro::State::new> constructor for info about the coroutine
		195	environment in which coroutines are executed.
191		196
192	Calling C<exit> in a coroutine will do the same as calling exit outside	197	Calling C<exit> in a coroutine will do the same as calling exit outside
193	the coroutine. Likewise, when the coroutine dies, the program will exit,	198	the coroutine. Likewise, when the coroutine dies, the program will exit,
194	just as it would in the main program.	199	just as it would in the main program.
195		200
		201	If you do not want that, you can provide a default C<die> handler, or
		202	simply avoid dieing (by use of C<eval>).
		203
196	# create a new coroutine that just prints its arguments	204	Example: Create a new coroutine that just prints its arguments.
		205
197	async {	206	async {
198	print "@_\n";	207	print "@_\n";
199	} 1,2,3,4;	208	} 1,2,3,4;
200		209
201	=cut	210	=cut
…		…
207	}	216	}
208		217
209	=item async_pool { ... } [@args...]	218	=item async_pool { ... } [@args...]
210		219
211	Similar to C<async>, but uses a coroutine pool, so you should not call	220	Similar to C<async>, but uses a coroutine pool, so you should not call
212	terminate or join (although you are allowed to), and you get a coroutine	221	terminate or join on it (although you are allowed to), and you get a
213	that might have executed other code already (which can be good or bad :).	222	coroutine that might have executed other code already (which can be good
		223	or bad :).
214		224
		225	On the plus side, this function is faster than creating (and destroying)
		226	a completly new coroutine, so if you need a lot of generic coroutines in
		227	quick successsion, use C<async_pool>, not C<async>.
		228
215	Also, the block is executed in an C<eval> context and a warning will be	229	The code block is executed in an C<eval> context and a warning will be
216	issued in case of an exception instead of terminating the program, as	230	issued in case of an exception instead of terminating the program, as
217	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>	231	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
218	will not work in the expected way, unless you call terminate or cancel,	232	will not work in the expected way, unless you call terminate or cancel,
219	which somehow defeats the purpose of pooling.	233	which somehow defeats the purpose of pooling (but is fine in the
		234	exceptional case).
220		235
221	The priority will be reset to C<0> after each job, otherwise the coroutine	236	The priority will be reset to C<0> after each run, tracing will be
222	will be re-used "as-is".	237	disabled, the description will be reset and the default output filehandle
		238	gets restored, so you can change all these. Otherwise the coroutine will
		239	be re-used "as-is": most notably if you change other per-coroutine global
		240	stuff such as C<$/> you I<must needs> revert that change, which is most
		241	simply done by using local as in: C<< local $/ >>.
223		242
224	The pool size is limited to 8 idle coroutines (this can be adjusted by	243	The idle pool size is limited to C<8> idle coroutines (this can be
225	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as	244	adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
226	required.	245	coros as required.
227		246
228	If you are concerned about pooled coroutines growing a lot because a	247	If you are concerned about pooled coroutines growing a lot because a
229	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool	248	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
230	{ terminate }> once per second or so to slowly replenish the pool. In	249	{ terminate }> once per second or so to slowly replenish the pool. In
231	addition to that, when the stacks used by a handler grows larger than 16kb	250	addition to that, when the stacks used by a handler grows larger than 16kb
232	(adjustable with $Coro::POOL_RSS) it will also exit.	251	(adjustable via $Coro::POOL_RSS) it will also be destroyed.
233		252
234	=cut	253	=cut
235		254
236	our $POOL_SIZE = 8;	255	our $POOL_SIZE = 8;
237	our $POOL_RSS = 16 * 1024;	256	our $POOL_RSS = 16 * 1024;
…		…
241	my $cb;	260	my $cb;
242		261
243	while () {	262	while () {
244	eval {	263	eval {
245	while () {	264	while () {
246	$cb = &_pool_1	265	_pool_1 $cb;
247	or return;
248
249	&$cb;	266	&$cb;
250		267	_pool_2 $cb;
251	return if &_pool_2;
252
253	undef $cb;
254	schedule;	268	&schedule;
255	}	269	}
256	};	270	};
257		271
		272	if ($@) {
		273	last if $@ eq "\3async_pool terminate\2\n";
258	warn $@ if $@;	274	warn $@;
		275	}
259	}	276	}
260	}	277	}
261		278
262	sub async_pool(&@) {	279	sub async_pool(&@) {
263	# this is also inlined into the unlock_scheduler	280	# this is also inlined into the unlock_scheduler
264	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;;	281	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
265		282
266	$coro->{_invoke} = [@_];	283	$coro->{_invoke} = [@_];
267	$coro->ready;	284	$coro->ready;
268		285
269	$coro	286	$coro
270	}	287	}
271		288
		289	=back
		290
		291	=head2 STATIC METHODS
		292
		293	Static methods are actually functions that operate on the current coroutine.
		294
		295	=over 4
		296
272	=item schedule	297	=item schedule
273		298
274	Calls the scheduler. Please note that the current coroutine will not be put	299	Calls the scheduler. The scheduler will find the next coroutine that is
		300	to be run from the ready queue and switches to it. The next coroutine
		301	to be run is simply the one with the highest priority that is longest
		302	in its ready queue. If there is no coroutine ready, it will clal the
		303	C<$Coro::idle> hook.
		304
		305	Please note that the current coroutine will I<not> be put into the ready
275	into the ready queue, so calling this function usually means you will	306	queue, so calling this function usually means you will never be called
276	never be called again unless something else (e.g. an event handler) calls	307	again unless something else (e.g. an event handler) calls C<< ->ready >>,
277	ready.	308	thus waking you up.
		309
		310	This makes C<schedule> I<the> generic method to use to block the current
		311	coroutine and wait for events: first you remember the current coroutine in
		312	a variable, then arrange for some callback of yours to call C<< ->ready
		313	>> on that once some event happens, and last you call C<schedule> to put
		314	yourself to sleep. Note that a lot of things can wake your coroutine up,
		315	so you need to check whether the event indeed happened, e.g. by storing the
		316	status in a variable.
278		317
279	The canonical way to wait on external events is this:	318	The canonical way to wait on external events is this:
280		319
281	{	320	{
282	# remember current coroutine	321	# remember current coroutine
…		…
295	Coro::schedule while $current;	334	Coro::schedule while $current;
296	}	335	}
297		336
298	=item cede	337	=item cede
299		338
300	"Cede" to other coroutines. This function puts the current coroutine into the	339	"Cede" to other coroutines. This function puts the current coroutine into
301	ready queue and calls C<schedule>, which has the effect of giving up the	340	the ready queue and calls C<schedule>, which has the effect of giving
302	current "timeslice" to other coroutines of the same or higher priority.	341	up the current "timeslice" to other coroutines of the same or higher
		342	priority. Once your coroutine gets its turn again it will automatically be
		343	resumed.
303		344
304	Returns true if at least one coroutine switch has happened.	345	This function is often called C<yield> in other languages.
305		346
306	=item Coro::cede_notself	347	=item Coro::cede_notself
307		348
308	Works like cede, but is not exported by default and will cede to any	349	Works like cede, but is not exported by default and will cede to I<any>
309	coroutine, regardless of priority, once.	350	coroutine, regardless of priority. This is useful sometimes to ensure
310		351	progress is made.
311	Returns true if at least one coroutine switch has happened.
312		352
313	=item terminate [arg...]	353	=item terminate [arg...]
314		354
315	Terminates the current coroutine with the given status values (see L<cancel>).	355	Terminates the current coroutine with the given status values (see L<cancel>).
		356
		357	=item killall
		358
		359	Kills/terminates/cancels all coroutines except the currently running
		360	one. This is useful after a fork, either in the child or the parent, as
		361	usually only one of them should inherit the running coroutines.
		362
		363	Note that while this will try to free some of the main programs resources,
		364	you cannot free all of them, so if a coroutine that is not the main
		365	program calls this function, there will be some one-time resource leak.
316		366
317	=cut	367	=cut
318		368
319	sub terminate {	369	sub terminate {
320	$current->cancel (@_);	370	$current->cancel (@_);
321	}	371	}
322		372
		373	sub killall {
		374	for (Coro::State::list) {
		375	$_->cancel
		376	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		377	}
		378	}
		379
323	=back	380	=back
324		381
325	# dynamic methods
326
327	=head2 COROUTINE METHODS	382	=head2 COROUTINE METHODS
328		383
329	These are the methods you can call on coroutine objects.	384	These are the methods you can call on coroutine objects (or to create
		385	them).
330		386
331	=over 4	387	=over 4
332		388
333	=item new Coro \&sub [, @args...]	389	=item new Coro \&sub [, @args...]
334		390
335	Create a new coroutine and return it. When the sub returns the coroutine	391	Create a new coroutine and return it. When the sub returns, the coroutine
336	automatically terminates as if C<terminate> with the returned values were	392	automatically terminates as if C<terminate> with the returned values were
337	called. To make the coroutine run you must first put it into the ready queue	393	called. To make the coroutine run you must first put it into the ready
338	by calling the ready method.	394	queue by calling the ready method.
339		395
340	See C<async> for additional discussion.	396	See C<async> and C<Coro::State::new> for additional info about the
		397	coroutine environment.
341		398
342	=cut	399	=cut
343		400
344	sub _run_coro {	401	sub _run_coro {
345	terminate &{+shift};	402	terminate &{+shift};
…		…
351	$class->SUPER::new (\&_run_coro, @_)	408	$class->SUPER::new (\&_run_coro, @_)
352	}	409	}
353		410
354	=item $success = $coroutine->ready	411	=item $success = $coroutine->ready
355		412
356	Put the given coroutine into the ready queue (according to it's priority)	413	Put the given coroutine into the end of its ready queue (there is one
357	and return true. If the coroutine is already in the ready queue, do nothing	414	queue for each priority) and return true. If the coroutine is already in
358	and return false.	415	the ready queue, do nothing and return false.
		416
		417	This ensures that the scheduler will resume this coroutine automatically
		418	once all the coroutines of higher priority and all coroutines of the same
		419	priority that were put into the ready queue earlier have been resumed.
359		420
360	=item $is_ready = $coroutine->is_ready	421	=item $is_ready = $coroutine->is_ready
361		422
362	Return wether the coroutine is currently the ready queue or not,	423	Return whether the coroutine is currently the ready queue or not,
363		424
364	=item $coroutine->cancel (arg...)	425	=item $coroutine->cancel (arg...)
365		426
366	Terminates the given coroutine and makes it return the given arguments as	427	Terminates the given coroutine and makes it return the given arguments as
367	status (default: the empty list). Never returns if the coroutine is the	428	status (default: the empty list). Never returns if the coroutine is the
…		…
369		430
370	=cut	431	=cut
371		432
372	sub cancel {	433	sub cancel {
373	my $self = shift;	434	my $self = shift;
374	$self->{status} = [@_];	435	$self->{_status} = [@_];
375		436
376	if ($current == $self) {	437	if ($current == $self) {
377	push @destroy, $self;	438	push @destroy, $self;
378	$manager->ready;	439	$manager->ready;
379	&schedule while 1;	440	&schedule while 1;
380	} else {	441	} else {
381	$self->_cancel;	442	$self->_cancel;
382	}	443	}
383	}	444	}
384		445
		446	=item $coroutine->throw ([$scalar])
		447
		448	If C<$throw> is specified and defined, it will be thrown as an exception
		449	inside the coroutine at the next convenient point in time (usually after
		450	it gains control at the next schedule/transfer/cede). Otherwise clears the
		451	exception object.
		452
		453	The exception object will be thrown "as is" with the specified scalar in
		454	C<$@>, i.e. if it is a string, no line number or newline will be appended
		455	(unlike with C<die>).
		456
		457	This can be used as a softer means than C<cancel> to ask a coroutine to
		458	end itself, although there is no guarantee that the exception will lead to
		459	termination, and if the exception isn't caught it might well end the whole
		460	program.
		461
		462	You might also think of C<throw> as being the moral equivalent of
		463	C<kill>ing a coroutine with a signal (in this case, a scalar).
		464
385	=item $coroutine->join	465	=item $coroutine->join
386		466
387	Wait until the coroutine terminates and return any values given to the	467	Wait until the coroutine terminates and return any values given to the
388	C<terminate> or C<cancel> functions. C<join> can be called multiple times	468	C<terminate> or C<cancel> functions. C<join> can be called concurrently
389	from multiple coroutine.	469	from multiple coroutines, and all will be resumed and given the status
		470	return once the C<$coroutine> terminates.
390		471
391	=cut	472	=cut
392		473
393	sub join {	474	sub join {
394	my $self = shift;	475	my $self = shift;
395		476
396	unless ($self->{status}) {	477	unless ($self->{_status}) {
397	my $current = $current;	478	my $current = $current;
398		479
399	push @{$self->{destroy_cb}}, sub {	480	push @{$self->{_on_destroy}}, sub {
400	$current->ready;	481	$current->ready;
401	undef $current;	482	undef $current;
402	};	483	};
403		484
404	&schedule while $current;	485	&schedule while $current;
405	}	486	}
406		487
407	wantarray ? @{$self->{status}} : $self->{status}[0];	488	wantarray ? @{$self->{_status}} : $self->{_status}[0];
408	}	489	}
409		490
410	=item $coroutine->on_destroy (\&cb)	491	=item $coroutine->on_destroy (\&cb)
411		492
412	Registers a callback that is called when this coroutine gets destroyed,	493	Registers a callback that is called when this coroutine gets destroyed,
413	but before it is joined. The callback gets passed the terminate arguments,	494	but before it is joined. The callback gets passed the terminate arguments,
414	if any.	495	if any, and I<must not> die, under any circumstances.
415		496
416	=cut	497	=cut
417		498
418	sub on_destroy {	499	sub on_destroy {
419	my ($self, $cb) = @_;	500	my ($self, $cb) = @_;
420		501
421	push @{ $self->{destroy_cb} }, $cb;	502	push @{ $self->{_on_destroy} }, $cb;
422	}	503	}
423		504
424	=item $oldprio = $coroutine->prio ($newprio)	505	=item $oldprio = $coroutine->prio ($newprio)
425		506
426	Sets (or gets, if the argument is missing) the priority of the	507	Sets (or gets, if the argument is missing) the priority of the
…		…
449	higher values mean lower priority, just as in unix).	530	higher values mean lower priority, just as in unix).
450		531
451	=item $olddesc = $coroutine->desc ($newdesc)	532	=item $olddesc = $coroutine->desc ($newdesc)
452		533
453	Sets (or gets in case the argument is missing) the description for this	534	Sets (or gets in case the argument is missing) the description for this
454	coroutine. This is just a free-form string you can associate with a coroutine.	535	coroutine. This is just a free-form string you can associate with a
		536	coroutine.
		537
		538	This method simply sets the C<< $coroutine->{desc} >> member to the given
		539	string. You can modify this member directly if you wish.
455		540
456	=cut	541	=cut
457		542
458	sub desc {	543	sub desc {
459	my $old = $_[0]{desc};	544	my $old = $_[0]{desc};
…		…
468	=over 4	553	=over 4
469		554
470	=item Coro::nready	555	=item Coro::nready
471		556
472	Returns the number of coroutines that are currently in the ready state,	557	Returns the number of coroutines that are currently in the ready state,
473	i.e. that can be switched to. The value C<0> means that the only runnable	558	i.e. that can be switched to by calling C<schedule> directory or
		559	indirectly. The value C<0> means that the only runnable coroutine is the
474	coroutine is the currently running one, so C<cede> would have no effect,	560	currently running one, so C<cede> would have no effect, and C<schedule>
475	and C<schedule> would cause a deadlock unless there is an idle handler	561	would cause a deadlock unless there is an idle handler that wakes up some
476	that wakes up some coroutines.	562	coroutines.
477		563
478	=item my $guard = Coro::guard { ... }	564	=item my $guard = Coro::guard { ... }
479		565
480	This creates and returns a guard object. Nothing happens until the object	566	This creates and returns a guard object. Nothing happens until the object
481	gets destroyed, in which case the codeblock given as argument will be	567	gets destroyed, in which case the codeblock given as argument will be
…		…
510		596
511		597
512	=item unblock_sub { ... }	598	=item unblock_sub { ... }
513		599
514	This utility function takes a BLOCK or code reference and "unblocks" it,	600	This utility function takes a BLOCK or code reference and "unblocks" it,
515	returning the new coderef. This means that the new coderef will return	601	returning a new coderef. Unblocking means that calling the new coderef
516	immediately without blocking, returning nothing, while the original code	602	will return immediately without blocking, returning nothing, while the
517	ref will be called (with parameters) from within its own coroutine.	603	original code ref will be called (with parameters) from within another
		604	coroutine.
518		605
519	The reason this function exists is that many event libraries (such as the	606	The reason this function exists is that many event libraries (such as the
520	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form	607	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
521	of thread-safety). This means you must not block within event callbacks,	608	of thread-safety). This means you must not block within event callbacks,
522	otherwise you might suffer from crashes or worse.	609	otherwise you might suffer from crashes or worse. The only event library
		610	currently known that is safe to use without C<unblock_sub> is L<EV>.
523		611
524	This function allows your callbacks to block by executing them in another	612	This function allows your callbacks to block by executing them in another
525	coroutine where it is safe to block. One example where blocking is handy	613	coroutine where it is safe to block. One example where blocking is handy
526	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to	614	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
527	disk.	615	disk, for example.
528		616
529	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when	617	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
530	creating event callbacks that want to block.	618	creating event callbacks that want to block.
		619
		620	If your handler does not plan to block (e.g. simply sends a message to
		621	another coroutine, or puts some other coroutine into the ready queue),
		622	there is no reason to use C<unblock_sub>.
		623
		624	Note that you also need to use C<unblock_sub> for any other callbacks that
		625	are indirectly executed by any C-based event loop. For example, when you
		626	use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
		627	provides callbacks that are the result of some event callback, then you
		628	must not block either, or use C<unblock_sub>.
531		629
532	=cut	630	=cut
533		631
534	our @unblock_queue;	632	our @unblock_queue;
535		633
…		…
548	cede; # for short-lived callbacks, this reduces pressure on the coro pool	646	cede; # for short-lived callbacks, this reduces pressure on the coro pool
549	}	647	}
550	schedule; # sleep well	648	schedule; # sleep well
551	}	649	}
552	};	650	};
553	$unblock_scheduler->desc ("[unblock_sub scheduler]");	651	$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
554		652
555	sub unblock_sub(&) {	653	sub unblock_sub(&) {
556	my $cb = shift;	654	my $cb = shift;
557		655
558	sub {	656	sub {
…		…
567		665
568	1;	666	1;
569		667
570	=head1 BUGS/LIMITATIONS	668	=head1 BUGS/LIMITATIONS
571		669
572	- you must make very sure that no coro is still active on global
573	destruction. very bad things might happen otherwise (usually segfaults).
574
575	- this module is not thread-safe. You should only ever use this module	670	This module is not perl-pseudo-thread-safe. You should only ever use this
576	from the same thread (this requirement might be loosened in the future	671	module from the same thread (this requirement might be removed in the
577	to allow per-thread schedulers, but Coro::State does not yet allow	672	future to allow per-thread schedulers, but Coro::State does not yet allow
578	this).	673	this). I recommend disabling thread support and using processes, as this
		674	is much faster and uses less memory.
579		675
580	=head1 SEE ALSO	676	=head1 SEE ALSO
581		677
		678	Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
		679
		680	Debugging: L<Coro::Debug>.
		681
582	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	682	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
583		683
584	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.	684	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
585		685
586	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.	686	IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
587		687
588	Embedding: L<Coro:MakeMaker>	688	Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>.
		689
		690	XS API: L<Coro::MakeMaker>.
		691
		692	Low level Configuration, Coroutine Environment: L<Coro::State>.
589		693
590	=head1 AUTHOR	694	=head1 AUTHOR
591		695
592	Marc Lehmann <schmorp@schmorp.de>	696	Marc Lehmann <schmorp@schmorp.de>
593	http://home.schmorp.de/	697	http://home.schmorp.de/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.134 by root, Sat Sep 22 14:42:56 2007 UTC vs. Revision 1.211 by root, Mon Nov 10 00:02:29 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.134 by root, Sat Sep 22 14:42:56 2007 UTC vs.
Revision 1.211 by root, Mon Nov 10 00:02:29 2008 UTC