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

Comparing Coro/Coro.pm (file contents):
Revision 1.286 by root, Sat Feb 19 04:34:59 2011 UTC vs.
Revision 1.346 by root, Fri Jul 14 23:20:07 2017 UTC

…		…
16	cede; # yield to coro	16	cede; # yield to coro
17	print "3\n";	17	print "3\n";
18	cede; # and again	18	cede; # and again
19		19
20	# use locking	20	# use locking
21	use Coro::Semaphore;
22	my $lock = new Coro::Semaphore;	21	my $lock = new Coro::Semaphore;
23	my $locked;	22	my $locked;
24		23
25	$lock->down;	24	$lock->down;
26	$locked = 1;	25	$locked = 1;
…		…
90	} 1, 2, 3;	89	} 1, 2, 3;
91		90
92	This creates a new coro thread and puts it into the ready queue, meaning	91	This creates a new coro thread and puts it into the ready queue, meaning
93	it will run as soon as the CPU is free for it.	92	it will run as soon as the CPU is free for it.
94		93
95	C<async> will return a coro object - you can store this for future	94	C<async> will return a Coro object - you can store this for future
96	reference or ignore it, the thread itself will keep a reference to it's	95	reference or ignore it - a thread that is running, ready to run or waiting
97	thread object - threads are alive on their own.	96	for some event is alive on it's own.
98		97
99	Another way to create a thread is to call the C<new> constructor with a	98	Another way to create a thread is to call the C<new> constructor with a
100	code-reference:	99	code-reference:
101		100
102	new Coro sub {	101	new Coro sub {
…		…
131	A lot can happen after the coro thread has started running. Quite usually,	130	A lot can happen after the coro thread has started running. Quite usually,
132	it will not run to the end in one go (because you could use a function	131	it will not run to the end in one go (because you could use a function
133	instead), but it will give up the CPU regularly because it waits for	132	instead), but it will give up the CPU regularly because it waits for
134	external events.	133	external events.
135		134
136	As long as a coro thread runs, it's coro object is available in the global	135	As long as a coro thread runs, its Coro object is available in the global
137	variable C<$Coro::current>.	136	variable C<$Coro::current>.
138		137
139	The low-level way to give up the CPU is to call the scheduler, which	138	The low-level way to give up the CPU is to call the scheduler, which
140	selects a new coro thread to run:	139	selects a new coro thread to run:
141		140
…		…
196		195
197	async {	196	async {
198	Coro::terminate "return value 1", "return value 2";	197	Coro::terminate "return value 1", "return value 2";
199	};	198	};
200		199
201	And yet another way is to C<< ->cancel >> the coro thread from another	200	Yet another way is to C<< ->cancel >> (or C<< ->safe_cancel >>) the coro
202	thread:	201	thread from another thread:
203		202
204	my $coro = async {	203	my $coro = async {
205	exit 1;	204	exit 1;
206	};	205	};
207		206
208	$coro->cancel; # an also accept values for ->join to retrieve	207	$coro->cancel; # also accepts values for ->join to retrieve
209		208
210	Cancellation I<can> be dangerous - it's a bit like calling C<exit> without	209	Cancellation I<can> be dangerous - it's a bit like calling C<exit> without
211	actually exiting, and might leave C libraries and XS modules in a weird	210	actually exiting, and might leave C libraries and XS modules in a weird
212	state. Unlike other thread implementations, however, Coro is exceptionally	211	state. Unlike other thread implementations, however, Coro is exceptionally
213	safe with regards to cancellation, as perl will always be in a consistent	212	safe with regards to cancellation, as perl will always be in a consistent
214	state.	213	state, and for those cases where you want to do truly marvellous things
		214	with your coro while it is being cancelled - that is, make sure all
		215	cleanup code is executed from the thread being cancelled - there is even a
		216	C<< ->safe_cancel >> method.
215		217
216	So, cancelling a thread that runs in an XS event loop might not be the	218	So, cancelling a thread that runs in an XS event loop might not be the
217	best idea, but any other combination that deals with perl only (cancelling	219	best idea, but any other combination that deals with perl only (cancelling
218	when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is	220	when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is
219	safe.	221	safe.
220		222
		223	Last not least, a coro thread object that isn't referenced is C<<
		224	->cancel >>'ed automatically - just like other objects in Perl. This
		225	is not such a common case, however - a running thread is referencedy by
		226	C<$Coro::current>, a thread ready to run is referenced by the ready queue,
		227	a thread waiting on a lock or semaphore is referenced by being in some
		228	wait list and so on. But a thread that isn't in any of those queues gets
		229	cancelled:
		230
		231	async {
		232	schedule; # cede to other coros, don't go into the ready queue
		233	};
		234
		235	cede;
		236	# now the async above is destroyed, as it is not referenced by anything.
		237
		238	A slightly embellished example might make it clearer:
		239
		240	async {
		241	my $guard = Guard::guard { print "destroyed\n" };
		242	schedule while 1;
		243	};
		244
		245	cede;
		246
		247	Superficially one might not expect any output - since the C<async>
		248	implements an endless loop, the C<$guard> will not be cleaned up. However,
		249	since the thread object returned by C<async> is not stored anywhere, the
		250	thread is initially referenced because it is in the ready queue, when it
		251	runs it is referenced by C<$Coro::current>, but when it calls C<schedule>,
		252	it gets C<cancel>ed causing the guard object to be destroyed (see the next
		253	section), and printing it's message.
		254
		255	If this seems a bit drastic, remember that this only happens when nothing
		256	references the thread anymore, which means there is no way to further
		257	execute it, ever. The only options at this point are leaking the thread,
		258	or cleaning it up, which brings us to...
		259
221	=item 5. Cleanup	260	=item 5. Cleanup
222		261
223	Threads will allocate various resources. Most but not all will be returned	262	Threads will allocate various resources. Most but not all will be returned
224	when a thread terminates, during clean-up.	263	when a thread terminates, during clean-up.
225		264
…		…
243		282
244	my $sem = new Coro::Semaphore;	283	my $sem = new Coro::Semaphore;
245		284
246	async {	285	async {
247	my $lock_guard = $sem->guard;	286	my $lock_guard = $sem->guard;
248	# if we reutrn, or die or get cancelled, here,	287	# if we return, or die or get cancelled, here,
249	# then the semaphore will be "up"ed.	288	# then the semaphore will be "up"ed.
250	};	289	};
251		290
252	The C<Guard::guard> function comes in handy for any custom cleanup you	291	The C<Guard::guard> function comes in handy for any custom cleanup you
253	might want to do:	292	might want to do (but you cannot switch to other coroutines from those
		293	code blocks):
254		294
255	async {	295	async {
256	my $window = new Gtk2::Window "toplevel";	296	my $window = new Gtk2::Window "toplevel";
257	# The window will not be cleaned up automatically, even when $window	297	# The window will not be cleaned up automatically, even when $window
258	# gets freed, so use a guard to ensure it's destruction	298	# gets freed, so use a guard to ensure it's destruction
…		…
271	# if we return or die here, the description will be restored	311	# if we return or die here, the description will be restored
272	}	312	}
273		313
274	=item 6. Viva La Zombie Muerte	314	=item 6. Viva La Zombie Muerte
275		315
276	Even after a thread has terminated and cleaned up it's resources, the coro	316	Even after a thread has terminated and cleaned up its resources, the Coro
277	object still is there and stores the return values of the thread. Only in	317	object still is there and stores the return values of the thread.
278	this state will the coro object be "reference counted" in the normal perl
279	sense: the thread code keeps a reference to it when it is active, but not
280	after it has terminated.
281		318
282	The means the coro object gets freed automatically when the thread has	319	When there are no other references, it will simply be cleaned up and
283	terminated and cleaned up and there arenot other references.	320	freed.
284		321
285	If there are, the coro object will stay around, and you can call C<<	322	If there areany references, the Coro object will stay around, and you
286	->join >> as many times as you wish to retrieve the result values:	323	can call C<< ->join >> as many times as you wish to retrieve the result
		324	values:
287		325
288	async {	326	async {
289	print "hi\n";	327	print "hi\n";
290	1	328	1
291	};	329	};
…		…
328		366
329	our $idle; # idle handler	367	our $idle; # idle handler
330	our $main; # main coro	368	our $main; # main coro
331	our $current; # current coro	369	our $current; # current coro
332		370
333	our $VERSION = 5.26;	371	our $VERSION = 6.513;
334		372
335	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);	373	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);
336	our %EXPORT_TAGS = (	374	our %EXPORT_TAGS = (
337	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	375	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
338	);	376	);
…		…
343	=over 4	381	=over 4
344		382
345	=item $Coro::main	383	=item $Coro::main
346		384
347	This variable stores the Coro object that represents the main	385	This variable stores the Coro object that represents the main
348	program. While you cna C<ready> it and do most other things you can do to	386	program. While you can C<ready> it and do most other things you can do to
349	coro, it is mainly useful to compare again C<$Coro::current>, to see	387	coro, it is mainly useful to compare again C<$Coro::current>, to see
350	whether you are running in the main program or not.	388	whether you are running in the main program or not.
351		389
352	=cut	390	=cut
353		391
…		…
399	our @destroy;	437	our @destroy;
400	our $manager;	438	our $manager;
401		439
402	$manager = new Coro sub {	440	$manager = new Coro sub {
403	while () {	441	while () {
404	Coro::State::cancel shift @destroy	442	_destroy shift @destroy
405	while @destroy;	443	while @destroy;
406		444
407	&schedule;	445	&schedule;
408	}	446	}
409	};	447	};
…		…
460	C<async> does. As the coro is being reused, stuff like C<on_destroy>	498	C<async> does. As the coro is being reused, stuff like C<on_destroy>
461	will not work in the expected way, unless you call terminate or cancel,	499	will not work in the expected way, unless you call terminate or cancel,
462	which somehow defeats the purpose of pooling (but is fine in the	500	which somehow defeats the purpose of pooling (but is fine in the
463	exceptional case).	501	exceptional case).
464		502
465	The priority will be reset to C<0> after each run, tracing will be	503	The priority will be reset to C<0> after each run, all C<swap_sv> calls
466	disabled, the description will be reset and the default output filehandle	504	will be undone, tracing will be disabled, the description will be reset
467	gets restored, so you can change all these. Otherwise the coro will	505	and the default output filehandle gets restored, so you can change all
468	be re-used "as-is": most notably if you change other per-coro global	506	these. Otherwise the coro will be re-used "as-is": most notably if you
469	stuff such as C<$/> you I<must needs> revert that change, which is most	507	change other per-coro global stuff such as C<$/> you I<must needs> revert
470	simply done by using local as in: C<< local $/ >>.	508	that change, which is most simply done by using local as in: C<< local $/
		509	>>.
471		510
472	The idle pool size is limited to C<8> idle coros (this can be	511	The idle pool size is limited to C<8> idle coros (this can be
473	adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle	512	adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
474	coros as required.	513	coros as required.
475		514
…		…
543	coro, regardless of priority. This is useful sometimes to ensure	582	coro, regardless of priority. This is useful sometimes to ensure
544	progress is made.	583	progress is made.
545		584
546	=item terminate [arg...]	585	=item terminate [arg...]
547		586
548	Terminates the current coro with the given status values (see L<cancel>).	587	Terminates the current coro with the given status values (see
		588	L<cancel>). The values will not be copied, but referenced directly.
549		589
550	=item Coro::on_enter BLOCK, Coro::on_leave BLOCK	590	=item Coro::on_enter BLOCK, Coro::on_leave BLOCK
551		591
552	These function install enter and leave winders in the current scope. The	592	These function install enter and leave winders in the current scope. The
553	enter block will be executed when on_enter is called and whenever the	593	enter block will be executed when on_enter is called and whenever the
…		…
598	# at this place, the timezone is Antarctica/South_Pole,	638	# at this place, the timezone is Antarctica/South_Pole,
599	# without disturbing the TZ of any other coro.	639	# without disturbing the TZ of any other coro.
600	};	640	};
601		641
602	This can be used to localise about any resource (locale, uid, current	642	This can be used to localise about any resource (locale, uid, current
603	working directory etc.) to a block, despite the existance of other	643	working directory etc.) to a block, despite the existence of other
604	coros.	644	coros.
605		645
606	Another interesting example implements time-sliced multitasking using	646	Another interesting example implements time-sliced multitasking using
607	interval timers (this could obviously be optimised, but does the job):	647	interval timers (this could obviously be optimised, but does the job):
608		648
…		…
613	Coro::on_enter {	653	Coro::on_enter {
614	# on entering the thread, we set an VTALRM handler to cede	654	# on entering the thread, we set an VTALRM handler to cede
615	$SIG{VTALRM} = sub { cede };	655	$SIG{VTALRM} = sub { cede };
616	# and then start the interval timer	656	# and then start the interval timer
617	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01;	657	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01;
618	};	658	};
619	Coro::on_leave {	659	Coro::on_leave {
620	# on leaving the thread, we stop the interval timer again	660	# on leaving the thread, we stop the interval timer again
621	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0;	661	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0;
622	};	662	};
623		663
624	&{+shift};	664	&{+shift};
625	}	665	}
626		666
627	# use like this:	667	# use like this:
628	timeslice {	668	timeslice {
629	# The following is an endless loop that would normally	669	# The following is an endless loop that would normally
630	# monopolise the process. Since it runs in a timesliced	670	# monopolise the process. Since it runs in a timesliced
631	# environment, it will regularly cede to other threads.	671	# environment, it will regularly cede to other threads.
632	while () { }	672	while () { }
633	};	673	};
634		674
635		675
636	=item killall	676	=item killall
637		677
638	Kills/terminates/cancels all coros except the currently running one.	678	Kills/terminates/cancels all coros except the currently running one.
…		…
709	To avoid this, it is best to put a suspended coro into the ready queue	749	To avoid this, it is best to put a suspended coro into the ready queue
710	unconditionally, as every synchronisation mechanism must protect itself	750	unconditionally, as every synchronisation mechanism must protect itself
711	against spurious wakeups, and the one in the Coro family certainly do	751	against spurious wakeups, and the one in the Coro family certainly do
712	that.	752	that.
713		753
		754	=item $state->is_new
		755
		756	Returns true iff this Coro object is "new", i.e. has never been run
		757	yet. Those states basically consist of only the code reference to call and
		758	the arguments, but consumes very little other resources. New states will
		759	automatically get assigned a perl interpreter when they are transferred to.
		760
		761	=item $state->is_zombie
		762
		763	Returns true iff the Coro object has been cancelled, i.e.
		764	it's resources freed because they were C<cancel>'ed, C<terminate>'d,
		765	C<safe_cancel>'ed or simply went out of scope.
		766
		767	The name "zombie" stems from UNIX culture, where a process that has
		768	exited and only stores and exit status and no other resources is called a
		769	"zombie".
		770
714	=item $is_ready = $coro->is_ready	771	=item $is_ready = $coro->is_ready
715		772
716	Returns true iff the Coro object is in the ready queue. Unless the Coro	773	Returns true iff the Coro object is in the ready queue. Unless the Coro
717	object gets destroyed, it will eventually be scheduled by the scheduler.	774	object gets destroyed, it will eventually be scheduled by the scheduler.
718		775
…		…
727	Returns true iff this Coro object has been suspended. Suspended Coros will	784	Returns true iff this Coro object has been suspended. Suspended Coros will
728	not ever be scheduled.	785	not ever be scheduled.
729		786
730	=item $coro->cancel (arg...)	787	=item $coro->cancel (arg...)
731		788
732	Terminates the given Coro and makes it return the given arguments as	789	Terminates the given Coro thread and makes it return the given arguments as
733	status (default: the empty list). Never returns if the Coro is the	790	status (default: an empty list). Never returns if the Coro is the
734	current Coro.	791	current Coro.
735		792
736	=cut	793	This is a rather brutal way to free a coro, with some limitations - if
		794	the thread is inside a C callback that doesn't expect to be canceled,
		795	bad things can happen, or if the cancelled thread insists on running
		796	complicated cleanup handlers that rely on its thread context, things will
		797	not work.
737		798
738	sub cancel {	799	Any cleanup code being run (e.g. from C<guard> blocks, destructors and so
739	my $self = shift;	800	on) will be run without a thread context, and is not allowed to switch
		801	to other threads. A common mistake is to call C<< ->cancel >> from a
		802	destructor called by die'ing inside the thread to be cancelled for
		803	example.
740		804
741	if ($current == $self) {	805	On the plus side, C<< ->cancel >> will always clean up the thread, no
742	terminate @_;	806	matter what. If your cleanup code is complex or you want to avoid
743	} else {	807	cancelling a C-thread that doesn't know how to clean up itself, it can be
744	$self->{_status} = [@_];	808	better to C<< ->throw >> an exception, or use C<< ->safe_cancel >>.
745	Coro::State::cancel $self;	809
		810	The arguments to C<< ->cancel >> are not copied, but instead will
		811	be referenced directly (e.g. if you pass C<$var> and after the call
		812	change that variable, then you might change the return values passed to
		813	e.g. C<join>, so don't do that).
		814
		815	The resources of the Coro are usually freed (or destructed) before this
		816	call returns, but this can be delayed for an indefinite amount of time, as
		817	in some cases the manager thread has to run first to actually destruct the
		818	Coro object.
		819
		820	=item $coro->safe_cancel ($arg...)
		821
		822	Works mostly like C<< ->cancel >>, but is inherently "safer", and
		823	consequently, can fail with an exception in cases the thread is not in a
		824	cancellable state. Essentially, C<< ->safe_cancel >> is a C<< ->cancel >>
		825	with extra checks before canceling.
		826
		827	It works a bit like throwing an exception that cannot be caught -
		828	specifically, it will clean up the thread from within itself, so all
		829	cleanup handlers (e.g. C<guard> blocks) are run with full thread
		830	context and can block if they wish. The downside is that there is no
		831	guarantee that the thread can be cancelled when you call this method, and
		832	therefore, it might fail. It is also considerably slower than C<cancel> or
		833	C<terminate>.
		834
		835	A thread is in a safe-cancellable state if it either hasn't been run yet,
		836	or it has no C context attached and is inside an SLF function.
		837
		838	The latter two basically mean that the thread isn't currently inside a
		839	perl callback called from some C function (usually via some XS modules)
		840	and isn't currently executing inside some C function itself (via Coro's XS
		841	API).
		842
		843	This call returns true when it could cancel the thread, or croaks with an
		844	error otherwise (i.e. it either returns true or doesn't return at all).
		845
		846	Why the weird interface? Well, there are two common models on how and
		847	when to cancel things. In the first, you have the expectation that your
		848	coro thread can be cancelled when you want to cancel it - if the thread
		849	isn't cancellable, this would be a bug somewhere, so C<< ->safe_cancel >>
		850	croaks to notify of the bug.
		851
		852	In the second model you sometimes want to ask nicely to cancel a thread,
		853	but if it's not a good time, well, then don't cancel. This can be done
		854	relatively easy like this:
		855
		856	if (! eval { $coro->safe_cancel }) {
		857	warn "unable to cancel thread: $@";
746	}	858	}
747	}	859
		860	However, what you never should do is first try to cancel "safely" and
		861	if that fails, cancel the "hard" way with C<< ->cancel >>. That makes
		862	no sense: either you rely on being able to execute cleanup code in your
		863	thread context, or you don't. If you do, then C<< ->safe_cancel >> is the
		864	only way, and if you don't, then C<< ->cancel >> is always faster and more
		865	direct.
748		866
749	=item $coro->schedule_to	867	=item $coro->schedule_to
750		868
751	Puts the current coro to sleep (like C<Coro::schedule>), but instead	869	Puts the current coro to sleep (like C<Coro::schedule>), but instead
752	of continuing with the next coro from the ready queue, always switch to	870	of continuing with the next coro from the ready queue, always switch to
…		…
771	inside the coro at the next convenient point in time. Otherwise	889	inside the coro at the next convenient point in time. Otherwise
772	clears the exception object.	890	clears the exception object.
773		891
774	Coro will check for the exception each time a schedule-like-function	892	Coro will check for the exception each time a schedule-like-function
775	returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down	893	returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
776	>>, C<< Coro::Handle->readable >> and so on. Most of these functions	894	>>, C<< Coro::Handle->readable >> and so on. Most of those functions (all
777	detect this case and return early in case an exception is pending.	895	that are part of Coro itself) detect this case and return early in case an
		896	exception is pending.
778		897
779	The exception object will be thrown "as is" with the specified scalar in	898	The exception object will be thrown "as is" with the specified scalar in
780	C<$@>, i.e. if it is a string, no line number or newline will be appended	899	C<$@>, i.e. if it is a string, no line number or newline will be appended
781	(unlike with C<die>).	900	(unlike with C<die>).
782		901
783	This can be used as a softer means than C<cancel> to ask a coro to	902	This can be used as a softer means than either C<cancel> or C<safe_cancel
784	end itself, although there is no guarantee that the exception will lead to	903	>to ask a coro to end itself, although there is no guarantee that the
785	termination, and if the exception isn't caught it might well end the whole	904	exception will lead to termination, and if the exception isn't caught it
786	program.	905	might well end the whole program.
787		906
788	You might also think of C<throw> as being the moral equivalent of	907	You might also think of C<throw> as being the moral equivalent of
789	C<kill>ing a coro with a signal (in this case, a scalar).	908	C<kill>ing a coro with a signal (in this case, a scalar).
790		909
791	=item $coro->join	910	=item $coro->join
792		911
793	Wait until the coro terminates and return any values given to the	912	Wait until the coro terminates and return any values given to the
794	C<terminate> or C<cancel> functions. C<join> can be called concurrently	913	C<terminate> or C<cancel> functions. C<join> can be called concurrently
795	from multiple coro, and all will be resumed and given the status	914	from multiple threads, and all will be resumed and given the status
796	return once the C<$coro> terminates.	915	return once the C<$coro> terminates.
797		916
798	=cut
799
800	sub join {
801	my $self = shift;
802
803	unless ($self->{_status}) {
804	my $current = $current;
805
806	push @{$self->{_on_destroy}}, sub {
807	$current->ready;
808	undef $current;
809	};
810
811	&schedule while $current;
812	}
813
814	wantarray ? @{$self->{_status}} : $self->{_status}[0];
815	}
816
817	=item $coro->on_destroy (\&cb)	917	=item $coro->on_destroy (\&cb)
818		918
819	Registers a callback that is called when this coro thread gets destroyed,	919	Registers a callback that is called when this coro thread gets destroyed,
820	but before it is joined. The callback gets passed the terminate arguments,	920	that is, after it's resources have been freed but before it is joined. The
		921	callback gets passed the terminate/cancel arguments, if any, and I<must
821	if any, and I<must not> die, under any circumstances.	922	not> die, under any circumstances.
822		923
823	There can be any number of C<on_destroy> callbacks per coro.	924	There can be any number of C<on_destroy> callbacks per coro, and there is
824		925	currently no way to remove a callback once added.
825	=cut
826
827	sub on_destroy {
828	my ($self, $cb) = @_;
829
830	push @{ $self->{_on_destroy} }, $cb;
831	}
832		926
833	=item $oldprio = $coro->prio ($newprio)	927	=item $oldprio = $coro->prio ($newprio)
834		928
835	Sets (or gets, if the argument is missing) the priority of the	929	Sets (or gets, if the argument is missing) the priority of the
836	coro thread. Higher priority coro get run before lower priority	930	coro thread. Higher priority coro get run before lower priority
…		…
863	coro thread. This is just a free-form string you can associate with a	957	coro thread. This is just a free-form string you can associate with a
864	coro.	958	coro.
865		959
866	This method simply sets the C<< $coro->{desc} >> member to the given	960	This method simply sets the C<< $coro->{desc} >> member to the given
867	string. You can modify this member directly if you wish, and in fact, this	961	string. You can modify this member directly if you wish, and in fact, this
868	is often preferred to indicate major processing states that cna then be	962	is often preferred to indicate major processing states that can then be
869	seen for example in a L<Coro::Debug> session:	963	seen for example in a L<Coro::Debug> session:
870		964
871	sub my_long_function {	965	sub my_long_function {
872	local $Coro::current->{desc} = "now in my_long_function";	966	local $Coro::current->{desc} = "now in my_long_function";
873	...	967	...
…		…
928	otherwise you might suffer from crashes or worse. The only event library	1022	otherwise you might suffer from crashes or worse. The only event library
929	currently known that is safe to use without C<unblock_sub> is L<EV> (but	1023	currently known that is safe to use without C<unblock_sub> is L<EV> (but
930	you might still run into deadlocks if all event loops are blocked).	1024	you might still run into deadlocks if all event loops are blocked).
931		1025
932	Coro will try to catch you when you block in the event loop	1026	Coro will try to catch you when you block in the event loop
933	("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and	1027	("FATAL: $Coro::idle blocked itself"), but this is just best effort and
934	only works when you do not run your own event loop.	1028	only works when you do not run your own event loop.
935		1029
936	This function allows your callbacks to block by executing them in another	1030	This function allows your callbacks to block by executing them in another
937	coro where it is safe to block. One example where blocking is handy	1031	coro where it is safe to block. One example where blocking is handy
938	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to	1032	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
…		…
1029	It is very common for a coro to wait for some callback to be	1123	It is very common for a coro to wait for some callback to be
1030	called. This occurs naturally when you use coro in an otherwise	1124	called. This occurs naturally when you use coro in an otherwise
1031	event-based program, or when you use event-based libraries.	1125	event-based program, or when you use event-based libraries.
1032		1126
1033	These typically register a callback for some event, and call that callback	1127	These typically register a callback for some event, and call that callback
1034	when the event occured. In a coro, however, you typically want to	1128	when the event occurred. In a coro, however, you typically want to
1035	just wait for the event, simplyifying things.	1129	just wait for the event, simplyifying things.
1036		1130
1037	For example C<< AnyEvent->child >> registers a callback to be called when	1131	For example C<< AnyEvent->child >> registers a callback to be called when
1038	a specific child has exited:	1132	a specific child has exited:
1039		1133
…		…
1042	But from within a coro, you often just want to write this:	1136	But from within a coro, you often just want to write this:
1043		1137
1044	my $status = wait_for_child $pid;	1138	my $status = wait_for_child $pid;
1045		1139
1046	Coro offers two functions specifically designed to make this easy,	1140	Coro offers two functions specifically designed to make this easy,
1047	C<Coro::rouse_cb> and C<Coro::rouse_wait>.	1141	C<rouse_cb> and C<rouse_wait>.
1048		1142
1049	The first function, C<rouse_cb>, generates and returns a callback that,	1143	The first function, C<rouse_cb>, generates and returns a callback that,
1050	when invoked, will save its arguments and notify the coro that	1144	when invoked, will save its arguments and notify the coro that
1051	created the callback.	1145	created the callback.
1052		1146
…		…
1058	function mentioned above:	1152	function mentioned above:
1059		1153
1060	sub wait_for_child($) {	1154	sub wait_for_child($) {
1061	my ($pid) = @_;	1155	my ($pid) = @_;
1062		1156
1063	my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb);	1157	my $watcher = AnyEvent->child (pid => $pid, cb => rouse_cb);
1064		1158
1065	my ($rpid, $rstatus) = Coro::rouse_wait;	1159	my ($rpid, $rstatus) = rouse_wait;
1066	$rstatus	1160	$rstatus
1067	}	1161	}
1068		1162
1069	In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,	1163	In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,
1070	you can roll your own, using C<schedule>:	1164	you can roll your own, using C<schedule> and C<ready>:
1071		1165
1072	sub wait_for_child($) {	1166	sub wait_for_child($) {
1073	my ($pid) = @_;	1167	my ($pid) = @_;
1074		1168
1075	# store the current coro in $current,	1169	# store the current coro in $current,
…		…
1078	my ($done, $rstatus);	1172	my ($done, $rstatus);
1079		1173
1080	# pass a closure to ->child	1174	# pass a closure to ->child
1081	my $watcher = AnyEvent->child (pid => $pid, cb => sub {	1175	my $watcher = AnyEvent->child (pid => $pid, cb => sub {
1082	$rstatus = $_[1]; # remember rstatus	1176	$rstatus = $_[1]; # remember rstatus
1083	$done = 1; # mark $rstatus as valud	1177	$done = 1; # mark $rstatus as valid
		1178	$current->ready; # wake up the waiting thread
1084	});	1179	});
1085		1180
1086	# wait until the closure has been called	1181	# wait until the closure has been called
1087	schedule while !$done;	1182	schedule while !$done;
1088		1183
…		…
1107	module from the first thread (this requirement might be removed in the	1202	module from the first thread (this requirement might be removed in the
1108	future to allow per-thread schedulers, but Coro::State does not yet allow	1203	future to allow per-thread schedulers, but Coro::State does not yet allow
1109	this). I recommend disabling thread support and using processes, as having	1204	this). I recommend disabling thread support and using processes, as having
1110	the windows process emulation enabled under unix roughly halves perl	1205	the windows process emulation enabled under unix roughly halves perl
1111	performance, even when not used.	1206	performance, even when not used.
		1207
		1208	Attempts to use threads created in another emulated process will crash
		1209	("cleanly", with a null pointer exception).
1112		1210
1113	=item coro switching is not signal safe	1211	=item coro switching is not signal safe
1114		1212
1115	You must not switch to another coro from within a signal handler (only	1213	You must not switch to another coro from within a signal handler (only
1116	relevant with %SIG - most event libraries provide safe signals), I<unless>	1214	relevant with %SIG - most event libraries provide safe signals), I<unless>
…		…
1164	processes. What makes it so bad is that on non-windows platforms, you can	1262	processes. What makes it so bad is that on non-windows platforms, you can
1165	actually take advantage of custom hardware for this purpose (as evidenced	1263	actually take advantage of custom hardware for this purpose (as evidenced
1166	by the forks module, which gives you the (i-) threads API, just much	1264	by the forks module, which gives you the (i-) threads API, just much
1167	faster).	1265	faster).
1168		1266
1169	Sharing data is in the i-threads model is done by transfering data	1267	Sharing data is in the i-threads model is done by transferring data
1170	structures between threads using copying semantics, which is very slow -	1268	structures between threads using copying semantics, which is very slow -
1171	shared data simply does not exist. Benchmarks using i-threads which are	1269	shared data simply does not exist. Benchmarks using i-threads which are
1172	communication-intensive show extremely bad behaviour with i-threads (in	1270	communication-intensive show extremely bad behaviour with i-threads (in
1173	fact, so bad that Coro, which cannot take direct advantage of multiple	1271	fact, so bad that Coro, which cannot take direct advantage of multiple
1174	CPUs, is often orders of magnitude faster because it shares data using	1272	CPUs, is often orders of magnitude faster because it shares data using
…		…
1204		1302
1205	XS API: L<Coro::MakeMaker>.	1303	XS API: L<Coro::MakeMaker>.
1206		1304
1207	Low level Configuration, Thread Environment, Continuations: L<Coro::State>.	1305	Low level Configuration, Thread Environment, Continuations: L<Coro::State>.
1208		1306
1209	=head1 AUTHOR	1307	=head1 AUTHOR/SUPPORT/CONTACT
1210		1308
1211	Marc Lehmann <schmorp@schmorp.de>	1309	Marc A. Lehmann <schmorp@schmorp.de>
1212	http://home.schmorp.de/	1310	http://software.schmorp.de/pkg/Coro.html
1213		1311
1214	=cut	1312	=cut
1215		1313

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.286 by root, Sat Feb 19 04:34:59 2011 UTC vs. Revision 1.346 by root, Fri Jul 14 23:20:07 2017 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.286 by root, Sat Feb 19 04:34:59 2011 UTC vs.
Revision 1.346 by root, Fri Jul 14 23:20:07 2017 UTC