[ViewVC] Diff of: cvs/AnyEvent-MP/MP.pm

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.37 by root, Fri Aug 7 16:47:23 2009 UTC vs.
Revision 1.43 by root, Sun Aug 9 16:08:16 2009 UTC

…		…
8		8
9	$NODE # contains this node's noderef	9	$NODE # contains this node's noderef
10	NODE # returns this node's noderef	10	NODE # returns this node's noderef
11	NODE $port # returns the noderef of the port	11	NODE $port # returns the noderef of the port
12		12
		13	$SELF # receiving/own port id in rcv callbacks
		14
		15	# ports are message endpoints
		16
		17	# sending messages
13	snd $port, type => data...;	18	snd $port, type => data...;
		19	snd $port, @msg;
		20	snd @msg_with_first_element_being_a_port;
14		21
15	$SELF # receiving/own port id in rcv callbacks	22	# miniports
		23	my $miniport = port { my @msg = @_; 0 };
16		24
		25	# full ports
		26	my $port = port;
17	rcv $port, smartmatch => $cb->($port, @msg);	27	rcv $port, smartmatch => $cb->(@msg);
18
19	# examples:
20	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	28	rcv $port, ping => sub { snd $_[0], "pong"; 0 };
21	rcv $port1, pong => sub { warn "pong received\n" };	29	rcv $port, pong => sub { warn "pong received\n"; 0 };
22	snd $port2, ping => $port1;	30
		31	# remote ports
		32	my $port = spawn $node, $initfunc, @initdata;
23		33
24	# more, smarter, matches (_any_ is exported by this module)	34	# more, smarter, matches (_any_ is exported by this module)
25	rcv $port, [child_died => $pid] => sub { ...	35	rcv $port, [child_died => $pid] => sub { ...
26	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	36	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
27		37
…		…
105		115
106	use AE ();	116	use AE ();
107		117
108	use base "Exporter";	118	use base "Exporter";
109		119
110	our $VERSION = '0.1';	120	our $VERSION = $AnyEvent::MP::Base::VERSION;
		121
111	our @EXPORT = qw(	122	our @EXPORT = qw(
112	NODE $NODE *SELF node_of _any_	123	NODE $NODE *SELF node_of _any_
113	resolve_node initialise_node	124	resolve_node initialise_node
114	snd rcv mon kil reg psub	125	snd rcv mon kil reg psub spawn
115	port	126	port
116	);	127	);
117		128
118	our $SELF;	129	our $SELF;
119		130
…		…
340	registered.	351	registered.
341		352
342	The global C<$SELF> (exported by this module) contains C<$port> while	353	The global C<$SELF> (exported by this module) contains C<$port> while
343	executing the callback.	354	executing the callback.
344		355
345	Runtime errors wdurign callback execution will result in the port being	356	Runtime errors during callback execution will result in the port being
346	C<kil>ed.	357	C<kil>ed.
347		358
348	If the match is an array reference, then it will be matched against the	359	If the match is an array reference, then it will be matched against the
349	first elements of the message, otherwise only the first element is being	360	first elements of the message, otherwise only the first element is being
350	matched.	361	matched.
…		…
491		502
492	=item $guard = mon $port	503	=item $guard = mon $port
493		504
494	=item $guard = mon $port, $rcvport, @msg	505	=item $guard = mon $port, $rcvport, @msg
495		506
496	Monitor the given port and do something when the port is killed, and	507	Monitor the given port and do something when the port is killed or
497	optionally return a guard that can be used to stop monitoring again.	508	messages to it were lost, and optionally return a guard that can be used
		509	to stop monitoring again.
		510
		511	C<mon> effectively guarantees that, in the absence of hardware failures,
		512	that after starting the monitor, either all messages sent to the port
		513	will arrive, or the monitoring action will be invoked after possible
		514	message loss has been detected. No messages will be lost "in between"
		515	(after the first lost message no further messages will be received by the
		516	port). After the monitoring action was invoked, further messages might get
		517	delivered again.
498		518
499	In the first form (callback), the callback is simply called with any	519	In the first form (callback), the callback is simply called with any
500	number of C<@reason> elements (no @reason means that the port was deleted	520	number of C<@reason> elements (no @reason means that the port was deleted
501	"normally"). Note also that I<< the callback B<must> never die >>, so use	521	"normally"). Note also that I<< the callback B<must> never die >>, so use
502	C<eval> if unsure.	522	C<eval> if unsure.
503		523
504	In the second form (another port given), the other port (C<$rcvport)	524	In the second form (another port given), the other port (C<$rcvport>)
505	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on	525	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
506	"normal" kils nothing happens, while under all other conditions, the other	526	"normal" kils nothing happens, while under all other conditions, the other
507	port is killed with the same reason.	527	port is killed with the same reason.
508		528
509	The third form (kill self) is the same as the second form, except that	529	The third form (kill self) is the same as the second form, except that
…		…
536	sub mon {	556	sub mon {
537	my ($noderef, $port) = split /#/, shift, 2;	557	my ($noderef, $port) = split /#/, shift, 2;
538		558
539	my $node = $NODE{$noderef} \|\| add_node $noderef;	559	my $node = $NODE{$noderef} \|\| add_node $noderef;
540		560
541	my $cb = @_ ? $_[0] : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';	561	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
542		562
543	unless (ref $cb) {	563	unless (ref $cb) {
544	if (@_) {	564	if (@_) {
545	# send a kill info message	565	# send a kill info message
546	my (@msg) = @_;	566	my (@msg) = ($cb, @_);
547	$cb = sub { snd @msg, @_ };	567	$cb = sub { snd @msg, @_ };
548	} else {	568	} else {
549	# simply kill other port	569	# simply kill other port
550	my $port = $cb;	570	my $port = $cb;
551	$cb = sub { kil $port, @_ if @_ };	571	$cb = sub { kil $port, @_ if @_ };
…		…
598	will be reported as reason C<< die => $@ >>.	618	will be reported as reason C<< die => $@ >>.
599		619
600	Transport/communication errors are reported as C<< transport_error =>	620	Transport/communication errors are reported as C<< transport_error =>
601	$message >>.	621	$message >>.
602		622
		623	=cut
		624
		625	=item $port = spawn $node, $initfunc[, @initdata]
		626
		627	Creates a port on the node C<$node> (which can also be a port ID, in which
		628	case it's the node where that port resides).
		629
		630	The port ID of the newly created port is return immediately, and it is
		631	permissible to immediately start sending messages or monitor the port.
		632
		633	After the port has been created, the init function is
		634	called. This function must be a fully-qualified function name
		635	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
		636	program, use C<::name>.
		637
		638	If the function doesn't exist, then the node tries to C<require>
		639	the package, then the package above the package and so on (e.g.
		640	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		641	exists or it runs out of package names.
		642
		643	The init function is then called with the newly-created port as context
		644	object (C<$SELF>) and the C<@initdata> values as arguments.
		645
		646	A common idiom is to pass your own port, monitor the spawned port, and
		647	in the init function, monitor the original port. This two-way monitoring
		648	ensures that both ports get cleaned up when there is a problem.
		649
		650	Example: spawn a chat server port on C<$othernode>.
		651
		652	# this node, executed from within a port context:
		653	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		654	mon $server;
		655
		656	# init function on C<$othernode>
		657	sub connect {
		658	my ($srcport) = @_;
		659
		660	mon $srcport;
		661
		662	rcv $SELF, sub {
		663	...
		664	};
		665	}
		666
		667	=cut
		668
		669	sub _spawn {
		670	my $port = shift;
		671	my $init = shift;
		672
		673	local $SELF = "$NODE#$port";
		674	eval {
		675	&{ load_func $init }
		676	};
		677	_self_die if $@;
		678	}
		679
		680	sub spawn(@) {
		681	my ($noderef, undef) = split /#/, shift, 2;
		682
		683	my $id = "$RUNIQ." . $ID++;
		684
		685	$_[0] =~ /::/
		686	or Carp::croak "spawn init function must be a fully-qualified name, caught";
		687
		688	($NODE{$noderef} \|\| add_node $noderef)
		689	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
		690
		691	"$noderef#$id"
		692	}
		693
603	=back	694	=back
604		695
605	=head1 NODE MESSAGES	696	=head1 NODE MESSAGES
606		697
607	Nodes understand the following messages sent to them. Many of them take	698	Nodes understand the following messages sent to them. Many of them take

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.37 by root, Fri Aug 7 16:47:23 2009 UTC vs. Revision 1.43 by root, Sun Aug 9 16:08:16 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.37 by root, Fri Aug 7 16:47:23 2009 UTC vs.
Revision 1.43 by root, Sun Aug 9 16:08:16 2009 UTC