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

Comparing Coro/Coro.pm (file contents):
Revision 1.119 by root, Wed Mar 28 14:24:17 2007 UTC vs.
Revision 1.124 by root, Thu Apr 19 10:37:26 2007 UTC

… …
20 20
21=head1 DESCRIPTION 21=head1 DESCRIPTION
22 22
23This module collection manages coroutines. Coroutines are similar 23This module collection manages coroutines. Coroutines are similar
24to threads but don't run in parallel at the same time even on SMP 24to threads but don't run in parallel at the same time even on SMP
25machines. The specific flavor of coroutine use din this module also 25machines. The specific flavor of coroutine used in this module also
26guarentees you that it will not switch between coroutines unless 26guarantees you that it will not switch between coroutines unless
27necessary, at easily-identified points in your program, so locking and 27necessary, at easily-identified points in your program, so locking and
28parallel access are rarely an issue, making coroutine programming much 28parallel access are rarely an issue, making coroutine programming much
29safer than threads programming. 29safer than threads programming.
30 30
31(Perl, however, does not natively support real threads but instead does a 31(Perl, however, does not natively support real threads but instead does a
… …
50 50
51our $idle; # idle handler 51our $idle; # idle handler
52our $main; # main coroutine 52our $main; # main coroutine
53our $current; # current coroutine 53our $current; # current coroutine
54 54
55our $VERSION = '3.55'; 55our $VERSION = '3.61';
56 56
57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58our %EXPORT_TAGS = ( 58our %EXPORT_TAGS = (
59 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 59 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60); 60);
… …
108 108
109The current coroutine (the last coroutine switched to). The initial value 109The current coroutine (the last coroutine switched to). The initial value
110is C<$main> (of course). 110is C<$main> (of course).
111 111
112This variable is B<strictly> I<read-only>. It is provided for performance 112This variable is B<strictly> I<read-only>. It is provided for performance
113reasons. If performance is not essentiel you are encouraged to use the 113reasons. If performance is not essential you are encouraged to use the
114C<Coro::current> function instead. 114C<Coro::current> function instead.
115 115
116=cut 116=cut
117 117
118# maybe some other module used Coro::Specific before... 118# maybe some other module used Coro::Specific before...
… …
185 185
186Create a new asynchronous coroutine and return it's coroutine object 186Create a new asynchronous coroutine and return it's coroutine object
187(usually unused). When the sub returns the new coroutine is automatically 187(usually unused). When the sub returns the new coroutine is automatically
188terminated. 188terminated.
189 189
190Calling C<exit> in a coroutine will not work correctly, so do not do that. 190Calling C<exit> in a coroutine will do the same as calling exit outside
191 191the coroutine. Likewise, when the coroutine dies, the program will exit,
192When the coroutine dies, the program will exit, just as in the main 192just as it would in the main program.
193program.
194 193
195 # create a new coroutine that just prints its arguments 194 # create a new coroutine that just prints its arguments
196 async { 195 async {
197 print "@_\n"; 196 print "@_\n";
198 } 1,2,3,4; 197 } 1,2,3,4;
… …
278 # wake up sleeping coroutine 277 # wake up sleeping coroutine
279 $current->ready; 278 $current->ready;
280 undef $current; 279 undef $current;
281 }; 280 };
282 281
283 # call schedule until event occured. 282 # call schedule until event occurred.
284 # in case we are woken up for other reasons 283 # in case we are woken up for other reasons
285 # (current still defined), loop. 284 # (current still defined), loop.
286 Coro::schedule while $current; 285 Coro::schedule while $current;
287 } 286 }
288 287
… …
326Create a new coroutine and return it. When the sub returns the coroutine 325Create a new coroutine and return it. When the sub returns the coroutine
327automatically terminates as if C<terminate> with the returned values were 326automatically terminates as if C<terminate> with the returned values were
328called. To make the coroutine run you must first put it into the ready queue 327called. To make the coroutine run you must first put it into the ready queue
329by calling the ready method. 328by calling the ready method.
330 329
331Calling C<exit> in a coroutine will not work correctly, so do not do that. 330See C<async> for additional discussion.
332 331
333=cut 332=cut
334 333
335sub _run_coro { 334sub _run_coro {
336 terminate &{+shift}; 335 terminate &{+shift};
… …
459=over 4 458=over 4
460 459
461=item Coro::nready 460=item Coro::nready
462 461
463Returns the number of coroutines that are currently in the ready state, 462Returns the number of coroutines that are currently in the ready state,
464i.e. that can be swicthed to. The value C<0> means that the only runnable 463i.e. that can be switched to. The value C<0> means that the only runnable
465coroutine is the currently running one, so C<cede> would have no effect, 464coroutine is the currently running one, so C<cede> would have no effect,
466and C<schedule> would cause a deadlock unless there is an idle handler 465and C<schedule> would cause a deadlock unless there is an idle handler
467that wakes up some coroutines. 466that wakes up some coroutines.
468 467
469=item my $guard = Coro::guard { ... } 468=item my $guard = Coro::guard { ... }
… …
505This utility function takes a BLOCK or code reference and "unblocks" it, 504This utility function takes a BLOCK or code reference and "unblocks" it,
506returning the new coderef. This means that the new coderef will return 505returning the new coderef. This means that the new coderef will return
507immediately without blocking, returning nothing, while the original code 506immediately without blocking, returning nothing, while the original code
508ref will be called (with parameters) from within its own coroutine. 507ref will be called (with parameters) from within its own coroutine.
509 508
510The reason this fucntion exists is that many event libraries (such as the 509The reason this function exists is that many event libraries (such as the
511venerable L<Event|Event> module) are not coroutine-safe (a weaker form 510venerable L<Event|Event> module) are not coroutine-safe (a weaker form
512of thread-safety). This means you must not block within event callbacks, 511of thread-safety). This means you must not block within event callbacks,
513otherwise you might suffer from crashes or worse. 512otherwise you might suffer from crashes or worse.
514 513
515This function allows your callbacks to block by executing them in another 514This function allows your callbacks to block by executing them in another
… …
561 560
562 - you must make very sure that no coro is still active on global 561 - you must make very sure that no coro is still active on global
563 destruction. very bad things might happen otherwise (usually segfaults). 562 destruction. very bad things might happen otherwise (usually segfaults).
564 563
565 - this module is not thread-safe. You should only ever use this module 564 - this module is not thread-safe. You should only ever use this module
566 from the same thread (this requirement might be losened in the future 565 from the same thread (this requirement might be loosened in the future
567 to allow per-thread schedulers, but Coro::State does not yet allow 566 to allow per-thread schedulers, but Coro::State does not yet allow
568 this). 567 this).
569 568
570=head1 SEE ALSO 569=head1 SEE ALSO
571 570

Diff Legend

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