Coro/EV/EV.pm

=head1 NAME

Coro::EV - do events the coro-way

=head1 SYNOPSIS

 use Coro;
 use Coro::EV;

 EV::loop;

=head1 DESCRIPTION

This module does two things: First, it offers some utility functions that
might be useful for coroutines, and secondly, it integrates Coro into the
EV main loop:

Before the process blocks (in EV::loop) to wait for events, this module
will schedule and run all ready (= runnable) coroutines of the same or
higher priority. After that, it will cede once to a coroutine of lower
priority, then continue in the event loop.

That means that coroutines with the same or higher pripority as the
coroutine running the main loop will inhibit event processing, while
coroutines of lower priority will get the CPU, but cannot completeley
inhibit event processing.

=head2 RUNNING WITH OR WITHOUT A MAINLOOP

In general, you should always run EV::loop, either in your main program,
or in a separate coroutine. If you don't do that and all coroutines start
waiting for some events, this module will run the event loop once, but
this is very inefficient.

=head1 FUNCTIONS

=over 4

=cut

package Coro::EV;

no warnings;

use Carp;
no warnings;

use Coro;
use Coro::Timer;

use EV ();
use XSLoader;

BEGIN {
   our $VERSION = '2.1';

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

unshift @AnyEvent::REGISTRY, [Coro::EV => "EV::AnyEvent"];

# relatively inefficient
our $ev_idle = new Coro sub {
   while () {
      EV::loop EV::LOOP_ONESHOT;
      &Coro::schedule;
   }
};
$ev->{desc} = "[EV idle process]";

$Coro::idle = sub { $ev_idle->ready };

=item $revents = Coro::EV::timed_io_once $fd, $events, $timeout

Blocks the coroutine until either the given event set has occured on the
fd, or the timeout has been reached (if timeout is zero, there is no
timeout). Returns the received flags.

=cut

sub timed_io_once($$;$) {
   &_timed_io_once;
   do { &Coro::schedule } while !$#_;
   pop
}

=item Coro::EV::timer_once $after

Blocks the coroutine for at least C<$after> seconds.

=cut

sub timer_once($) {
   &_timer_once;
   do { &Coro::schedule } while !$#_;
   pop
}

1;

=back

=head1 AUTHOR

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut

Revision:	1.5
Committed:	Thu Nov 1 08:28:58 2007 UTC (16 years, 7 months ago) by root
Branch:	MAIN
Changes since 1.4:	+11 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	=head1 NAME
2
3			Coro::EV - do events the coro-way
4
5			=head1 SYNOPSIS
6
7			use Coro;
8			use Coro::EV;
9
10	root	1.5	EV::loop;
11
12	root	1.4	=head1 DESCRIPTION
13	root	1.1
14	root	1.4	This module does two things: First, it offers some utility functions that
15			might be useful for coroutines, and secondly, it integrates Coro into the
16			EV main loop:
17
18			Before the process blocks (in EV::loop) to wait for events, this module
19			will schedule and run all ready (= runnable) coroutines of the same or
20			higher priority. After that, it will cede once to a coroutine of lower
21			priority, then continue in the event loop.
22
23			That means that coroutines with the same or higher pripority as the
24			coroutine running the main loop will inhibit event processing, while
25			coroutines of lower priority will get the CPU, but cannot completeley
26			inhibit event processing.
27	root	1.1
28	root	1.5	=head2 RUNNING WITH OR WITHOUT A MAINLOOP
29
30			In general, you should always run EV::loop, either in your main program,
31			or in a separate coroutine. If you don't do that and all coroutines start
32			waiting for some events, this module will run the event loop once, but
33			this is very inefficient.
34
35	root	1.1	=head1 FUNCTIONS
36
37			=over 4
38
39			=cut
40
41			package Coro::EV;
42
43			no warnings;
44
45			use Carp;
46			no warnings;
47
48			use Coro;
49			use Coro::Timer;
50
51			use EV ();
52			use XSLoader;
53
54			BEGIN {
55			our $VERSION = '2.1';
56
57			local $^W = 0; # avoid redefine warning for Coro::ready;
58			XSLoader::load __PACKAGE__, $VERSION;
59			}
60
61	root	1.5	unshift @AnyEvent::REGISTRY, [Coro::EV => "EV::AnyEvent"];
62
63	root	1.1	# relatively inefficient
64			our $ev_idle = new Coro sub {
65			while () {
66			EV::loop EV::LOOP_ONESHOT;
67			&Coro::schedule;
68			}
69			};
70			$ev->{desc} = "[EV idle process]";
71
72			$Coro::idle = sub { $ev_idle->ready };
73
74	root	1.3	=item $revents = Coro::EV::timed_io_once $fd, $events, $timeout
75
76			Blocks the coroutine until either the given event set has occured on the
77			fd, or the timeout has been reached (if timeout is zero, there is no
78			timeout). Returns the received flags.
79
80			=cut
81
82	root	1.1	sub timed_io_once($$;$) {
83			&_timed_io_once;
84			do { &Coro::schedule } while !$#_;
85			pop
86			}
87
88	root	1.3	=item Coro::EV::timer_once $after
89
90			Blocks the coroutine for at least C<$after> seconds.
91
92			=cut
93
94	root	1.1	sub timer_once($) {
95			&_timer_once;
96			do { &Coro::schedule } while !$#_;
97			pop
98			}
99
100			1;
101
102			=back
103
104			=head1 AUTHOR
105
106			Marc Lehmann <schmorp@schmorp.de>
107			http://home.schmorp.de/
108
109			=cut
110