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.42 by root, Fri Dec 1 02:24:46 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
52@EXPORT = qw(loop unloop sweep); 71use base Exporter::;
53 72
54$VERSION = 0.45; 73our @EXPORT = qw(loop unloop sweep);
55 74
75BEGIN {
76 our $VERSION = 1.9;
77
78 local $^W = 0; # avoid redefine warning for Coro::ready;
79 XSLoader::load __PACKAGE__, $VERSION;
80}
81
56=item $w = Coro::Event->flavour(args...) 82=item $w = Coro::Event->flavour (args...)
57 83
58Create and return a watcher of the given type. 84Create and return a watcher of the given type.
59 85
60Examples: 86Examples:
61 87
… …
68 94
69Return the next event of the event queue of the watcher. 95Return the next event of the event queue of the watcher.
70 96
71=cut 97=cut
72 98
73=item do_flavour(args...) 99=item do_flavour args...
74 100
75Create 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
76method. This is less efficient then calling the constructor once and the 102method. This is less efficient then calling the constructor once and the
77next method often, but it does save typing sometimes. 103next method often, but it does save typing sometimes.
78 104
79=cut 105=cut
80 106
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
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";
111 my $type = $flavour eq "io" ? 1 : 0;
102 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour"); 112 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
103 my $coronew = sub { 113 my $coronew = sub {
104 # how does one do method-call-by-name? 114 # how does one do method-call-by-name?
105 # my $w = $class->SUPER::$flavour(@_); 115 # my $w = $class->SUPER::$flavour(@_);
106 116
107 $_[0] eq Coro::Event:: 117 shift eq Coro::Event::
108 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";
109 119
110 my $q = []; # [$coro, $event]
111 my $w = $new->( 120 my $w = $new->($class,
112 desc => $flavour, 121 desc => $flavour,
113 @_, 122 @_,
114 cb => \&std_cb, 123 parked => 1,
115 ); 124 );
116 $w->private($q); # using private as attribute is pretty useless... 125 _install_std_cb($w, $type);
117 bless $w, $class; # reblessing due to broken Event 126 bless $w, $class; # reblessing due to broken Event
118 }; 127 };
119 *{ $flavour } = $coronew; 128 *{ $flavour } = $coronew;
120 *{"do_$flavour"} = sub { 129 *{"do_$flavour"} = sub {
121 unshift @_, Coro::Event::; 130 unshift @_, Coro::Event::;
122 my $e = (&$coronew)->next; 131 my $e = (&$coronew)->next;
123 $e->w->cancel; 132 $e->cancel; # $e === $e->w
124 $e; 133 $e;
125 }; 134 };
126} 135}
127 136
137# double calls to avoid stack-cloning ;()
138# is about 10% slower, though.
128sub next { 139sub next($) {
129 my $w = $_[0]; 140 &Coro::schedule while &_next;
130 my $q = $w->private; 141
131 if ($q->[1]) { # event waiting? 142 $_[0]
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} 143}
144
145sub Coro::Event::w { $_[0] }
146sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
147sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
148sub Coro::Event::got { $_[0]{Coro::Event}[5] }
141 149
142=item sweep 150=item sweep
143 151
144Similar to Event::one_event and Event::sweep: The idle task is called once 152Similar 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 153(this has the effect of jumping back into the Event loop once to serve new
… …
151into the Event dispatcher. 159into the Event dispatcher.
152 160
153=cut 161=cut
154 162
155sub sweep { 163sub sweep {
156 one_event(0); # for now 164 Event::one_event 0; # for now
157} 165}
158 166
159=item $result = loop([$timeout]) 167=item $result = loop([$timeout])
160 168
161This is the version of C<loop> you should use instead of C<Event::loop> 169This 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 170when using this module - it will ensure correct scheduling in the presence
163of events. 171of events.
164 172
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]) 173=item unloop([$result])
181 174
182Same as Event::unloop (provided here for your convinience only). 175Same as Event::unloop (provided here for your convinience only).
183 176
184=cut 177=cut
185 178
186$Coro::idle = new Coro sub { 179$Coro::idle = \&Event::one_event; # inefficient
187 while () {
188 Event::one_event; # inefficient
189 Coro::schedule;
190 }
191};
192 180
1931; 1811;
194 182
183=back
184
195=head1 AUTHOR 185=head1 AUTHOR
196 186
197 Marc Lehmann <pcg@goof.com> 187 Marc Lehmann <schmorp@schmorp.de>
198 http://www.goof.com/pcg/marc/ 188 http://home.schmorp.de/
199 189
200=cut 190=cut
201 191

Diff Legend

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