Coro/Event/Event.pm

=head1 NAME

Coro::Event - do events the coro-way

=head1 SYNOPSIS

 use Coro;
 use Coro::Event;

 sub keyboard : Coro {
    my $w = Coro::Event->io(fd => *STDIN, poll => 'r');
    while() {
       print "cmd> ";
       my $ev = $w->next; my $cmd = <STDIN>;
       unloop unless $cmd ne "";
       print "data> ";
       my $ev = $w->next; my $data = <STDIN>;
    }
 }

 loop;

=head1 DESCRIPTION

This module enables you to create programs using the powerful Event model
(and module), while retaining the linear style known from simple or
threaded programs.

This module provides a method and a function for every watcher type
(I<flavour>) (see L<Event>). The only difference between these and the
watcher constructors from Event is that you do not specify a callback
function - it will be managed by this module.

Your application should just create all necessary coroutines and then call
Coro::Event::loop.

=over 4

=cut

package Coro::Event;

no warnings qw(uninitialized);

use Carp;

use Coro;
use Event qw(loop unloop); # we are re-exporting this, cooool!

use base 'Exporter';

@EXPORT = qw(loop unloop sweep reschedule);

BEGIN {
   $VERSION = 0.6;

   local $^W = 0; # avoid redefine warning for Coro::ready;
   require XSLoader;
   XSLoader::load Coro::Event, $VERSION;
}

=item $w = Coro::Event->flavour(args...)

Create and return a watcher of the given type.

Examples:

  my $reader = Coro::Event->io(fd => $filehandle, poll => 'r');
  $reader->next;

=cut

=item $w->next

Return the next event of the event queue of the watcher.

=cut

=item do_flavour(args...)

Create a watcher of the given type and immediately call it's next
method. This is less efficient then calling the constructor once and the
next method often, but it does save typing sometimes.

=cut

for my $flavour (qw(idle var timer io signal)) {
   push @EXPORT, "do_$flavour";
   my $new = \&{"Event::$flavour"};
   my $class = "Coro::Event::$flavour";
   my $type = $flavour eq "io" ? 1 : 0;
   @{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
   my $coronew = sub {
      # how does one do method-call-by-name?
      # my $w = $class->SUPER::$flavour(@_);

      shift eq Coro::Event::
         or croak "event constructor \"Coro::Event->$flavour\" must be called as a static method";

      my $w = $new->($class,
            desc => $flavour,
            @_,
            parked => 1,
      );
      _install_std_cb($w, $type);
      bless $w, $class; # reblessing due to broken Event
   };
   *{    $flavour } = $coronew;
   *{"do_$flavour"} = sub {
      unshift @_, Coro::Event::;
      my $e = (&$coronew)->next;
      $e->cancel; # $e = $e->w->cancel ($e == $e->w!)
      $e;
   };
}

# double calls to avoid stack-cloning ;()
# is about 10% slower, though.
sub next($) {
   &Coro::schedule if &_next; $_[0];
}

sub Coro::Event::w    { $_[0] }
sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
sub Coro::Event::got  { $_[0]{Coro::Event}[5] }

=item sweep

Similar to Event::one_event and Event::sweep: The idle task is called once
(this has the effect of jumping back into the Event loop once to serve new
events).

The reason this function exists is that you sometimes want to serve events
while doing other work. Calling C<Coro::cede> does not work because
C<cede> implies that the current coroutine is runnable and does not call
into the Event dispatcher.

=cut

sub sweep {
   Event::one_event(0); # for now
}

=item $result = loop([$timeout])

This is the version of C<loop> you should use instead of C<Event::loop>
when using this module - it will ensure correct scheduling in the presence
of events.

=begin comment

Unlike loop's counterpart it is not an error when no watchers are active -
loop silently returns in this case, as if unloop(undef) were called.

=end comment

=cut

# no longer do something special - it's done internally now

#sub loop(;$) {
#   #local $Coro::idle = $Coro::current;
#   #Coro::schedule; # become idle task, which is implicitly ready
#   &Event::loop;
#}

=item unloop([$result])

Same as Event::unloop (provided here for your convinience only).

=cut

$Coro::idle = new Coro sub {
   while () {
      Event::one_event; # inefficient
      Coro::schedule;
   }
};

# provide hooks for Coro::Timer

package Coro::Timer;

unless ($override) {
   $override = 1;
   *_new_timer = sub {
      Event->timer(at => $_[0], cb => $_[1]);
   };
}

1;

=head1 AUTHOR

 Marc Lehmann <pcg@goof.com>
 http://www.goof.com/pcg/marc/

=cut

Revision:	1.13
Committed:	Sat Mar 22 18:50:32 2003 UTC (21 years, 2 months ago) by root
Branch:	MAIN
Changes since 1.12:	+1 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	=head1 NAME
2
3			Coro::Event - do events the coro-way
4
5			=head1 SYNOPSIS
6
7			use Coro;
8			use Coro::Event;
9
10			sub keyboard : Coro {
11			my $w = Coro::Event->io(fd => *STDIN, poll => 'r');
12			while() {
13			print "cmd> ";
14			my $ev = $w->next; my $cmd = <STDIN>;
15			unloop unless $cmd ne "";
16			print "data> ";
17			my $ev = $w->next; my $data = <STDIN>;
18			}
19			}
20
21	root	1.8	loop;
22	root	1.1
23			=head1 DESCRIPTION
24
25			This module enables you to create programs using the powerful Event model
26			(and module), while retaining the linear style known from simple or
27			threaded programs.
28
29			This module provides a method and a function for every watcher type
30			(I<flavour>) (see L<Event>). The only difference between these and the
31			watcher constructors from Event is that you do not specify a callback
32			function - it will be managed by this module.
33
34			Your application should just create all necessary coroutines and then call
35	root	1.12	Coro::Event::loop.
36	root	1.1
37			=over 4
38
39			=cut
40
41			package Coro::Event;
42
43	root	1.6	no warnings qw(uninitialized);
44	root	1.1
45			use Carp;
46
47			use Coro;
48	root	1.8	use Event qw(loop unloop); # we are re-exporting this, cooool!
49	root	1.1
50			use base 'Exporter';
51
52	root	1.5	@EXPORT = qw(loop unloop sweep reschedule);
53	root	1.1
54	root	1.2	BEGIN {
55	root	1.11	$VERSION = 0.6;
56	root	1.2
57	root	1.13	local $^W = 0; # avoid redefine warning for Coro::ready;
58	root	1.2	require XSLoader;
59			XSLoader::load Coro::Event, $VERSION;
60			}
61	root	1.1
62			=item $w = Coro::Event->flavour(args...)
63
64			Create and return a watcher of the given type.
65
66			Examples:
67
68			my $reader = Coro::Event->io(fd => $filehandle, poll => 'r');
69			$reader->next;
70
71			=cut
72
73			=item $w->next
74
75			Return the next event of the event queue of the watcher.
76
77			=cut
78
79			=item do_flavour(args...)
80
81			Create a watcher of the given type and immediately call it's next
82			method. This is less efficient then calling the constructor once and the
83			next method often, but it does save typing sometimes.
84
85			=cut
86
87			for my $flavour (qw(idle var timer io signal)) {
88			push @EXPORT, "do_$flavour";
89			my $new = \&{"Event::$flavour"};
90			my $class = "Coro::Event::$flavour";
91	root	1.2	my $type = $flavour eq "io" ? 1 : 0;
92	root	1.1	@{"${class}::ISA"} = (Coro::Event::, "Event::$flavour");
93			my $coronew = sub {
94			# how does one do method-call-by-name?
95			# my $w = $class->SUPER::$flavour(@_);
96
97	root	1.10	shift eq Coro::Event::
98	root	1.1	or croak "event constructor \"Coro::Event->$flavour\" must be called as a static method";
99
100	root	1.10	my $w = $new->($class,
101	root	1.1	desc => $flavour,
102			@_,
103	root	1.2	parked => 1,
104	root	1.1	);
105	root	1.2	_install_std_cb($w, $type);
106	root	1.1	bless $w, $class; # reblessing due to broken Event
107			};
108			*{ $flavour } = $coronew;
109			*{"do_$flavour"} = sub {
110			unshift @_, Coro::Event::;
111			my $e = (&$coronew)->next;
112	root	1.8	$e->cancel; # $e = $e->w->cancel ($e == $e->w!)
113	root	1.1	$e;
114			};
115			}
116
117	root	1.2	# double calls to avoid stack-cloning ;()
118	root	1.3	# is about 10% slower, though.
119	root	1.2	sub next($) {
120	root	1.3	&Coro::schedule if &_next; $_[0];
121	root	1.1	}
122	root	1.2
123	root	1.4	sub Coro::Event::w { $_[0] }
124	root	1.5	sub Coro::Event::prio { $_[0]{Coro::Event}[3] }
125			sub Coro::Event::hits { $_[0]{Coro::Event}[4] }
126			sub Coro::Event::got { $_[0]{Coro::Event}[5] }
127	root	1.1
128			=item sweep
129
130			Similar 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
132			events).
133
134			The reason this function exists is that you sometimes want to serve events
135			while doing other work. Calling C<Coro::cede> does not work because
136			C<cede> implies that the current coroutine is runnable and does not call
137			into the Event dispatcher.
138
139			=cut
140
141			sub sweep {
142	root	1.7	Event::one_event(0); # for now
143	root	1.1	}
144
145			=item $result = loop([$timeout])
146
147			This is the version of C<loop> you should use instead of C<Event::loop>
148			when using this module - it will ensure correct scheduling in the presence
149			of events.
150
151			=begin comment
152
153			Unlike loop's counterpart it is not an error when no watchers are active -
154			loop silently returns in this case, as if unloop(undef) were called.
155
156			=end comment
157
158			=cut
159
160	root	1.8	# 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	root	1.1
168			=item unloop([$result])
169
170			Same as Event::unloop (provided here for your convinience only).
171
172			=cut
173
174			$Coro::idle = new Coro sub {
175			while () {
176			Event::one_event; # inefficient
177			Coro::schedule;
178			}
179			};
180
181	root	1.9	# provide hooks for Coro::Timer
182
183			package Coro::Timer;
184
185			unless ($override) {
186			$override = 1;
187			*_new_timer = sub {
188			Event->timer(at => $_[0], cb => $_[1]);
189			};
190			}
191
192	root	1.1	1;
193
194			=head1 AUTHOR
195
196			Marc Lehmann <pcg@goof.com>
197			http://www.goof.com/pcg/marc/
198
199			=cut
200