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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.273 by root, Fri Dec 11 18:32:23 2009 UTC vs.
Revision 1.280 by root, Thu Nov 11 15:07:16 2010 UTC

81 81
82our $idle; # idle handler 82our $idle; # idle handler
83our $main; # main coro 83our $main; # main coro
84our $current; # current coro 84our $current; # current coro
85 85
86our $VERSION = 5.21; 86our $VERSION = 5.25;
87 87
88our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); 88our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);
89our %EXPORT_TAGS = ( 89our %EXPORT_TAGS = (
90 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 90 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
91); 91);
138 138
139See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. 139See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique.
140 140
141=cut 141=cut
142 142
143# ||= because other modules could have provided their own by now
143$idle = new Coro sub { 144$idle ||= new Coro sub {
144 require Coro::Debug; 145 require Coro::Debug;
145 die "FATAL: deadlock detected.\n" 146 die "FATAL: deadlock detected.\n"
146 . Coro::Debug::ps_listing (); 147 . Coro::Debug::ps_listing ();
147}; 148};
148 149
612Sets (or gets in case the argument is missing) the description for this 613Sets (or gets in case the argument is missing) the description for this
613coro. This is just a free-form string you can associate with a 614coro. This is just a free-form string you can associate with a
614coro. 615coro.
615 616
616This method simply sets the C<< $coro->{desc} >> member to the given 617This method simply sets the C<< $coro->{desc} >> member to the given
617string. You can modify this member directly if you wish. 618string. You can modify this member directly if you wish, and in fact, this
619is often preferred to indicate major processing states that cna then be
620seen for example in a L<Coro::Debug> session:
621
622 sub my_long_function {
623 local $Coro::current->{desc} = "now in my_long_function";
624 ...
625 $Coro::current->{desc} = "my_long_function: phase 1";
626 ...
627 $Coro::current->{desc} = "my_long_function: phase 2";
628 ...
629 }
618 630
619=cut 631=cut
620 632
621sub desc { 633sub desc {
622 my $old = $_[0]{desc}; 634 my $old = $_[0]{desc};
664The reason this function exists is that many event libraries (such as the 676The reason this function exists is that many event libraries (such as the
665venerable L<Event|Event> module) are not thread-safe (a weaker form 677venerable L<Event|Event> module) are not thread-safe (a weaker form
666of reentrancy). This means you must not block within event callbacks, 678of reentrancy). This means you must not block within event callbacks,
667otherwise you might suffer from crashes or worse. The only event library 679otherwise you might suffer from crashes or worse. The only event library
668currently known that is safe to use without C<unblock_sub> is L<EV>. 680currently known that is safe to use without C<unblock_sub> is L<EV>.
681
682Coro will try to catch you when you block in the event loop
683("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and
684only works when you do not run your own event loop.
669 685
670This function allows your callbacks to block by executing them in another 686This function allows your callbacks to block by executing them in another
671coro where it is safe to block. One example where blocking is handy 687coro where it is safe to block. One example where blocking is handy
672is when you use the L<Coro::AIO|Coro::AIO> functions to save results to 688is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
673disk, for example. 689disk, for example.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines