… | |
… | |
56 | |
56 | |
57 | =cut |
57 | =cut |
58 | |
58 | |
59 | package Coro; |
59 | package Coro; |
60 | |
60 | |
61 | use strict; |
61 | use strict qw(vars subs); |
62 | no warnings "uninitialized"; |
62 | no warnings "uninitialized"; |
63 | |
63 | |
64 | use Coro::State; |
64 | use Coro::State; |
65 | |
65 | |
66 | use base qw(Coro::State Exporter); |
66 | use base qw(Coro::State Exporter); |
67 | |
67 | |
68 | our $idle; # idle handler |
68 | our $idle; # idle handler |
69 | our $main; # main coroutine |
69 | our $main; # main coroutine |
70 | our $current; # current coroutine |
70 | our $current; # current coroutine |
71 | |
71 | |
72 | our $VERSION = 4.803; |
72 | our $VERSION = 5.0; |
73 | |
73 | |
74 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
74 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
75 | our %EXPORT_TAGS = ( |
75 | our %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 | ); |
… | |
… | |
86 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
86 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
87 | whether you are running in the main program or not. |
87 | whether 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 | |
95 | The coroutine object representing the current coroutine (the last |
95 | The coroutine object representing the current coroutine (the last |
96 | coroutine that the Coro scheduler switched to). The initial value is |
96 | coroutine that the Coro scheduler switched to). The initial value is |
97 | C<$main> (of course). |
97 | C<$Coro::main> (of course). |
98 | |
98 | |
99 | This variable is B<strictly> I<read-only>. You can take copies of the |
99 | This variable is B<strictly> I<read-only>. You can take copies of the |
100 | value stored in it and use it as any other coroutine object, but you must |
100 | value stored in it and use it as any other coroutine object, but you must |
101 | not otherwise modify the variable itself. |
101 | not 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 | |
113 | sub current() { $current } # [DEPRECATED] |
105 | sub current() { $current } # [DEPRECATED] |
114 | |
106 | |
115 | =item $Coro::idle |
107 | =item $Coro::idle |
116 | |
108 | |
… | |
… | |
152 | $self->_destroy |
144 | $self->_destroy |
153 | or return; |
145 | or return; |
154 | |
146 | |
155 | # call all destruction callbacks |
147 | # call all destruction callbacks |
156 | $_->(@{$self->{_status}}) |
148 | $_->(@{$self->{_status}}) |
157 | for @{(delete $self->{_on_destroy}) || []}; |
149 | for @{ delete $self->{_on_destroy} || [] }; |
158 | } |
150 | } |
159 | |
151 | |
160 | # this coroutine is necessary because a coroutine |
152 | # this coroutine is necessary because a coroutine |
161 | # cannot destroy itself. |
153 | # cannot destroy itself. |
162 | my @destroy; |
154 | my @destroy; |
… | |
… | |
275 | } |
267 | } |
276 | } |
268 | } |
277 | } |
269 | } |
278 | |
270 | |
279 | sub async_pool(&@) { |
271 | sub 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 | |
448 | If C<$throw> is specified and defined, it will be thrown as an exception |
440 | If C<$throw> is specified and defined, it will be thrown as an exception |
449 | inside the coroutine at the next convenient point in time (usually after |
441 | inside the coroutine at the next convenient point in time. Otherwise |
450 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
451 | exception object. |
442 | clears the exception object. |
|
|
443 | |
|
|
444 | Coro will check for the exception each time a schedule-like-function |
|
|
445 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
|
|
446 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
|
|
447 | detect this case and return early in case an exception is pending. |
452 | |
448 | |
453 | The exception object will be thrown "as is" with the specified scalar in |
449 | The exception object will be thrown "as is" with the specified scalar in |
454 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
450 | C<$@>, 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 | |
666 | 1; |
662 | 1; |
667 | |
663 | |
668 | =head1 BUGS/LIMITATIONS |
664 | =head1 BUGS/LIMITATIONS |
669 | |
665 | |
|
|
666 | =over 4 |
|
|
667 | |
|
|
668 | =item fork with pthread backend |
|
|
669 | |
|
|
670 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
671 | but required on many BSDs as their libcs are completely broken), then |
|
|
672 | coroutines will not survive a fork. There is no known workaround except to |
|
|
673 | fix your libc and use a saner backend. |
|
|
674 | |
|
|
675 | =item perl process emulation ("threads") |
|
|
676 | |
670 | This module is not perl-pseudo-thread-safe. You should only ever use this |
677 | This module is not perl-pseudo-thread-safe. You should only ever use this |
671 | module from the same thread (this requirement might be removed in the |
678 | module from the same thread (this requirement might be removed in the |
672 | future to allow per-thread schedulers, but Coro::State does not yet allow |
679 | future to allow per-thread schedulers, but Coro::State does not yet allow |
673 | this). I recommend disabling thread support and using processes, as this |
680 | this). I recommend disabling thread support and using processes, as having |
674 | is much faster and uses less memory. |
681 | the windows process emulation enabled under unix roughly halves perl |
|
|
682 | performance, even when not used. |
|
|
683 | |
|
|
684 | =item coroutine switching not signal safe |
|
|
685 | |
|
|
686 | You must not switch to another coroutine from within a signal handler |
|
|
687 | (only relevant with %SIG - most event libraries provide safe signals). |
|
|
688 | |
|
|
689 | That means you I<MUST NOT> call any function that might "block" the |
|
|
690 | current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
691 | anything that calls those. Everything else, including calling C<ready>, |
|
|
692 | works. |
|
|
693 | |
|
|
694 | =back |
|
|
695 | |
675 | |
696 | |
676 | =head1 SEE ALSO |
697 | =head1 SEE ALSO |
677 | |
698 | |
678 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
699 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
679 | |
700 | |