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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.35 by root, Thu Aug 6 10:21:48 2009 UTC vs.
Revision 1.47 by root, Thu Aug 13 01:57:10 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
28	# linking two ports, so they both crash together
29	lnk $port1, $port2;
30		37
31	# monitoring	38	# monitoring
32	mon $port, $cb->(@msg) # callback is invoked on death	39	mon $port, $cb->(@msg) # callback is invoked on death
33	mon $port, $otherport # kill otherport on abnormal death	40	mon $port, $otherport # kill otherport on abnormal death
34	mon $port, $otherport, @msg # send message on death	41	mon $port, $otherport, @msg # send message on death
35		42
		43	=head1 CURRENT STATUS
		44
		45	AnyEvent::MP - stable API, should work
		46	AnyEvent::MP::Intro - outdated
		47	AnyEvent::MP::Kernel - WIP
		48	AnyEvent::MP::Transport - mostly stable
		49
		50	stay tuned.
		51
36	=head1 DESCRIPTION	52	=head1 DESCRIPTION
37		53
38	This module (-family) implements a simple message passing framework.	54	This module (-family) implements a simple message passing framework.
39		55
40	Despite its simplicity, you can securely message other processes running	56	Despite its simplicity, you can securely message other processes running
…		…
43	For an introduction to this module family, see the L<AnyEvent::MP::Intro>	59	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
44	manual page.	60	manual page.
45		61
46	At the moment, this module family is severly broken and underdocumented,	62	At the moment, this module family is severly broken and underdocumented,
47	so do not use. This was uploaded mainly to reserve the CPAN namespace -	63	so do not use. This was uploaded mainly to reserve the CPAN namespace -
48	stay tuned! The basic API should be finished, however.	64	stay tuned!
49		65
50	=head1 CONCEPTS	66	=head1 CONCEPTS
51		67
52	=over 4	68	=over 4
53		69
…		…
98		114
99	=cut	115	=cut
100		116
101	package AnyEvent::MP;	117	package AnyEvent::MP;
102		118
103	use AnyEvent::MP::Base;	119	use AnyEvent::MP::Kernel;
104		120
105	use common::sense;	121	use common::sense;
106		122
107	use Carp ();	123	use Carp ();
108		124
109	use AE ();	125	use AE ();
110		126
111	use base "Exporter";	127	use base "Exporter";
112		128
113	our $VERSION = '0.1';	129	our $VERSION = $AnyEvent::MP::Kernel::VERSION;
		130
114	our @EXPORT = qw(	131	our @EXPORT = qw(
115	NODE $NODE *SELF node_of _any_	132	NODE $NODE *SELF node_of _any_
116	resolve_node initialise_node	133	resolve_node initialise_node
117	snd rcv mon kil reg psub	134	snd rcv mon kil reg psub spawn
118	port	135	port
119	);	136	);
120		137
121	our $SELF;	138	our $SELF;
122		139
…		…
305	$port	322	$port
306	}	323	}
307		324
308	=item reg $port, $name	325	=item reg $port, $name
309		326
310	Registers the given port under the name C<$name>. If the name already	327	=item reg $name
311	exists it is replaced.	328
		329	Registers the given port (or C<$SELF><<< if missing) under the name
		330	C<$name>. If the name already exists it is replaced.
312		331
313	A port can only be registered under one well known name.	332	A port can only be registered under one well known name.
314		333
315	A port automatically becomes unregistered when it is killed.	334	A port automatically becomes unregistered when it is killed.
316		335
317	=cut	336	=cut
318		337
319	sub reg(@) {	338	sub reg(@) {
320	my ($port, $name) = @_;	339	my $port = @_ > 1 ? shift : $SELF \|\| Carp::croak 'reg: called with one argument only, but $SELF not set,';
321		340
322	$REG{$name} = $port;	341	$REG{$_[0]} = $port;
323	}	342	}
324		343
325	=item rcv $port, $callback->(@msg)	344	=item rcv $port, $callback->(@msg)
326		345
327	Replaces the callback on the specified miniport (after converting it to	346	Replaces the callback on the specified miniport (after converting it to
…		…
332	=item rcv $port, $smartmatch => $callback->(@msg), ...	351	=item rcv $port, $smartmatch => $callback->(@msg), ...
333		352
334	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...	353	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
335		354
336	Register callbacks to be called on matching messages on the given full	355	Register callbacks to be called on matching messages on the given full
337	port (after converting it to one if required).	356	port (after converting it to one if required) and return the port.
338		357
339	The callback has to return a true value when its work is done, after	358	The callback has to return a true value when its work is done, after
340	which is will be removed, or a false value in which case it will stay	359	which is will be removed, or a false value in which case it will stay
341	registered.	360	registered.
342		361
343	The global C<$SELF> (exported by this module) contains C<$port> while	362	The global C<$SELF> (exported by this module) contains C<$port> while
344	executing the callback.	363	executing the callback.
345		364
346	Runtime errors wdurign callback execution will result in the port being	365	Runtime errors during callback execution will result in the port being
347	C<kil>ed.	366	C<kil>ed.
348		367
349	If the match is an array reference, then it will be matched against the	368	If the match is an array reference, then it will be matched against the
350	first elements of the message, otherwise only the first element is being	369	first elements of the message, otherwise only the first element is being
351	matched.	370	matched.
…		…
354	exported by this module) matches any single element of the message.	373	exported by this module) matches any single element of the message.
355		374
356	While not required, it is highly recommended that the first matching	375	While not required, it is highly recommended that the first matching
357	element is a string identifying the message. The one-string-only match is	376	element is a string identifying the message. The one-string-only match is
358	also the most efficient match (by far).	377	also the most efficient match (by far).
		378
		379	Example: create a port and bind receivers on it in one go.
		380
		381	my $port = rcv port,
		382	msg1 => sub { ...; 0 },
		383	msg2 => sub { ...; 0 },
		384	;
		385
		386	Example: create a port, bind receivers and send it in a message elsewhere
		387	in one go:
		388
		389	snd $otherport, reply =>
		390	rcv port,
		391	msg1 => sub { ...; 0 },
		392	...
		393	;
359		394
360	=cut	395	=cut
361		396
362	sub rcv($@) {	397	sub rcv($@) {
363	my $port = shift;	398	my $port = shift;
…		…
470	}	505	}
471	}	506	}
472		507
473	=item $guard = mon $port, $cb->(@reason)	508	=item $guard = mon $port, $cb->(@reason)
474		509
475	=item $guard = mon $port, $otherport	510	=item $guard = mon $port, $rcvport
476		511
		512	=item $guard = mon $port
		513
477	=item $guard = mon $port, $otherport, @msg	514	=item $guard = mon $port, $rcvport, @msg
478		515
479	Monitor the given port and do something when the port is killed.	516	Monitor the given port and do something when the port is killed or
		517	messages to it were lost, and optionally return a guard that can be used
		518	to stop monitoring again.
480		519
		520	C<mon> effectively guarantees that, in the absence of hardware failures,
		521	that after starting the monitor, either all messages sent to the port
		522	will arrive, or the monitoring action will be invoked after possible
		523	message loss has been detected. No messages will be lost "in between"
		524	(after the first lost message no further messages will be received by the
		525	port). After the monitoring action was invoked, further messages might get
		526	delivered again.
		527
481	In the first form, the callback is simply called with any number	528	In the first form (callback), the callback is simply called with any
482	of C<@reason> elements (no @reason means that the port was deleted	529	number of C<@reason> elements (no @reason means that the port was deleted
483	"normally"). Note also that I<< the callback B<must> never die >>, so use	530	"normally"). Note also that I<< the callback B<must> never die >>, so use
484	C<eval> if unsure.	531	C<eval> if unsure.
485		532
486	In the second form, the other port will be C<kil>'ed with C<@reason>, iff	533	In the second form (another port given), the other port (C<$rcvport>)
487	a @reason was specified, i.e. on "normal" kils nothing happens, while	534	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
488	under all other conditions, the other port is killed with the same reason.	535	"normal" kils nothing happens, while under all other conditions, the other
		536	port is killed with the same reason.
489		537
		538	The third form (kill self) is the same as the second form, except that
		539	C<$rvport> defaults to C<$SELF>.
		540
490	In the last form, a message of the form C<@msg, @reason> will be C<snd>.	541	In the last form (message), a message of the form C<@msg, @reason> will be
		542	C<snd>.
		543
		544	As a rule of thumb, monitoring requests should always monitor a port from
		545	a local port (or callback). The reason is that kill messages might get
		546	lost, just like any other message. Another less obvious reason is that
		547	even monitoring requests can get lost (for exmaple, when the connection
		548	to the other node goes down permanently). When monitoring a port locally
		549	these problems do not exist.
491		550
492	Example: call a given callback when C<$port> is killed.	551	Example: call a given callback when C<$port> is killed.
493		552
494	mon $port, sub { warn "port died because of <@_>\n" };	553	mon $port, sub { warn "port died because of <@_>\n" };
495		554
496	Example: kill ourselves when C<$port> is killed abnormally.	555	Example: kill ourselves when C<$port> is killed abnormally.
497		556
498	mon $port, $self;	557	mon $port;
499		558
500	Example: send us a restart message another C<$port> is killed.	559	Example: send us a restart message when another C<$port> is killed.
501		560
502	mon $port, $self => "restart";	561	mon $port, $self => "restart";
503		562
504	=cut	563	=cut
505		564
506	sub mon {	565	sub mon {
507	my ($noderef, $port) = split /#/, shift, 2;	566	my ($noderef, $port) = split /#/, shift, 2;
508		567
509	my $node = $NODE{$noderef} \|\| add_node $noderef;	568	my $node = $NODE{$noderef} \|\| add_node $noderef;
510		569
511	my $cb = shift;	570	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
512		571
513	unless (ref $cb) {	572	unless (ref $cb) {
514	if (@_) {	573	if (@_) {
515	# send a kill info message	574	# send a kill info message
516	my (@msg) = ($cb, @_);	575	my (@msg) = ($cb, @_);
…		…
547	=cut	606	=cut
548		607
549	sub mon_guard {	608	sub mon_guard {
550	my ($port, @refs) = @_;	609	my ($port, @refs) = @_;
551		610
		611	#TODO: mon-less form?
		612
552	mon $port, sub { 0 && @refs }	613	mon $port, sub { 0 && @refs }
553	}	614	}
554		615
555	=item lnk $port1, $port2
556
557	Link two ports. This is simply a shorthand for:
558
559	mon $port1, $port2;
560	mon $port2, $port1;
561
562	It means that if either one is killed abnormally, the other one gets
563	killed as well.
564
565	=item kil $port[, @reason]	616	=item kil $port[, @reason]
566		617
567	Kill the specified port with the given C<@reason>.	618	Kill the specified port with the given C<@reason>.
568		619
569	If no C<@reason> is specified, then the port is killed "normally" (linked	620	If no C<@reason> is specified, then the port is killed "normally" (linked
…		…
575	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	626	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
576	will be reported as reason C<< die => $@ >>.	627	will be reported as reason C<< die => $@ >>.
577		628
578	Transport/communication errors are reported as C<< transport_error =>	629	Transport/communication errors are reported as C<< transport_error =>
579	$message >>.	630	$message >>.
		631
		632	=cut
		633
		634	=item $port = spawn $node, $initfunc[, @initdata]
		635
		636	Creates a port on the node C<$node> (which can also be a port ID, in which
		637	case it's the node where that port resides).
		638
		639	The port ID of the newly created port is return immediately, and it is
		640	permissible to immediately start sending messages or monitor the port.
		641
		642	After the port has been created, the init function is
		643	called. This function must be a fully-qualified function name
		644	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
		645	program, use C<::name>.
		646
		647	If the function doesn't exist, then the node tries to C<require>
		648	the package, then the package above the package and so on (e.g.
		649	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		650	exists or it runs out of package names.
		651
		652	The init function is then called with the newly-created port as context
		653	object (C<$SELF>) and the C<@initdata> values as arguments.
		654
		655	A common idiom is to pass your own port, monitor the spawned port, and
		656	in the init function, monitor the original port. This two-way monitoring
		657	ensures that both ports get cleaned up when there is a problem.
		658
		659	Example: spawn a chat server port on C<$othernode>.
		660
		661	# this node, executed from within a port context:
		662	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		663	mon $server;
		664
		665	# init function on C<$othernode>
		666	sub connect {
		667	my ($srcport) = @_;
		668
		669	mon $srcport;
		670
		671	rcv $SELF, sub {
		672	...
		673	};
		674	}
		675
		676	=cut
		677
		678	sub _spawn {
		679	my $port = shift;
		680	my $init = shift;
		681
		682	local $SELF = "$NODE#$port";
		683	eval {
		684	&{ load_func $init }
		685	};
		686	_self_die if $@;
		687	}
		688
		689	sub spawn(@) {
		690	my ($noderef, undef) = split /#/, shift, 2;
		691
		692	my $id = "$RUNIQ." . $ID++;
		693
		694	$_[0] =~ /::/
		695	or Carp::croak "spawn init function must be a fully-qualified name, caught";
		696
		697	($NODE{$noderef} \|\| add_node $noderef)
		698	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
		699
		700	"$noderef#$id"
		701	}
580		702
581	=back	703	=back
582		704
583	=head1 NODE MESSAGES	705	=head1 NODE MESSAGES
584		706
…		…
717	or I<none>, there is no in-between, so monitoring single processes is	839	or I<none>, there is no in-between, so monitoring single processes is
718	difficult to implement. Monitoring in AEMP is more flexible than in	840	difficult to implement. Monitoring in AEMP is more flexible than in
719	Erlang, as one can choose between automatic kill, exit message or callback	841	Erlang, as one can choose between automatic kill, exit message or callback
720	on a per-process basis.	842	on a per-process basis.
721		843
722	=item * Erlang has different semantics for monitoring and linking, AEMP has the same.	844	=item * Erlang tries to hide remote/local connections, AEMP does not.
723		845
724	Monitoring in Erlang is not an indicator of process death/crashes,	846	Monitoring in Erlang is not an indicator of process death/crashes,
725	as linking is (except linking is unreliable in Erlang). In AEMP, the	847	as linking is (except linking is unreliable in Erlang).
726	semantics of monitoring and linking are identical, linking is simply	848
727	two-way monitoring with automatic kill.	849	In AEMP, you don't "look up" registered port names or send to named ports
		850	that might or might not be persistent. Instead, you normally spawn a port
		851	on the remote node. The init function monitors the you, and you monitor
		852	the remote port. Since both monitors are local to the node, they are much
		853	more reliable.
		854
		855	This also saves round-trips and avoids sending messages to the wrong port
		856	(hard to do in Erlang).
		857
		858	=back
		859
		860	=head1 RATIONALE
		861
		862	=over 4
		863
		864	=item Why strings for ports and noderefs, why not objects?
		865
		866	We considered "objects", but found that the actual number of methods
		867	thatc an be called are very low. Since port IDs and noderefs travel over
		868	the network frequently, the serialising/deserialising would add lots of
		869	overhead, as well as having to keep a proxy object.
		870
		871	Strings can easily be printed, easily serialised etc. and need no special
		872	procedures to be "valid".
		873
		874	And a a miniport consists of a single closure stored in a global hash - it
		875	can't become much cheaper.
		876
		877	=item Why favour JSON, why not real serialising format such as Storable?
		878
		879	In fact, any AnyEvent::MP node will happily accept Storable as framing
		880	format, but currently there is no way to make a node use Storable by
		881	default.
		882
		883	The default framing protocol is JSON because a) JSON::XS is many times
		884	faster for small messages and b) most importantly, after years of
		885	experience we found that object serialisation is causing more problems
		886	than it gains: Just like function calls, objects simply do not travel
		887	easily over the network, mostly because they will always be a copy, so you
		888	always have to re-think your design.
		889
		890	Keeping your messages simple, concentrating on data structures rather than
		891	objects, will keep your messages clean, tidy and efficient.
728		892
729	=back	893	=back
730		894
731	=head1 SEE ALSO	895	=head1 SEE ALSO
732		896

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.35 by root, Thu Aug 6 10:21:48 2009 UTC vs. Revision 1.47 by root, Thu Aug 13 01:57:10 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.35 by root, Thu Aug 6 10:21:48 2009 UTC vs.
Revision 1.47 by root, Thu Aug 13 01:57:10 2009 UTC