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

Comparing Coro/Coro.pm (file contents):
Revision 1.213 by root, Tue Nov 11 03:26:58 2008 UTC vs.
Revision 1.223 by root, Tue Nov 18 10:44:07 2008 UTC

… …
67 67
68our $idle; # idle handler 68our $idle; # idle handler
69our $main; # main coroutine 69our $main; # main coroutine
70our $current; # current coroutine 70our $current; # current coroutine
71 71
72our $VERSION = 4.901; 72our $VERSION = 5.0;
73 73
74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
75our %EXPORT_TAGS = ( 75our %EXPORT_TAGS = (
76 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)],
77); 77);
… …
86coroutines, it is mainly useful to compare again C<$Coro::current>, to see 86coroutines, it is mainly useful to compare again C<$Coro::current>, to see
87whether you are running in the main program or not. 87whether you are running in the main program or not.
88 88
89=cut 89=cut
90 90
91$main = new Coro; 91# $main is now being initialised by Coro::State
92 92
93=item $Coro::current 93=item $Coro::current
94 94
95The coroutine object representing the current coroutine (the last 95The coroutine object representing the current coroutine (the last
96coroutine that the Coro scheduler switched to). The initial value is 96coroutine that the Coro scheduler switched to). The initial value is
97C<$main> (of course). 97C<$Coro::main> (of course).
98 98
99This variable is B<strictly> I<read-only>. You can take copies of the 99This variable is B<strictly> I<read-only>. You can take copies of the
100value stored in it and use it as any other coroutine object, but you must 100value stored in it and use it as any other coroutine object, but you must
101not otherwise modify the variable itself. 101not otherwise modify the variable itself.
102 102
103=cut 103=cut
104
105$main->{desc} = "[main::]";
106
107# maybe some other module used Coro::Specific before...
108$main->{_specific} = $current->{_specific}
109 if $current;
110
111_set_current $main;
112 104
113sub current() { $current } # [DEPRECATED] 105sub current() { $current } # [DEPRECATED]
114 106
115=item $Coro::idle 107=item $Coro::idle
116 108
… …
275 } 267 }
276 } 268 }
277} 269}
278 270
279sub async_pool(&@) { 271sub async_pool(&@) {
280 # this is also inlined into the unlock_scheduler 272 # this is also inlined into the unblock_scheduler
281 my $coro = (pop @async_pool) || new Coro \&pool_handler; 273 my $coro = (pop @async_pool) || new Coro \&pool_handler;
282 274
283 $coro->{_invoke} = [@_]; 275 $coro->{_invoke} = [@_];
284 $coro->ready; 276 $coro->ready;
285 277
… …
444} 436}
445 437
446=item $coroutine->throw ([$scalar]) 438=item $coroutine->throw ([$scalar])
447 439
448If C<$throw> is specified and defined, it will be thrown as an exception 440If C<$throw> is specified and defined, it will be thrown as an exception
449inside the coroutine at the next convenient point in time (usually after 441inside the coroutine at the next convenient point in time. Otherwise
450it gains control at the next schedule/transfer/cede). Otherwise clears the
451exception object. 442clears the exception object.
443
444Coro will check for the exception each time a schedule-like-function
445returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
446>>, C<< Coro::Handle->readable >> and so on. Most of these functions
447detect this case and return early in case an exception is pending.
452 448
453The exception object will be thrown "as is" with the specified scalar in 449The exception object will be thrown "as is" with the specified scalar in
454C<$@>, i.e. if it is a string, no line number or newline will be appended 450C<$@>, i.e. if it is a string, no line number or newline will be appended
455(unlike with C<die>). 451(unlike with C<die>).
456 452
… …
665 661
6661; 6621;
667 663
668=head1 BUGS/LIMITATIONS 664=head1 BUGS/LIMITATIONS
669 665
666=over 4
667
668=item fork with pthread backend
669
670When Coro is compiled using the pthread backend (which isn't recommended
671but required on many BSDs as their libcs are completely broken), then
672coroutines will not survive a fork. There is no known workaround except to
673fix your libc and use a saner backend.
674
675=item perl process emulation ("threads")
676
670This module is not perl-pseudo-thread-safe. You should only ever use this 677This module is not perl-pseudo-thread-safe. You should only ever use this
671module from the same thread (this requirement might be removed in the 678module from the same thread (this requirement might be removed in the
672future to allow per-thread schedulers, but Coro::State does not yet allow 679future to allow per-thread schedulers, but Coro::State does not yet allow
673this). I recommend disabling thread support and using processes, as this 680this). I recommend disabling thread support and using processes, as having
674is much faster and uses less memory. 681the windows process emulation enabled under unix roughly halves perl
682performance, even when not used.
683
684=item coroutine switching not signal safe
685
686You must not switch to another coroutine from within a signal handler
687(only relevant with %SIG - most event libraries provide safe signals).
688
689That means you I<MUST NOT> call any function that might "block" the
690current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
691anything that calls those. Everything else, including calling C<ready>,
692works.
693
694=back
695
675 696
676=head1 SEE ALSO 697=head1 SEE ALSO
677 698
678Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 699Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
679 700

Diff Legend

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