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

Comparing Coro/Coro.pm (file contents):
Revision 1.78 by root, Wed Nov 1 01:21:21 2006 UTC vs.
Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC

…		…
35	use strict;	35	use strict;
36	no warnings "uninitialized";	36	no warnings "uninitialized";
37		37
38	use Coro::State;	38	use Coro::State;
39		39
40	use base Exporter::;	40	use base qw(Coro::State Exporter);
41		41
42	our $idle; # idle coroutine	42	our $idle; # idle handler
43	our $main; # main coroutine	43	our $main; # main coroutine
44	our $current; # current coroutine	44	our $current; # current coroutine
45		45
46	our $VERSION = '2.1';	46	our $VERSION = '3.0';
47		47
48	our @EXPORT = qw(async cede schedule terminate current);	48	our @EXPORT = qw(async cede schedule terminate current);
49	our %EXPORT_TAGS = (	49	our %EXPORT_TAGS = (
50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
51	);	51	);
…		…
95		95
96	$main = new Coro;	96	$main = new Coro;
97		97
98	=item $current (or as function: current)	98	=item $current (or as function: current)
99		99
100	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	100	The current coroutine (the last coroutine switched to). The initial value
		101	is C<$main> (of course).
		102
		103	This variable is B<strictly> I<read-only>. It is provided for performance
		104	reasons. If performance is not essentiel you are encouraged to use the
		105	C<Coro::current> function instead.
101		106
102	=cut	107	=cut
103		108
104	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
105	if ($current) {	110	if ($current) {
…		…
110		115
111	sub current() { $current }	116	sub current() { $current }
112		117
113	=item $idle	118	=item $idle
114		119
115	The coroutine to switch to when no other coroutine is running. The default	120	A callback that is called whenever the scheduler finds no ready coroutines
116	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
117		123
118	=cut	124	This hook is overwritten by modules such as C<Coro::Timer> and
		125	C<Coro::Event> to wait on an external event that hopefully wakes up some
		126	coroutine.
119		127
120	# should be done using priorities :(	128	=cut
121	$idle = new Coro sub {	129
		130	$idle = sub {
122	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
123	exit(51);	132	exit (51);
124	};	133	};
125		134
126	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
127	# cannot destroy itself.	136	# cannot destroy itself.
128	my @destroy;	137	my @destroy;
129	my $manager;
130	$manager = new Coro sub {	138	my $manager; $manager = new Coro sub {
131	while () {	139	while () {
132	# by overwriting the state object with the manager we destroy it	140	# by overwriting the state object with the manager we destroy it
133	# while still being able to schedule this coroutine (in case it has	141	# while still being able to schedule this coroutine (in case it has
134	# been readied multiple times. this is harmless since the manager	142	# been readied multiple times. this is harmless since the manager
135	# can be called as many times as neccessary and will always	143	# can be called as many times as neccessary and will always
…		…
137	while (@destroy) {	145	while (@destroy) {
138	my $coro = pop @destroy;	146	my $coro = pop @destroy;
139	$coro->{status} \|\|= [];	147	$coro->{status} \|\|= [];
140	$_->ready for @{delete $coro->{join} \|\| []};	148	$_->ready for @{delete $coro->{join} \|\| []};
141		149
142	# the next line destroys the _coro_state, but keeps the	150	# the next line destroys the coro state, but keeps the
143	# process itself intact (we basically make it a zombie	151	# process itself intact (we basically make it a zombie
144	# process that always runs the manager thread, so it's possible	152	# process that always runs the manager thread, so it's possible
145	# to transfer() to this process).	153	# to transfer() to this process).
146	$coro->{_coro_state} = $manager->{_coro_state};	154	$coro->_clone_state_from ($manager);
147	}	155	}
148	&schedule;	156	&schedule;
149	}	157	}
150	};	158	};
151		159
…		…
163		171
164	Create a new asynchronous process and return it's process object	172	Create a new asynchronous process and return it's process object
165	(usually unused). When the sub returns the new process is automatically	173	(usually unused). When the sub returns the new process is automatically
166	terminated.	174	terminated.
167		175
		176	Calling C<exit> in a coroutine will not work correctly, so do not do that.
		177
		178	When the coroutine dies, the program will exit, just as in the main
		179	program.
		180
168	# create a new coroutine that just prints its arguments	181	# create a new coroutine that just prints its arguments
169	async {	182	async {
170	print "@_\n";	183	print "@_\n";
171	} 1,2,3,4;	184	} 1,2,3,4;
172		185
173	=cut	186	=cut
174		187
175	sub async(&@) {	188	sub async(&@) {
176	my $pid = new Coro @_;	189	my $pid = new Coro @_;
177	$manager->ready; # this ensures that the stack is cloned from the manager
178	$pid->ready;	190	$pid->ready;
179	$pid;	191	$pid
180	}	192	}
181		193
182	=item schedule	194	=item schedule
183		195
184	Calls the scheduler. Please note that the current process will not be put	196	Calls the scheduler. Please note that the current process will not be put
…		…
220	Create a new process and return it. When the sub returns the process	232	Create a new process and return it. When the sub returns the process
221	automatically terminates as if C<terminate> with the returned values were	233	automatically terminates as if C<terminate> with the returned values were
222	called. To make the process run you must first put it into the ready queue	234	called. To make the process run you must first put it into the ready queue
223	by calling the ready method.	235	by calling the ready method.
224		236
225	=cut	237	Calling C<exit> in a coroutine will not work correctly, so do not do that.
226		238
		239	=cut
		240
227	sub _newcoro {	241	sub _new_coro {
228	terminate &{+shift};	242	terminate &{+shift};
229	}	243	}
230		244
231	sub new {	245	sub new {
232	my $class = shift;	246	my $class = shift;
233	bless {	247
234	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	248	$class->SUPER::new (\&_new_coro, @_)
235	}, $class;
236	}	249	}
237		250
238	=item $process->ready	251	=item $process->ready
239		252
240	Put the given process into the ready queue.	253	Put the given process into the ready queue.
241		254
242	=cut	255	=cut
243		256
244	=item $process->cancel (arg...)	257	=item $process->cancel (arg...)
245		258
246	Temrinates the given process and makes it return the given arguments as	259	Terminates the given process and makes it return the given arguments as
247	status (default: the empty list).	260	status (default: the empty list).
248		261
249	=cut	262	=cut
250		263
251	sub cancel {	264	sub cancel {
…		…
271	&schedule;	284	&schedule;
272	}	285	}
273	wantarray ? @{$self->{status}} : $self->{status}[0];	286	wantarray ? @{$self->{status}} : $self->{status}[0];
274	}	287	}
275		288
276	=item $oldprio = $process->prio($newprio)	289	=item $oldprio = $process->prio ($newprio)
277		290
278	Sets (or gets, if the argument is missing) the priority of the	291	Sets (or gets, if the argument is missing) the priority of the
279	process. Higher priority processes get run before lower priority	292	process. Higher priority processes get run before lower priority
280	processes. Priorities are small signed integers (currently -4 .. +3),	293	processes. Priorities are small signed integers (currently -4 .. +3),
281	that you can refer to using PRIO_xxx constants (use the import tag :prio	294	that you can refer to using PRIO_xxx constants (use the import tag :prio
…		…
293	Changing the priority of the current process will take effect immediately,	306	Changing the priority of the current process will take effect immediately,
294	but changing the priority of processes in the ready queue (but not	307	but changing the priority of processes in the ready queue (but not
295	running) will only take effect after the next schedule (of that	308	running) will only take effect after the next schedule (of that
296	process). This is a bug that will be fixed in some future version.	309	process). This is a bug that will be fixed in some future version.
297		310
298	=cut
299
300	sub prio {
301	my $old = $_[0]{prio};
302	$_[0]{prio} = $_[1] if @_ > 1;
303	$old;
304	}
305
306	=item $newprio = $process->nice($change)	311	=item $newprio = $process->nice ($change)
307		312
308	Similar to C<prio>, but subtract the given value from the priority (i.e.	313	Similar to C<prio>, but subtract the given value from the priority (i.e.
309	higher values mean lower priority, just as in unix).	314	higher values mean lower priority, just as in unix).
310		315
311	=cut
312
313	sub nice {
314	$_[0]{prio} -= $_[1];
315	}
316
317	=item $olddesc = $process->desc($newdesc)	316	=item $olddesc = $process->desc ($newdesc)
318		317
319	Sets (or gets in case the argument is missing) the description for this	318	Sets (or gets in case the argument is missing) the description for this
320	process. This is just a free-form string you can associate with a process.	319	process. This is just a free-form string you can associate with a process.
321		320
322	=cut	321	=cut

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.78 by root, Wed Nov 1 01:21:21 2006 UTC vs. Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.78 by root, Wed Nov 1 01:21:21 2006 UTC vs.
Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC