Coro/Coro.pm

=head1 NAME

Coro - create and manage simple coroutines

=head1 SYNOPSIS

 use Coro;

 $new = new Coro sub {
    print "in coroutine, switching back\n";
    $new->transfer($main);
    print "in coroutine again, switching back\n";
    $new->transfer($main);
 };

 $main = new Coro;

 print "in main, switching to coroutine\n";
 $main->transfer($new);
 print "back in main, switch to coroutine again\n";
 $main->transfer($new);
 print "back in main\n";

=head1 DESCRIPTION

This module implements coroutines. Coroutines, similar to continuations,
allow you to run more than one "thread of execution" in parallel. Unlike
threads this, only voluntary switching is used so locking problems are
greatly reduced.

Although this is the "main" module of the Coro family it provides only
low-level functionality. See L<Coro::Process> and related modules for a
more useful process abstraction including scheduling.

=over 4

=cut

package Coro;

BEGIN {
   $VERSION = 0.03;

   require XSLoader;
   XSLoader::load Coro, $VERSION;
}

=item $coro = new [$coderef [, @args]]

Create a new coroutine and return it. The first C<transfer> call to this
coroutine will start execution at the given coderef. If, the subroutine
returns it will be executed again.

If the coderef is omitted this function will create a new "empty"
coroutine, i.e. a coroutine that cannot be transfered to but can be used
to save the current coroutine in.

=cut

sub new {
   my $class = $_[0];
   my $proc = $_[1] || sub { die "tried to transfer to an empty coroutine" };
   bless _newprocess {
      do {
         eval { &$proc };
         if ($@) {
            $error_msg  = $@;
            $error_coro = _newprocess { };
            &transfer($error_coro, $error);
         }
      } while (1);
   }, $class;
}

=item $prev->transfer($next)

Save the state of the current subroutine in $prev and switch to the
coroutine saved in $next.

=cut

# I call the _transfer function from a perl function
# because that way perl saves all important things on
# the stack.
sub transfer {
   _transfer($_[0], $_[1]);
}

=item $error, $error_msg, $error_coro

This coroutine will be called on fatal errors. C<$error_msg> and
C<$error_coro> return the error message and the error-causing coroutine
(NOT an object) respectively. This API might change.

=cut

$error_msg =
$error_coro = undef;

$error = _newprocess {
   print STDERR "FATAL: $error_msg\nprogram aborted\n";
   exit 50;
};

1;

=back

=head1 BUGS

This module has not yet been extensively tested.

=head1 SEE ALSO

L<Coro::Process>, L<Coro::Signal>.

=head1 AUTHOR

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

=cut

Revision:	1.6
Committed:	Tue Jul 10 21:19:47 2001 UTC (22 years, 10 months ago) by root
Branch:	MAIN
Changes since 1.5:	+42 -52 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	=head1 NAME
2
3	root	1.6	Coro - create and manage simple coroutines
4	root	1.1
5			=head1 SYNOPSIS
6
7			use Coro;
8
9	root	1.2	$new = new Coro sub {
10			print "in coroutine, switching back\n";
11	root	1.6	$new->transfer($main);
12	root	1.2	print "in coroutine again, switching back\n";
13	root	1.6	$new->transfer($main);
14	root	1.2	};
15
16	root	1.6	$main = new Coro;
17
18	root	1.2	print "in main, switching to coroutine\n";
19	root	1.6	$main->transfer($new);
20	root	1.2	print "back in main, switch to coroutine again\n";
21	root	1.6	$main->transfer($new);
22	root	1.2	print "back in main\n";
23
24	root	1.1	=head1 DESCRIPTION
25
26	root	1.2	This module implements coroutines. Coroutines, similar to continuations,
27			allow you to run more than one "thread of execution" in parallel. Unlike
28			threads this, only voluntary switching is used so locking problems are
29			greatly reduced.
30
31			Although this is the "main" module of the Coro family it provides only
32			low-level functionality. See L<Coro::Process> and related modules for a
33			more useful process abstraction including scheduling.
34
35	root	1.1	=over 4
36
37			=cut
38
39			package Coro;
40
41			BEGIN {
42	root	1.5	$VERSION = 0.03;
43	root	1.1
44			require XSLoader;
45			XSLoader::load Coro, $VERSION;
46			}
47
48	root	1.6	=item $coro = new [$coderef [, @args]]
49	root	1.1
50	root	1.6	Create a new coroutine and return it. The first C<transfer> call to this
51			coroutine will start execution at the given coderef. If, the subroutine
52			returns it will be executed again.
53
54			If the coderef is omitted this function will create a new "empty"
55			coroutine, i.e. a coroutine that cannot be transfered to but can be used
56			to save the current coroutine in.
57	root	1.1
58			=cut
59
60			sub new {
61			my $class = $_[0];
62	root	1.6	my $proc = $_[1] \|\| sub { die "tried to transfer to an empty coroutine" };
63	root	1.1	bless _newprocess {
64			do {
65	root	1.6	eval { &$proc };
66	root	1.1	if ($@) {
67	root	1.6	$error_msg = $@;
68			$error_coro = _newprocess { };
69			&transfer($error_coro, $error);
70	root	1.1	}
71	root	1.4	} while (1);
72	root	1.1	}, $class;
73			}
74
75	root	1.6	=item $prev->transfer($next)
76	root	1.1
77	root	1.6	Save the state of the current subroutine in $prev and switch to the
78			coroutine saved in $next.
79	root	1.1
80			=cut
81
82	root	1.6	# I call the _transfer function from a perl function
83	root	1.5	# because that way perl saves all important things on
84			# the stack.
85	root	1.6	sub transfer {
86			_transfer($_[0], $_[1]);
87	root	1.1	}
88	root	1.6
89			=item $error, $error_msg, $error_coro
90
91			This coroutine will be called on fatal errors. C<$error_msg> and
92			C<$error_coro> return the error message and the error-causing coroutine
93			(NOT an object) respectively. This API might change.
94
95			=cut
96
97			$error_msg =
98			$error_coro = undef;
99
100			$error = _newprocess {
101			print STDERR "FATAL: $error_msg\nprogram aborted\n";
102			exit 50;
103			};
104	root	1.1
105			1;
106
107			=back
108
109			=head1 BUGS
110
111			This module has not yet been extensively tested.
112	root	1.2
113			=head1 SEE ALSO
114
115			L<Coro::Process>, L<Coro::Signal>.
116	root	1.1
117			=head1 AUTHOR
118
119			Marc Lehmann <pcg@goof.com>
120			http://www.goof.com/pcg/marc/
121
122			=cut
123