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

Comparing Coro/Event/Event.pm (file contents):
Revision 1.2 by root, Fri Aug 17 01:45:39 2001 UTC vs.
Revision 1.44 by root, Fri Dec 1 20:49:54 2006 UTC

… …
6 6
7 use Coro; 7 use Coro;
8 use Coro::Event; 8 use Coro::Event;
9 9
10 sub keyboard : Coro { 10 sub keyboard : Coro {
11 my $w = Coro::Event->io(fd => *STDIN, poll => 'r'); 11 my $w = Coro::Event->io(fd => \*STDIN, poll => 'r');
12 while() { 12 while() {
13 print "cmd> "; 13 print "cmd> ";
14 my $ev = $w->next; my $cmd = <STDIN>; 14 my $ev = $w->next; my $cmd = <STDIN>;
15 unloop unless $cmd ne ""; 15 unloop unless $cmd ne "";
16 print "data> "; 16 print "data> ";
17 my $ev = $w->next; my $data = <STDIN>; 17 my $ev = $w->next; my $data = <STDIN>;
18 } 18 }
19 } 19 }
20 20
21 &loop; 21 loop;
22 22
23=head1 DESCRIPTION 23=head1 DESCRIPTION
24 24
25This module enables you to create programs using the powerful Event model 25This module enables you to create programs using the powerful Event model
26(and module), while retaining the linear style known from simple or 26(and module), while retaining the linear style known from simple or
… …
30(I<flavour>) (see L<Event>). The only difference between these and the 30(I<flavour>) (see L<Event>). The only difference between these and the
31watcher constructors from Event is that you do not specify a callback 31watcher constructors from Event is that you do not specify a callback
32function - it will be managed by this module. 32function - it will be managed by this module.
33 33
34Your application should just create all necessary coroutines and then call 34Your application should just create all necessary coroutines and then call
35Coro::Event->main. 35Coro::Event::loop.
36
37Please note that even programs or modules (such as
38L<Coro::Handle|Coro::Handle>) that use "traditional"
39event-based/continuation style will run more efficient with this module
40then when using only Event.
41
42=head1 WARNING
43
44Please note that Event does not support coroutines or threads. That
45means that you B<MUST NOT> block in an event callback. Again: In Event
46callbacks, you I<must never ever> call a Coroutine fucntion that blocks
47the current coroutine.
48
49While this seems to work superficially, it will eventually cause memory
50corruption.
51
52=head1 FUNCTIONS
36 53
37=over 4 54=over 4
38 55
39=cut 56=cut
40 57
41package Coro::Event; 58package Coro::Event;
42 59
43no warnings; 60no warnings;
44 61
45use Carp; 62use Carp;
63no warnings;
46 64
47use Coro; 65use Coro;
66use Coro::Timer;
48use Event qw(unloop); # we are re-exporting this, cooool! 67use Event qw(loop unloop); # we are re-exporting this, cooool!
49 68
50use base 'Exporter'; 69use XSLoader;
51 70
71use base Exporter::;
72
52@EXPORT = qw(loop unloop sweep); 73our @EXPORT = qw(loop unloop sweep);
53 74
54BEGIN { 75BEGIN {
55 $VERSION = 0.45; 76 our $VERSION = 1.9;
56 77
57 require XSLoader; 78 local $^W = 0; # avoid redefine warning for Coro::ready;
58 XSLoader::load Coro::Event, $VERSION; 79 XSLoader::load __PACKAGE__, $VERSION;
59} 80}
60 81
61=item $w = Coro::Event->flavour(args...) 82=item $w = Coro::Event->flavour (args...)
62 83
63Create and return a watcher of the given type. 84Create and return a watcher of the given type.
64 85
65Examples: 86Examples:
66 87
… …
73 94
74Return the next event of the event queue of the watcher. 95Return the next event of the event queue of the watcher.
75 96
76=cut 97=cut
77 98
78=item do_flavour(args...) 99=item do_flavour args...
79 100
80Create a watcher of the given type and immediately call it's next 101Create a watcher of the given type and immediately call it's next
81method. This is less efficient then calling the constructor once and the 102method. This is less efficient then calling the constructor once and the
82next method often, but it does save typing sometimes. 103next method often, but it does save typing sometimes.
83 104
84=cut 105=cut
85
86#sub std_cb {
87# my $w = $_[0]->w;
88# my $q = $w->private;
89# $q->[1] = $_[0];
90# if ($q->[0]) { # somebody waiting?
91# $q->[0]->ready;
92# &Coro::schedule;
93# } else {
94# $w->stop;
95# }
96#}
97 106
98for my $flavour (qw(idle var timer io signal)) { 107for my $flavour (qw(idle var timer io signal)) {
99 push @EXPORT, "do_$flavour"; 108 push @EXPORT, "do_$flavour";
100 my $new = \&{"Event::$flavour"}; 109 my $new = \&{"Event::$flavour"};
101 my $class = "Coro::Event::$flavour"; 110 my $class = "Coro::Event::$flavour";
… …
103 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour"); 112 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
104 my $coronew = sub { 113 my $coronew = sub {
105 # how does one do method-call-by-name? 114 # how does one do method-call-by-name?
106 # my $w = $class->SUPER::$flavour(@_); 115 # my $w = $class->SUPER::$flavour(@_);
107 116
108 $_[0] eq Coro::Event:: 117 shift eq Coro::Event::
109 or croak "event constructor \"Coro::Event->$flavour\" must be called as a static method"; 118 or croak "event constructor \"Coro::Event->$flavour\" must be called as a static method";
110 119
111 my $q = []; # [$coro, $event]
112 my $w = $new->( 120 my $w = $new->($class,
113 desc => $flavour, 121 desc => $flavour,
114 @_, 122 @_,
115 parked => 1, 123 parked => 1,
116 ); 124 );
125
117 _install_std_cb($w, $type); 126 _install_std_cb $w, $type;
118 bless $w, $class; # reblessing due to broken Event 127
128 # reblessing due to Event being broken
129 bless $w, $class
119 }; 130 };
120 *{ $flavour } = $coronew; 131 *{ $flavour } = $coronew;
121 *{"do_$flavour"} = sub { 132 *{"do_$flavour"} = sub {
122 unshift @_, Coro::Event::; 133 unshift @_, Coro::Event::;
123 my $e = (&$coronew)->next; 134 @_ = &$coronew;
135 &Coro::schedule while &_next;
124 $e->w->cancel; 136 $_[0]->cancel;
125 $e; 137 &_event
126 }; 138 };
127} 139}
128 140
129# double calls to avoid stack-cloning ;() 141# do schedule in perl to avoid forcing a stack allocation.
130# is about 20% slower, though. 142# this is about 10% slower, though.
131sub next($) { 143sub next($) {
132 &_next0; 144 &Coro::schedule while &_next;
133 &Coro::schedule; 145
134 &_next1; 146 &_event
135} 147}
136 148
137#sub next {
138# my $w = $_[0];
139# my $q = $w->private;
140# if ($q->[1]) { # event waiting?
141# $w->again unless $w->is_cancelled;
142# } elsif ($q->[0]) {
143# croak "only one coroutine can wait for an event";
144# } else {
145# local $q->[0] = $Coro::current;
146# &Coro::schedule;
147# }
148# pop @$q;
149#}
150
151sub Coro::Event::Ev::w { $_[0][2] } 149sub Coro::Event::w { $_[0] }
150sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
151sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
152sub Coro::Event::Ev::got { $_[0][3] } 152sub Coro::Event::got { $_[0]{Coro::Event}[5] }
153sub Coro::Event::Ev::prio { croak "prio not supported yet, please mail to pcg\@goof.com" }
154sub Coro::Event::Ev::hits { croak "prio not supported yet, please mail to pcg\@goof.com" }
155 153
156=item sweep 154=item sweep
157 155
158Similar to Event::one_event and Event::sweep: The idle task is called once 156Similar to Event::one_event and Event::sweep: The idle task is called once
159(this has the effect of jumping back into the Event loop once to serve new 157(this has the effect of jumping back into the Event loop once to serve new
… …
165into the Event dispatcher. 163into the Event dispatcher.
166 164
167=cut 165=cut
168 166
169sub sweep { 167sub sweep {
170 one_event(0); # for now 168 Event::one_event 0; # for now
171} 169}
172 170
173=item $result = loop([$timeout]) 171=item $result = loop([$timeout])
174 172
175This is the version of C<loop> you should use instead of C<Event::loop> 173This is the version of C<loop> you should use instead of C<Event::loop>
176when using this module - it will ensure correct scheduling in the presence 174when using this module - it will ensure correct scheduling in the presence
177of events. 175of events.
178 176
179=begin comment
180
181Unlike loop's counterpart it is not an error when no watchers are active -
182loop silently returns in this case, as if unloop(undef) were called.
183
184=end comment
185
186=cut
187
188sub loop(;$) {
189 local $Coro::idle = $Coro::current;
190 Coro::schedule; # become idle task, which is implicitly ready
191 &Event::loop;
192}
193
194=item unloop([$result]) 177=item unloop([$result])
195 178
196Same as Event::unloop (provided here for your convinience only). 179Same as Event::unloop (provided here for your convinience only).
197 180
198=cut 181=cut
199 182
200$Coro::idle = new Coro sub { 183$Coro::idle = \&Event::one_event; # inefficient
201 while () {
202 Event::one_event; # inefficient
203 Coro::schedule;
204 }
205};
206 184
2071; 1851;
208 186
187=back
188
209=head1 AUTHOR 189=head1 AUTHOR
210 190
211 Marc Lehmann <pcg@goof.com> 191 Marc Lehmann <schmorp@schmorp.de>
212 http://www.goof.com/pcg/marc/ 192 http://home.schmorp.de/
213 193
214=cut 194=cut
215 195

Diff Legend

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