… | |
… | |
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.801; |
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; |
… | |
… | |
168 | while @destroy; |
160 | while @destroy; |
169 | |
161 | |
170 | &schedule; |
162 | &schedule; |
171 | } |
163 | } |
172 | }; |
164 | }; |
173 | $manager->desc ("[coro manager]"); |
165 | $manager->{desc} = "[coro manager]"; |
174 | $manager->prio (PRIO_MAX); |
166 | $manager->prio (PRIO_MAX); |
175 | |
167 | |
176 | =back |
168 | =back |
177 | |
169 | |
178 | =head2 SIMPLE COROUTINE CREATION |
170 | =head2 SIMPLE COROUTINE CREATION |
… | |
… | |
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 | |
… | |
… | |
441 | } else { |
433 | } else { |
442 | $self->_cancel; |
434 | $self->_cancel; |
443 | } |
435 | } |
444 | } |
436 | } |
445 | |
437 | |
|
|
438 | =item $coroutine->throw ([$scalar]) |
|
|
439 | |
|
|
440 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
441 | inside the coroutine at the next convenient point in time. Otherwise |
|
|
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. Note that this means that |
|
|
447 | when a coroutine is acquiring a lock, it might only throw after it has |
|
|
448 | sucessfully acquired it. |
|
|
449 | |
|
|
450 | The exception object will be thrown "as is" with the specified scalar in |
|
|
451 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
452 | (unlike with C<die>). |
|
|
453 | |
|
|
454 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
455 | end itself, although there is no guarantee that the exception will lead to |
|
|
456 | termination, and if the exception isn't caught it might well end the whole |
|
|
457 | program. |
|
|
458 | |
|
|
459 | You might also think of C<throw> as being the moral equivalent of |
|
|
460 | C<kill>ing a coroutine with a signal (in this case, a scalar). |
|
|
461 | |
446 | =item $coroutine->join |
462 | =item $coroutine->join |
447 | |
463 | |
448 | Wait until the coroutine terminates and return any values given to the |
464 | Wait until the coroutine terminates and return any values given to the |
449 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
465 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
450 | from multiple coroutines, and all will be resumed and given the status |
466 | from multiple coroutines, and all will be resumed and given the status |
… | |
… | |
511 | higher values mean lower priority, just as in unix). |
527 | higher values mean lower priority, just as in unix). |
512 | |
528 | |
513 | =item $olddesc = $coroutine->desc ($newdesc) |
529 | =item $olddesc = $coroutine->desc ($newdesc) |
514 | |
530 | |
515 | Sets (or gets in case the argument is missing) the description for this |
531 | Sets (or gets in case the argument is missing) the description for this |
516 | coroutine. This is just a free-form string you can associate with a coroutine. |
532 | coroutine. This is just a free-form string you can associate with a |
|
|
533 | coroutine. |
517 | |
534 | |
518 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
535 | This method simply sets the C<< $coroutine->{desc} >> member to the given |
519 | can modify this member directly if you wish. |
536 | string. You can modify this member directly if you wish. |
520 | |
|
|
521 | =item $coroutine->throw ([$scalar]) |
|
|
522 | |
|
|
523 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
524 | inside the coroutine at the next convinient point in time (usually after |
|
|
525 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
526 | exception object. |
|
|
527 | |
|
|
528 | The exception object will be thrown "as is" with the specified scalar in |
|
|
529 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
530 | (unlike with C<die>). |
|
|
531 | |
|
|
532 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
533 | end itself, although there is no guarentee that the exception will lead to |
|
|
534 | termination, and if the exception isn't caught it might well end the whole |
|
|
535 | program. |
|
|
536 | |
537 | |
537 | =cut |
538 | =cut |
538 | |
539 | |
539 | sub desc { |
540 | sub desc { |
540 | my $old = $_[0]{desc}; |
541 | my $old = $_[0]{desc}; |
… | |
… | |
642 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
643 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
643 | } |
644 | } |
644 | schedule; # sleep well |
645 | schedule; # sleep well |
645 | } |
646 | } |
646 | }; |
647 | }; |
647 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
648 | $unblock_scheduler->{desc} = "[unblock_sub scheduler]"; |
648 | |
649 | |
649 | sub unblock_sub(&) { |
650 | sub unblock_sub(&) { |
650 | my $cb = shift; |
651 | my $cb = shift; |
651 | |
652 | |
652 | sub { |
653 | sub { |
… | |
… | |
661 | |
662 | |
662 | 1; |
663 | 1; |
663 | |
664 | |
664 | =head1 BUGS/LIMITATIONS |
665 | =head1 BUGS/LIMITATIONS |
665 | |
666 | |
|
|
667 | =over 4 |
|
|
668 | |
|
|
669 | =item fork with pthread backend |
|
|
670 | |
|
|
671 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
672 | but required on many BSDs as their libcs are completely broken), then |
|
|
673 | coroutines will not survive a fork. There is no known workaround except to |
|
|
674 | fix your libc and use a saner backend. |
|
|
675 | |
|
|
676 | =item perl process emulation ("threads") |
|
|
677 | |
666 | This module is not perl-pseudo-thread-safe. You should only ever use this |
678 | This module is not perl-pseudo-thread-safe. You should only ever use this |
667 | module from the same thread (this requirement might be removed in the |
679 | module from the same thread (this requirement might be removed in the |
668 | future to allow per-thread schedulers, but Coro::State does not yet allow |
680 | future to allow per-thread schedulers, but Coro::State does not yet allow |
669 | this). I recommend disabling thread support and using processes, as this |
681 | this). I recommend disabling thread support and using processes, as having |
670 | is much faster and uses less memory. |
682 | the windows process emulation enabled under unix roughly halves perl |
|
|
683 | performance, even when not used. |
|
|
684 | |
|
|
685 | =item coroutine switching not signal safe |
|
|
686 | |
|
|
687 | You must not switch to another coroutine from within a signal handler |
|
|
688 | (only relevant with %SIG - most event libraries provide safe signals). |
|
|
689 | |
|
|
690 | That means you I<MUST NOT> call any function that might "block" the |
|
|
691 | current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
692 | anything that calls those. Everything else, including calling C<ready>, |
|
|
693 | works. |
|
|
694 | |
|
|
695 | =back |
|
|
696 | |
671 | |
697 | |
672 | =head1 SEE ALSO |
698 | =head1 SEE ALSO |
673 | |
699 | |
674 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
700 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
675 | |
701 | |