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.13 by root, Sat Mar 22 18:50:32 2003 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> ";
… …
18 } 18 }
19 } 19 }
20 20
21 loop; 21 loop;
22 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";
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
27threaded programs. 32threaded programs.
… …
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::loop. 40Coro::Event::loop.
36 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
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 qw(uninitialized); 77no warnings;
44 78
45use Carp; 79use Carp;
80no warnings;
46 81
47use Coro; 82use Coro;
83use Coro::Timer;
48use Event qw(loop 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 reschedule); 90our @EXPORT = qw(loop unloop sweep);
53 91
54BEGIN { 92BEGIN {
55 $VERSION = 0.6; 93 our $VERSION = '2.0';
56 94
57 local $^W = 0; # avoid redefine warning for Coro::ready; 95 local $^W = 0; # avoid redefine warning for Coro::ready;
58 require XSLoader;
59 XSLoader::load Coro::Event, $VERSION; 96 XSLoader::load __PACKAGE__, $VERSION;
60} 97}
61 98
62=item $w = Coro::Event->flavour(args...) 99=item $w = Coro::Event->flavour (args...)
63 100
64Create and return a watcher of the given type. 101Create and return a watcher of the given type.
65 102
66Examples: 103Examples:
67 104
… …
70 107
71=cut 108=cut
72 109
73=item $w->next 110=item $w->next
74 111
75Return 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.
76 116
77=cut 117=cut
78 118
79=item do_flavour(args...) 119=item do_flavour args...
80 120
81Create 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
82method. This is less efficient then calling the constructor once and the 124This is less efficient then calling the constructor once and the next
83next method often, but it does save typing sometimes. 125method often, but it does save typing sometimes.
84 126
85=cut 127=cut
86 128
87for my $flavour (qw(idle var timer io signal)) { 129for my $flavour (qw(idle var timer io signal)) {
88 push @EXPORT, "do_$flavour"; 130 push @EXPORT, "do_$flavour";
… …
96 138
97 shift eq Coro::Event:: 139 shift eq Coro::Event::
98 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";
99 141
100 my $w = $new->($class, 142 my $w = $new->($class,
101 desc => $flavour, 143 desc => $flavour,
102 @_, 144 @_,
103 parked => 1, 145 parked => 1,
104 ); 146 );
147
105 _install_std_cb($w, $type); 148 _install_std_cb $w, $type;
106 bless $w, $class; # reblessing due to broken Event 149
150 # reblessing due to Event being broken
151 bless $w, $class
107 }; 152 };
108 *{ $flavour } = $coronew; 153 *{ $flavour } = $coronew;
109 *{"do_$flavour"} = sub { 154 *{"do_$flavour"} = sub {
110 unshift @_, Coro::Event::; 155 unshift @_, Coro::Event::;
111 my $e = (&$coronew)->next; 156 @_ = &$coronew;
112 $e->cancel; # $e = $e->w->cancel ($e == $e->w!) 157 &Coro::schedule while &_next;
113 $e; 158 $_[0]->cancel;
159 &_event
114 }; 160 };
115} 161}
116 162
117# double calls to avoid stack-cloning ;() 163# do schedule in perl to avoid forcing a stack allocation.
118# is about 10% slower, though. 164# this is about 10% slower, though.
119sub next($) { 165sub next($) {
120 &Coro::schedule if &_next; $_[0]; 166 &Coro::schedule while &_next;
121}
122 167
168 &_event
169}
170
171sub Coro::Event::Event::hits { $_[0][3] }
123sub Coro::Event::w { $_[0] } 172sub Coro::Event::Event::got { $_[0][4] }
124sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
125sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
126sub Coro::Event::got { $_[0]{Coro::Event}[5] }
127 173
128=item sweep 174=item sweep
129 175
130Similar 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
131(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
… …
137into the Event dispatcher. 183into the Event dispatcher.
138 184
139=cut 185=cut
140 186
141sub sweep { 187sub sweep {
142 Event::one_event(0); # for now 188 Event::one_event 0; # for now
143} 189}
144 190
145=item $result = loop([$timeout]) 191=item $result = loop([$timeout])
146 192
147This 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>
148when using this module - it will ensure correct scheduling in the presence 194when using this module - it will ensure correct scheduling in the presence
149of events. 195of events.
150 196
151=begin comment
152
153Unlike loop's counterpart it is not an error when no watchers are active -
154loop silently returns in this case, as if unloop(undef) were called.
155
156=end comment
157
158=cut
159
160# no longer do something special - it's done internally now
161
162#sub loop(;$) {
163# #local $Coro::idle = $Coro::current;
164# #Coro::schedule; # become idle task, which is implicitly ready
165# &Event::loop;
166#}
167
168=item unloop([$result]) 197=item unloop([$result])
169 198
170Same as Event::unloop (provided here for your convinience only). 199Same as Event::unloop (provided here for your convinience only).
171 200
172=cut 201=cut
173 202
174$Coro::idle = new Coro sub { 203$Coro::idle = \&Event::one_event; # inefficient
175 while () {
176 Event::one_event; # inefficient
177 Coro::schedule;
178 }
179};
180
181# provide hooks for Coro::Timer
182
183package Coro::Timer;
184
185unless ($override) {
186 $override = 1;
187 *_new_timer = sub {
188 Event->timer(at => $_[0], cb => $_[1]);
189 };
190}
191 204
1921; 2051;
193 206
207=back
208
194=head1 AUTHOR 209=head1 AUTHOR
195 210
196 Marc Lehmann <pcg@goof.com> 211 Marc Lehmann <schmorp@schmorp.de>
197 http://www.goof.com/pcg/marc/ 212 http://home.schmorp.de/
198 213
199=cut 214=cut
200 215

Diff Legend

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