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.5 by root, Sat Aug 18 02:58:38 2001 UTC vs.
Revision 1.44 by root, Fri Dec 1 20:49:54 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
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 require XSLoader; 78 local $^W = 0; # avoid redefine warning for Coro::ready;
58 XSLoader::load Coro::Event, $VERSION; 79 XSLoader::load __PACKAGE__, $VERSION;
59} 80}
60 81
61=item $w = Coro::Event->flavour(args...) 82=item $w = Coro::Event->flavour (args...)
62 83
63Create and return a watcher of the given type. 84Create and return a watcher of the given type.
64 85
65Examples: 86Examples:
66 87
… …
73 94
74Return the next event of the event queue of the watcher. 95Return the next event of the event queue of the watcher.
75 96
76=cut 97=cut
77 98
78=item do_flavour(args...) 99=item do_flavour args...
79 100
80Create 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
81method. This is less efficient then calling the constructor once and the 102method. This is less efficient then calling the constructor once and the
82next method often, but it does save typing sometimes. 103next method often, but it does save typing sometimes.
83 104
… …
91 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour"); 112 @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
92 my $coronew = sub { 113 my $coronew = sub {
93 # how does one do method-call-by-name? 114 # how does one do method-call-by-name?
94 # my $w = $class->SUPER::$flavour(@_); 115 # my $w = $class->SUPER::$flavour(@_);
95 116
96 $_[0] eq Coro::Event:: 117 shift eq Coro::Event::
97 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";
98 119
99 my $q = []; # [$coro, $event]
100 my $w = $new->( 120 my $w = $new->($class,
101 desc => $flavour, 121 desc => $flavour,
102 @_, 122 @_,
103 parked => 1, 123 parked => 1,
104 ); 124 );
125
105 _install_std_cb($w, $type); 126 _install_std_cb $w, $type;
106 bless $w, $class; # reblessing due to broken Event 127
128 # reblessing due to Event being broken
129 bless $w, $class
107 }; 130 };
108 *{ $flavour } = $coronew; 131 *{ $flavour } = $coronew;
109 *{"do_$flavour"} = sub { 132 *{"do_$flavour"} = sub {
110 unshift @_, Coro::Event::; 133 unshift @_, Coro::Event::;
111 my $e = (&$coronew)->next; 134 @_ = &$coronew;
112 $e->cancel; # $e = $e->w 135 &Coro::schedule while &_next;
113 $e; 136 $_[0]->cancel;
137 &_event
114 }; 138 };
115} 139}
116 140
117# double calls to avoid stack-cloning ;() 141# do schedule in perl to avoid forcing a stack allocation.
118# is about 10% slower, though. 142# this is about 10% slower, though.
119sub next($) { 143sub next($) {
120 &Coro::schedule if &_next; $_[0]; 144 &Coro::schedule while &_next;
145
146 &_event
121} 147}
122 148
123sub Coro::Event::w { $_[0] } 149sub Coro::Event::w { $_[0] }
124sub Coro::Event::prio { $_[0]{Coro::Event}[3] } 150sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
125sub Coro::Event::hits { $_[0]{Coro::Event}[4] } 151sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
… …
137into the Event dispatcher. 163into the Event dispatcher.
138 164
139=cut 165=cut
140 166
141sub sweep { 167sub sweep {
142 one_event(0); # for now 168 Event::one_event 0; # for now
143} 169}
144 170
145=item $result = loop([$timeout]) 171=item $result = loop([$timeout])
146 172
147This is the version of C<loop> you should use instead of C<Event::loop> 173This 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 174when using this module - it will ensure correct scheduling in the presence
149of events. 175of events.
150 176
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
160sub loop(;$) {
161 local $Coro::idle = $Coro::current;
162 Coro::schedule; # become idle task, which is implicitly ready
163 &Event::loop;
164}
165
166=item unloop([$result]) 177=item unloop([$result])
167 178
168Same as Event::unloop (provided here for your convinience only). 179Same as Event::unloop (provided here for your convinience only).
169 180
170=cut 181=cut
171 182
172$Coro::idle = new Coro sub { 183$Coro::idle = \&Event::one_event; # inefficient
173 while () {
174 Event::one_event; # inefficient
175 Coro::schedule;
176 }
177};
178 184
1791; 1851;
180 186
187=back
188
181=head1 AUTHOR 189=head1 AUTHOR
182 190
183 Marc Lehmann <pcg@goof.com> 191 Marc Lehmann <schmorp@schmorp.de>
184 http://www.goof.com/pcg/marc/ 192 http://home.schmorp.de/
185 193
186=cut 194=cut
187 195

Diff Legend

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