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.6 by root, Mon Sep 24 01:36:20 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 qw(uninitialized); 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 reschedule); 73our @EXPORT = qw(loop unloop sweep);
53 74
54BEGIN { 75BEGIN {
55 $VERSION = 0.45; 76 our $VERSION = 1.9;
56 77
57 local $^W = 0; # avoid redefine warning for Coro::ready 78 local $^W = 0; # avoid redefine warning for Coro::ready;
58 require XSLoader;
59 XSLoader::load Coro::Event, $VERSION; 79 XSLoader::load __PACKAGE__, $VERSION;
60} 80}
61 81
62=item $w = Coro::Event->flavour(args...) 82=item $w = Coro::Event->flavour (args...)
63 83
64Create and return a watcher of the given type. 84Create and return a watcher of the given type.
65 85
66Examples: 86Examples:
67 87
… …
74 94
75Return the next event of the event queue of the watcher. 95Return the next event of the event queue of the watcher.
76 96
77=cut 97=cut
78 98
79=item do_flavour(args...) 99=item do_flavour args...
80 100
81Create 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
82method. This is less efficient then calling the constructor once and the 102method. This is less efficient then calling the constructor once and the
83next method often, but it does save typing sometimes. 103next method often, but it does save typing sometimes.
84 104
… …
92 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour"); 112 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
93 my $coronew = sub { 113 my $coronew = sub {
94 # how does one do method-call-by-name? 114 # how does one do method-call-by-name?
95 # my $w = $class->SUPER::$flavour(@_); 115 # my $w = $class->SUPER::$flavour(@_);
96 116
97 $_[0] eq Coro::Event:: 117 shift eq Coro::Event::
98 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";
99 119
100 my $q = []; # [$coro, $event]
101 my $w = $new->( 120 my $w = $new->($class,
102 desc => $flavour, 121 desc => $flavour,
103 @_, 122 @_,
104 parked => 1, 123 parked => 1,
105 ); 124 );
106 _install_std_cb($w, $type); 125 _install_std_cb($w, $type);
… …
108 }; 127 };
109 *{ $flavour } = $coronew; 128 *{ $flavour } = $coronew;
110 *{"do_$flavour"} = sub { 129 *{"do_$flavour"} = sub {
111 unshift @_, Coro::Event::; 130 unshift @_, Coro::Event::;
112 my $e = (&$coronew)->next; 131 my $e = (&$coronew)->next;
113 $e->cancel; # $e = $e->w 132 $e->cancel; # $e === $e->w
114 $e; 133 $e;
115 }; 134 };
116} 135}
117 136
118# double calls to avoid stack-cloning ;() 137# double calls to avoid stack-cloning ;()
119# is about 10% slower, though. 138# is about 10% slower, though.
120sub next($) { 139sub next($) {
121 &Coro::schedule if &_next; $_[0]; 140 &Coro::schedule while &_next;
141
142 $_[0]
122} 143}
123 144
124sub Coro::Event::w { $_[0] } 145sub Coro::Event::w { $_[0] }
125sub Coro::Event::prio { $_[0]{Coro::Event}[3] } 146sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
126sub Coro::Event::hits { $_[0]{Coro::Event}[4] } 147sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
… …
138into the Event dispatcher. 159into the Event dispatcher.
139 160
140=cut 161=cut
141 162
142sub sweep { 163sub sweep {
143 one_event(0); # for now 164 Event::one_event 0; # for now
144} 165}
145 166
146=item $result = loop([$timeout]) 167=item $result = loop([$timeout])
147 168
148This 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>
149when using this module - it will ensure correct scheduling in the presence 170when using this module - it will ensure correct scheduling in the presence
150of events. 171of events.
151 172
152=begin comment
153
154Unlike loop's counterpart it is not an error when no watchers are active -
155loop silently returns in this case, as if unloop(undef) were called.
156
157=end comment
158
159=cut
160
161sub loop(;$) {
162 local $Coro::idle = $Coro::current;
163 Coro::schedule; # become idle task, which is implicitly ready
164 &Event::loop;
165}
166
167=item unloop([$result]) 173=item unloop([$result])
168 174
169Same as Event::unloop (provided here for your convinience only). 175Same as Event::unloop (provided here for your convinience only).
170 176
171=cut 177=cut
172 178
173$Coro::idle = new Coro sub { 179$Coro::idle = \&Event::one_event; # inefficient
174 while () {
175 Event::one_event; # inefficient
176 Coro::schedule;
177 }
178};
179 180
1801; 1811;
181 182
183=back
184
182=head1 AUTHOR 185=head1 AUTHOR
183 186
184 Marc Lehmann <pcg@goof.com> 187 Marc Lehmann <schmorp@schmorp.de>
185 http://www.goof.com/pcg/marc/ 188 http://home.schmorp.de/
186 189
187=cut 190=cut
188 191

Diff Legend

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