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.1 by root, Thu Aug 16 21:55:34 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
54$VERSION = 0.45; 92BEGIN {
93 our $VERSION = '2.0';
55 94
95 local $^W = 0; # avoid redefine warning for Coro::ready;
96 XSLoader::load __PACKAGE__, $VERSION;
97}
98
56=item $w = Coro::Event->flavour(args...) 99=item $w = Coro::Event->flavour (args...)
57 100
58Create and return a watcher of the given type. 101Create and return a watcher of the given type.
59 102
60Examples: 103Examples:
61 104
… …
64 107
65=cut 108=cut
66 109
67=item $w->next 110=item $w->next
68 111
69Return 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.
70 116
71=cut 117=cut
72 118
73=item do_flavour(args...) 119=item do_flavour args...
74 120
75Create 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
76method. This is less efficient then calling the constructor once and the 124This is less efficient then calling the constructor once and the next
77next method often, but it does save typing sometimes. 125method often, but it does save typing sometimes.
78 126
79=cut 127=cut
80
81#Event->add_hooks(prepare => sub {
82# &Coro::cede while &Coro::nready;
83# 1e6;
84#});
85
86sub 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";
133 my $type = $flavour eq "io" ? 1 : 0;
102 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour"); 134 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
103 my $coronew = sub { 135 my $coronew = sub {
104 # how does one do method-call-by-name? 136 # how does one do method-call-by-name?
105 # my $w = $class->SUPER::$flavour(@_); 137 # my $w = $class->SUPER::$flavour(@_);
106 138
107 $_[0] eq Coro::Event:: 139 shift eq Coro::Event::
108 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";
109 141
110 my $q = []; # [$coro, $event]
111 my $w = $new->( 142 my $w = $new->($class,
112 desc => $flavour, 143 desc => $flavour,
113 @_, 144 @_,
114 cb => \&std_cb, 145 parked => 1,
115 ); 146 );
116 $w->private($q); # using private as attribute is pretty useless... 147
117 bless $w, $class; # reblessing due to broken Event 148 _install_std_cb $w, $type;
149
150 # reblessing due to Event being broken
151 bless $w, $class
118 }; 152 };
119 *{ $flavour } = $coronew; 153 *{ $flavour } = $coronew;
120 *{"do_$flavour"} = sub { 154 *{"do_$flavour"} = sub {
121 unshift @_, Coro::Event::; 155 unshift @_, Coro::Event::;
122 my $e = (&$coronew)->next; 156 @_ = &$coronew;
157 &Coro::schedule while &_next;
123 $e->w->cancel; 158 $_[0]->cancel;
124 $e; 159 &_event
125 }; 160 };
126} 161}
127 162
163# do schedule in perl to avoid forcing a stack allocation.
164# this is about 10% slower, though.
128sub next { 165sub next($) {
129 my $w = $_[0]; 166 &Coro::schedule while &_next;
130 my $q = $w->private; 167
131 if ($q->[1]) { # event waiting? 168 &_event
132 $w->again unless $w->is_cancelled;
133 } elsif ($q->[0]) {
134 croak "only one coroutine can wait for an event";
135 } else {
136 local $q->[0] = $Coro::current;
137 &Coro::schedule;
138 }
139 pop @$q;
140} 169}
170
171sub Coro::Event::Event::hits { $_[0][3] }
172sub Coro::Event::Event::got { $_[0][4] }
141 173
142=item sweep 174=item sweep
143 175
144Similar 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
145(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
… …
151into the Event dispatcher. 183into the Event dispatcher.
152 184
153=cut 185=cut
154 186
155sub sweep { 187sub sweep {
156 one_event(0); # for now 188 Event::one_event 0; # for now
157} 189}
158 190
159=item $result = loop([$timeout]) 191=item $result = loop([$timeout])
160 192
161This 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>
162when using this module - it will ensure correct scheduling in the presence 194when using this module - it will ensure correct scheduling in the presence
163of events. 195of events.
164 196
165=begin comment
166
167Unlike loop's counterpart it is not an error when no watchers are active -
168loop silently returns in this case, as if unloop(undef) were called.
169
170=end comment
171
172=cut
173
174sub loop(;$) {
175 local $Coro::idle = $Coro::current;
176 Coro::schedule; # become idle task, which is implicitly ready
177 &Event::loop;
178}
179
180=item unloop([$result]) 197=item unloop([$result])
181 198
182Same as Event::unloop (provided here for your convinience only). 199Same as Event::unloop (provided here for your convinience only).
183 200
184=cut 201=cut
185 202
186$Coro::idle = new Coro sub { 203$Coro::idle = \&Event::one_event; # inefficient
187 while () {
188 Event::one_event; # inefficient
189 Coro::schedule;
190 }
191};
192 204
1931; 2051;
194 206
207=back
208
195=head1 AUTHOR 209=head1 AUTHOR
196 210
197 Marc Lehmann <pcg@goof.com> 211 Marc Lehmann <schmorp@schmorp.de>
198 http://www.goof.com/pcg/marc/ 212 http://home.schmorp.de/
199 213
200=cut 214=cut
201 215

Diff Legend

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