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.219 by root, Sun Nov 16 00:55:41 2008 UTC vs.
Revision 1.223 by root, Tue Nov 18 10:44:07 2008 UTC

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
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
688=item coroutine switching not signal safe 684=item coroutine switching not signal safe
689 685
690You must not switch to another coroutine from within a signal handler 686You must not switch to another coroutine from within a signal handler
691(only relevant with %SIG - most event libraries provide safe signals). 687(only relevant with %SIG - most event libraries provide safe signals).
692 688
693That means you I<MUST NOT> call any fucntion that might "block" the 689That means you I<MUST NOT> call any function that might "block" the
694current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or 690current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
695anything that calls those. Everything else, including calling C<ready>, 691anything that calls those. Everything else, including calling C<ready>,
696works. 692works.
697 693
698=back 694=back

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines