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

Diff Legend

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