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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs.
Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent::MP - multi-processing/message-passing framework	3	AnyEvent::MP - erlang-style multi-processing/message-passing framework
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::MP;	7	use AnyEvent::MP;
8		8
9	NODE # returns this node identifier
10	$NODE # contains this node identifier	9	$NODE # contains this node's node ID
		10	NODE # returns this node's node ID
11		11
		12	$SELF # receiving/own port id in rcv callbacks
		13
		14	# initialise the node so it can send/receive messages
		15	configure;
		16
		17	# ports are message destinations
		18
		19	# sending messages
12	snd $port, type => data...;	20	snd $port, type => data...;
		21	snd $port, @msg;
		22	snd @msg_with_first_element_being_a_port;
13		23
14	rcv $port, smartmatch => $cb->($port, @msg);	24	# creating/using ports, the simple way
		25	my $simple_port = port { my @msg = @_ };
15		26
16	# examples:	27	# creating/using ports, tagged message matching
		28	my $port = port;
17	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	29	rcv $port, ping => sub { snd $_[0], "pong" };
18	rcv $port1, pong => sub { warn "pong received\n" };	30	rcv $port, pong => sub { warn "pong received\n" };
19	snd $port2, ping => $port1;
20		31
21	# more, smarter, matches (_any_ is exported by this module)	32	# create a port on another node
22	rcv $port, [child_died => $pid] => sub { ...	33	my $port = spawn $node, $initfunc, @initdata;
23	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	34
		35	# destroy a port again
		36	kil $port; # "normal" kill
		37	kil $port, my_error => "everything is broken"; # error kill
		38
		39	# monitoring
		40	mon $localport, $cb->(@msg) # callback is invoked on death
		41	mon $localport, $otherport # kill otherport on abnormal death
		42	mon $localport, $otherport, @msg # send message on death
		43
		44	# temporarily execute code in port context
		45	peval $port, sub { die "kill the port!" };
		46
		47	# execute callbacks in $SELF port context
		48	my $timer = AE::timer 1, 0, psub {
		49	die "kill the port, delayed";
		50	};
		51
		52	=head1 CURRENT STATUS
		53
		54	bin/aemp - stable.
		55	AnyEvent::MP - stable API, should work.
		56	AnyEvent::MP::Intro - explains most concepts.
		57	AnyEvent::MP::Kernel - mostly stable API.
		58	AnyEvent::MP::Global - stable API.
24		59
25	=head1 DESCRIPTION	60	=head1 DESCRIPTION
26		61
27	This module (-family) implements a simple message passing framework.	62	This module (-family) implements a simple message passing framework.
28		63
29	Despite its simplicity, you can securely message other processes running	64	Despite its simplicity, you can securely message other processes running
30	on the same or other hosts.	65	on the same or other hosts, and you can supervise entities remotely.
31		66
32	At the moment, this module family is severly brokena nd underdocumented,	67	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
33	so do not use. This was uploaded mainly to resreve the CPAN namespace -	68	manual page and the examples under F<eg/>.
34	stay tuned!
35		69
36	=head1 CONCEPTS	70	=head1 CONCEPTS
37		71
38	=over 4	72	=over 4
39		73
40	=item port	74	=item port
41		75
42	A port is something you can send messages to with the C<snd> function, and	76	Not to be confused with a TCP port, a "port" is something you can send
43	you can register C<rcv> handlers with. All C<rcv> handlers will receive	77	messages to (with the C<snd> function).
44	messages they match, messages will not be queued.
45		78
		79	Ports allow you to register C<rcv> handlers that can match all or just
		80	some messages. Messages send to ports will not be queued, regardless of
		81	anything was listening for them or not.
		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
46	=item port id - C<noderef#portname>	85	=item port ID - C<nodeid#portname>
47		86
48	A port id is always the noderef, a hash-mark (C<#>) as separator, followed	87	A port ID is the concatenation of a node ID, a hash-mark (C<#>) as
49	by a port name (a printable string of unspecified format).	88	separator, and a port name (a printable string of unspecified format).
50		89
51	=item node	90	=item node
52		91
53	A node is a single process containing at least one port - the node	92	A node is a single process containing at least one port - the node port,
54	port. You can send messages to node ports to let them create new ports,	93	which enables nodes to manage each other remotely, and to create new
55	among other things.	94	ports.
56		95
57	Initially, nodes are either private (single-process only) or hidden	96	Nodes are either public (have one or more listening ports) or private
58	(connected to a master node only). Only when they epxlicitly "become	97	(no listening ports). Private nodes cannot talk to other private nodes
59	public" can you send them messages from unrelated other nodes.	98	currently, but all nodes can talk to public nodes.
60		99
61	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	100	Nodes is represented by (printable) strings called "node IDs".
62		101
		102	=item node ID - C<[A-Za-z0-9_\-.:]*>
		103
63	A noderef is a string that either uniquely identifies a given node (for	104	A node ID is a string that uniquely identifies the node within a
64	private and hidden nodes), or contains a recipe on how to reach a given	105	network. Depending on the configuration used, node IDs can look like a
65	node (for public nodes).	106	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
		107	doesn't interpret node IDs in any way except to uniquely identify a node.
		108
		109	=item binds - C<ip:port>
		110
		111	Nodes can only talk to each other by creating some kind of connection to
		112	each other. To do this, nodes should listen on one or more local transport
		113	endpoints - binds.
		114
		115	Currently, only standard C<ip:port> specifications can be used, which
		116	specify TCP ports to listen on. So a bind is basically just a tcp socket
		117	in listening mode thta accepts conenctions form other nodes.
		118
		119	=item seed nodes
		120
		121	When a node starts, it knows nothing about the network it is in - it
		122	needs to connect to at least one other node that is already in the
		123	network. These other nodes are called "seed nodes".
		124
		125	Seed nodes themselves are not special - they are seed nodes only because
		126	some other node I<uses> them as such, but any node can be used as seed
		127	node for other nodes, and eahc node cna use a different set of seed nodes.
		128
		129	In addition to discovering the network, seed nodes are also used to
		130	maintain the network - all nodes using the same seed node form are part of
		131	the same network. If a network is split into multiple subnets because e.g.
		132	the network link between the parts goes down, then using the same seed
		133	nodes for all nodes ensures that eventually the subnets get merged again.
		134
		135	Seed nodes are expected to be long-running, and at least one seed node
		136	should always be available. They should also be relatively responsive - a
		137	seed node that blocks for long periods will slow down everybody else.
		138
		139	For small networks, it's best if every node uses the same set of seed
		140	nodes. For large networks, it can be useful to specify "regional" seed
		141	nodes for most nodes in an area, and use all seed nodes as seed nodes for
		142	each other. What's important is that all seed nodes connections form a
		143	complete graph, so that the network cannot split into separate subnets
		144	forever.
		145
		146	Seed nodes are represented by seed IDs.
		147
		148	=item seed IDs - C<host:port>
		149
		150	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
		151	TCP port) of nodes that should be used as seed nodes.
		152
		153	=item global nodes
		154
		155	An AEMP network needs a discovery service - nodes need to know how to
		156	connect to other nodes they only know by name. In addition, AEMP offers a
		157	distributed "group database", which maps group names to a list of strings
		158	- for example, to register worker ports.
		159
		160	A network needs at least one global node to work, and allows every node to
		161	be a global node.
		162
		163	Any node that loads the L<AnyEvent::MP::Global> module becomes a global
		164	node and tries to keep connections to all other nodes. So while it can
		165	make sense to make every node "global" in small networks, it usually makes
		166	sense to only make seed nodes into global nodes in large networks (nodes
		167	keep connections to seed nodes and global nodes, so makign them the same
		168	reduces overhead).
66		169
67	=back	170	=back
68		171
69	=head1 VARIABLES/FUNCTIONS	172	=head1 VARIABLES/FUNCTIONS
70		173
72		175
73	=cut	176	=cut
74		177
75	package AnyEvent::MP;	178	package AnyEvent::MP;
76		179
		180	use AnyEvent::MP::Config ();
77	use AnyEvent::MP::Base;	181	use AnyEvent::MP::Kernel;
		182	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
78		183
79	use common::sense;	184	use common::sense;
80		185
81	use Carp ();	186	use Carp ();
82		187
83	use AE ();	188	use AE ();
84		189
85	use base "Exporter";	190	use base "Exporter";
86		191
87	our $VERSION = '0.02';	192	our $VERSION = $AnyEvent::MP::Config::VERSION;
		193
88	our @EXPORT = qw(	194	our @EXPORT = qw(
89	NODE $NODE $PORT snd rcv _any_	195	NODE $NODE *SELF node_of after
90	create_port create_port_on	196	configure
91	create_miniport	197	snd rcv mon mon_guard kil psub peval spawn cal
92	become_slave become_public	198	port
93	);	199	);
94		200
		201	our $SELF;
		202
		203	sub _self_die() {
		204	my $msg = $@;
		205	$msg =~ s/\n+$// unless ref $msg;
		206	kil $SELF, die => $msg;
		207	}
		208
95	=item NODE / $NODE	209	=item $thisnode = NODE / $NODE
96		210
97	The C<NODE ()> function and the C<$NODE> variable contain the noderef of	211	The C<NODE> function returns, and the C<$NODE> variable contains, the node
98	the local node. The value is initialised by a call to C<become_public> or	212	ID of the node running in the current process. This value is initialised by
99	C<become_slave>, after which all local port identifiers become invalid.	213	a call to C<configure>.
100		214
		215	=item $nodeid = node_of $port
		216
		217	Extracts and returns the node ID from a port ID or a node ID.
		218
		219	=item configure $profile, key => value...
		220
		221	=item configure key => value...
		222
		223	Before a node can talk to other nodes on the network (i.e. enter
		224	"distributed mode") it has to configure itself - the minimum a node needs
		225	to know is its own name, and optionally it should know the addresses of
		226	some other nodes in the network to discover other nodes.
		227
		228	This function configures a node - it must be called exactly once (or
		229	never) before calling other AnyEvent::MP functions.
		230
		231	The key/value pairs are basically the same ones as documented for the
		232	F<aemp> command line utility (sans the set/del prefix), with two additions:
		233
		234	=over 4
		235
		236	=item norc => $boolean (default false)
		237
		238	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
		239	be consulted - all configuraiton options must be specified in the
		240	C<configure> call.
		241
		242	=item force => $boolean (default false)
		243
		244	IF true, then the values specified in the C<configure> will take
		245	precedence over any values configured via the rc file. The default is for
		246	the rc file to override any options specified in the program.
		247
		248	=back
		249
		250	=over 4
		251
		252	=item step 1, gathering configuration from profiles
		253
		254	The function first looks up a profile in the aemp configuration (see the
		255	L<aemp> commandline utility). The profile name can be specified via the
		256	named C<profile> parameter or can simply be the first parameter). If it is
		257	missing, then the nodename (F<uname -n>) will be used as profile name.
		258
		259	The profile data is then gathered as follows:
		260
		261	First, all remaining key => value pairs (all of which are conveniently
		262	undocumented at the moment) will be interpreted as configuration
		263	data. Then they will be overwritten by any values specified in the global
		264	default configuration (see the F<aemp> utility), then the chain of
		265	profiles chosen by the profile name (and any C<parent> attributes).
		266
		267	That means that the values specified in the profile have highest priority
		268	and the values specified directly via C<configure> have lowest priority,
		269	and can only be used to specify defaults.
		270
		271	If the profile specifies a node ID, then this will become the node ID of
		272	this process. If not, then the profile name will be used as node ID. The
		273	special node ID of C<anon/> will be replaced by a random node ID.
		274
		275	=item step 2, bind listener sockets
		276
		277	The next step is to look up the binds in the profile, followed by binding
		278	aemp protocol listeners on all binds specified (it is possible and valid
		279	to have no binds, meaning that the node cannot be contacted form the
		280	outside. This means the node cannot talk to other nodes that also have no
		281	binds, but it can still talk to all "normal" nodes).
		282
		283	If the profile does not specify a binds list, then a default of C<*> is
		284	used, meaning the node will bind on a dynamically-assigned port on every
		285	local IP address it finds.
		286
		287	=item step 3, connect to seed nodes
		288
		289	As the last step, the seed ID list from the profile is passed to the
		290	L<AnyEvent::MP::Global> module, which will then use it to keep
		291	connectivity with at least one node at any point in time.
		292
		293	=back
		294
		295	Example: become a distributed node using the local node name as profile.
		296	This should be the most common form of invocation for "daemon"-type nodes.
		297
		298	configure
		299
		300	Example: become an anonymous node. This form is often used for commandline
		301	clients.
		302
		303	configure nodeid => "anon/";
		304
		305	Example: configure a node using a profile called seed, which is suitable
		306	for a seed node as it binds on all local addresses on a fixed port (4040,
		307	customary for aemp).
		308
		309	# use the aemp commandline utility
		310	# aemp profile seed nodeid anon/ binds '*:4040'
		311
		312	# then use it
		313	configure profile => "seed";
		314
		315	# or simply use aemp from the shell again:
		316	# aemp run profile seed
		317
		318	# or provide a nicer-to-remember nodeid
		319	# aemp run profile seed nodeid "$(hostname)"
		320
		321	=item $SELF
		322
		323	Contains the current port id while executing C<rcv> callbacks or C<psub>
		324	blocks.
		325
		326	=item *SELF, SELF, %SELF, @SELF...
		327
		328	Due to some quirks in how perl exports variables, it is impossible to
		329	just export C<$SELF>, all the symbols named C<SELF> are exported by this
		330	module, but only C<$SELF> is currently used.
		331
101	=item snd $portid, type => @data	332	=item snd $port, type => @data
102		333
103	=item snd $portid, @msg	334	=item snd $port, @msg
104		335
105	Send the given message to the given port ID, which can identify either	336	Send the given message to the given port, which can identify either a
106	a local or a remote port, and can be either a string or soemthignt hat	337	local or a remote port, and must be a port ID.
107	stringifies a sa port ID (such as a port object :).
108		338
109	While the message can be about anything, it is highly recommended to use a	339	While the message can be almost anything, it is highly recommended to
110	string as first element (a portid, or some word that indicates a request	340	use a string as first element (a port ID, or some word that indicates a
111	type etc.).	341	request type etc.) and to consist if only simple perl values (scalars,
		342	arrays, hashes) - if you think you need to pass an object, think again.
112		343
113	The message data effectively becomes read-only after a call to this	344	The message data logically becomes read-only after a call to this
114	function: modifying any argument is not allowed and can cause many	345	function: modifying any argument (or values referenced by them) is
115	problems.	346	forbidden, as there can be considerable time between the call to C<snd>
		347	and the time the message is actually being serialised - in fact, it might
		348	never be copied as within the same process it is simply handed to the
		349	receiving port.
116		350
117	The type of data you can transfer depends on the transport protocol: when	351	The type of data you can transfer depends on the transport protocol: when
118	JSON is used, then only strings, numbers and arrays and hashes consisting	352	JSON is used, then only strings, numbers and arrays and hashes consisting
119	of those are allowed (no objects). When Storable is used, then anything	353	of those are allowed (no objects). When Storable is used, then anything
120	that Storable can serialise and deserialise is allowed, and for the local	354	that Storable can serialise and deserialise is allowed, and for the local
121	node, anything can be passed.	355	node, anything can be passed. Best rely only on the common denominator of
		356	these.
122		357
123	=item $local_port = create_port	358	=item $local_port = port
124		359
125	Create a new local port object. See the next section for allowed methods.	360	Create a new local port object and returns its port ID. Initially it has
		361	no callbacks set and will throw an error when it receives messages.
126		362
127	=cut	363	=item $local_port = port { my @msg = @_ }
128		364
129	sub create_port {	365	Creates a new local port, and returns its ID. Semantically the same as
130	my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID;	366	creating a port and calling C<rcv $port, $callback> on it.
131		367
132	my $self = bless {	368	The block will be called for every message received on the port, with the
133	id => "$NODE#$id",	369	global variable C<$SELF> set to the port ID. Runtime errors will cause the
134	names => [$id],	370	port to be C<kil>ed. The message will be passed as-is, no extra argument
135	}, "AnyEvent::MP::Port";	371	(i.e. no port ID) will be passed to the callback.
136		372
137	$AnyEvent::MP::Base::PORT{$id} = sub {	373	If you want to stop/destroy the port, simply C<kil> it:
138	unshift @_, $self;
139		374
140	for (@{ $self->{rc0}{$_[1]} }) {	375	my $port = port {
141	$_ && &{$_->[0]}	376	my @msg = @_;
142	&& undef $_;	377	...
		378	kil $SELF;
		379	};
		380
		381	=cut
		382
		383	sub rcv($@);
		384
		385	sub _kilme {
		386	die "received message on port without callback";
		387	}
		388
		389	sub port(;&) {
		390	my $id = "$UNIQ." . ++$ID;
		391	my $port = "$NODE#$id";
		392
		393	rcv $port, shift \|\| \&_kilme;
		394
		395	$port
		396	}
		397
		398	=item rcv $local_port, $callback->(@msg)
		399
		400	Replaces the default callback on the specified port. There is no way to
		401	remove the default callback: use C<sub { }> to disable it, or better
		402	C<kil> the port when it is no longer needed.
		403
		404	The global C<$SELF> (exported by this module) contains C<$port> while
		405	executing the callback. Runtime errors during callback execution will
		406	result in the port being C<kil>ed.
		407
		408	The default callback received all messages not matched by a more specific
		409	C<tag> match.
		410
		411	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
		412
		413	Register (or replace) callbacks to be called on messages starting with the
		414	given tag on the given port (and return the port), or unregister it (when
		415	C<$callback> is C<$undef> or missing). There can only be one callback
		416	registered for each tag.
		417
		418	The original message will be passed to the callback, after the first
		419	element (the tag) has been removed. The callback will use the same
		420	environment as the default callback (see above).
		421
		422	Example: create a port and bind receivers on it in one go.
		423
		424	my $port = rcv port,
		425	msg1 => sub { ... },
		426	msg2 => sub { ... },
		427	;
		428
		429	Example: create a port, bind receivers and send it in a message elsewhere
		430	in one go:
		431
		432	snd $otherport, reply =>
		433	rcv port,
		434	msg1 => sub { ... },
		435	...
		436	;
		437
		438	Example: temporarily register a rcv callback for a tag matching some port
		439	(e.g. for an rpc reply) and unregister it after a message was received.
		440
		441	rcv $port, $otherport => sub {
		442	my @reply = @_;
		443
		444	rcv $SELF, $otherport;
		445	};
		446
		447	=cut
		448
		449	sub rcv($@) {
		450	my $port = shift;
		451	my ($nodeid, $portid) = split /#/, $port, 2;
		452
		453	$NODE{$nodeid} == $NODE{""}
		454	or Carp::croak "$port: rcv can only be called on local ports, caught";
		455
		456	while (@_) {
		457	if (ref $_[0]) {
		458	if (my $self = $PORT_DATA{$portid}) {
		459	"AnyEvent::MP::Port" eq ref $self
		460	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		461
		462	$self->[0] = shift;
		463	} else {
		464	my $cb = shift;
		465	$PORT{$portid} = sub {
		466	local $SELF = $port;
		467	eval { &$cb }; _self_die if $@;
		468	};
		469	}
		470	} elsif (defined $_[0]) {
		471	my $self = $PORT_DATA{$portid} \|\|= do {
		472	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
		473
		474	$PORT{$portid} = sub {
		475	local $SELF = $port;
		476
		477	if (my $cb = $self->[1]{$_[0]}) {
		478	shift;
		479	eval { &$cb }; _self_die if $@;
		480	} else {
		481	&{ $self->[0] };
		482	}
		483	};
		484
		485	$self
		486	};
		487
		488	"AnyEvent::MP::Port" eq ref $self
		489	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		490
		491	my ($tag, $cb) = splice @_, 0, 2;
		492
		493	if (defined $cb) {
		494	$self->[1]{$tag} = $cb;
		495	} else {
		496	delete $self->[1]{$tag};
		497	}
143	}	498	}
		499	}
144		500
145	for (@{ $self->{rcv}{$_[1]} }) {	501	$port
146	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]	502	}
147	&& &{$_->[0]}	503
148	&& undef $_;	504	=item peval $port, $coderef[, @args]
		505
		506	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		507	when the code throews an exception the C<$port> will be killed.
		508
		509	Any remaining args will be passed to the callback. Any return values will
		510	be returned to the caller.
		511
		512	This is useful when you temporarily want to execute code in the context of
		513	a port.
		514
		515	Example: create a port and run some initialisation code in it's context.
		516
		517	my $port = port { ... };
		518
		519	peval $port, sub {
		520	init
		521	or die "unable to init";
		522	};
		523
		524	=cut
		525
		526	sub peval($$) {
		527	local $SELF = shift;
		528	my $cb = shift;
		529
		530	if (wantarray) {
		531	my @res = eval { &$cb };
		532	_self_die if $@;
		533	@res
		534	} else {
		535	my $res = eval { &$cb };
		536	_self_die if $@;
		537	$res
		538	}
		539	}
		540
		541	=item $closure = psub { BLOCK }
		542
		543	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
		544	closure is executed, sets up the environment in the same way as in C<rcv>
		545	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		546
		547	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		548	BLOCK }, @_ } >>.
		549
		550	This is useful when you register callbacks from C<rcv> callbacks:
		551
		552	rcv delayed_reply => sub {
		553	my ($delay, @reply) = @_;
		554	my $timer = AE::timer $delay, 0, psub {
		555	snd @reply, $SELF;
		556	};
		557	};
		558
		559	=cut
		560
		561	sub psub(&) {
		562	my $cb = shift;
		563
		564	my $port = $SELF
		565	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
		566
		567	sub {
		568	local $SELF = $port;
		569
		570	if (wantarray) {
		571	my @res = eval { &$cb };
		572	_self_die if $@;
		573	@res
		574	} else {
		575	my $res = eval { &$cb };
		576	_self_die if $@;
		577	$res
149	}	578	}
		579	}
		580	}
150		581
151	for (@{ $self->{any} }) {	582	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
152	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	583
153	&& &{$_->[0]}	584	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
154	&& undef $_;	585
		586	=item $guard = mon $port # kill $SELF when $port dies
		587
		588	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
		589
		590	Monitor the given port and do something when the port is killed or
		591	messages to it were lost, and optionally return a guard that can be used
		592	to stop monitoring again.
		593
		594	In the first form (callback), the callback is simply called with any
		595	number of C<@reason> elements (no @reason means that the port was deleted
		596	"normally"). Note also that I<< the callback B<must> never die >>, so use
		597	C<eval> if unsure.
		598
		599	In the second form (another port given), the other port (C<$rcvport>)
		600	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
		601	"normal" kils nothing happens, while under all other conditions, the other
		602	port is killed with the same reason.
		603
		604	The third form (kill self) is the same as the second form, except that
		605	C<$rvport> defaults to C<$SELF>.
		606
		607	In the last form (message), a message of the form C<@msg, @reason> will be
		608	C<snd>.
		609
		610	Monitoring-actions are one-shot: once messages are lost (and a monitoring
		611	alert was raised), they are removed and will not trigger again.
		612
		613	As a rule of thumb, monitoring requests should always monitor a port from
		614	a local port (or callback). The reason is that kill messages might get
		615	lost, just like any other message. Another less obvious reason is that
		616	even monitoring requests can get lost (for example, when the connection
		617	to the other node goes down permanently). When monitoring a port locally
		618	these problems do not exist.
		619
		620	C<mon> effectively guarantees that, in the absence of hardware failures,
		621	after starting the monitor, either all messages sent to the port will
		622	arrive, or the monitoring action will be invoked after possible message
		623	loss has been detected. No messages will be lost "in between" (after
		624	the first lost message no further messages will be received by the
		625	port). After the monitoring action was invoked, further messages might get
		626	delivered again.
		627
		628	Inter-host-connection timeouts and monitoring depend on the transport
		629	used. The only transport currently implemented is TCP, and AnyEvent::MP
		630	relies on TCP to detect node-downs (this can take 10-15 minutes on a
		631	non-idle connection, and usually around two hours for idle connections).
		632
		633	This means that monitoring is good for program errors and cleaning up
		634	stuff eventually, but they are no replacement for a timeout when you need
		635	to ensure some maximum latency.
		636
		637	Example: call a given callback when C<$port> is killed.
		638
		639	mon $port, sub { warn "port died because of <@_>\n" };
		640
		641	Example: kill ourselves when C<$port> is killed abnormally.
		642
		643	mon $port;
		644
		645	Example: send us a restart message when another C<$port> is killed.
		646
		647	mon $port, $self => "restart";
		648
		649	=cut
		650
		651	sub mon {
		652	my ($nodeid, $port) = split /#/, shift, 2;
		653
		654	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
		655
		656	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
		657
		658	unless (ref $cb) {
		659	if (@_) {
		660	# send a kill info message
		661	my (@msg) = ($cb, @_);
		662	$cb = sub { snd @msg, @_ };
		663	} else {
		664	# simply kill other port
		665	my $port = $cb;
		666	$cb = sub { kil $port, @_ if @_ };
155	}	667	}
		668	}
		669
		670	$node->monitor ($port, $cb);
		671
		672	defined wantarray
		673	and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
		674	}
		675
		676	=item $guard = mon_guard $port, $ref, $ref...
		677
		678	Monitors the given C<$port> and keeps the passed references. When the port
		679	is killed, the references will be freed.
		680
		681	Optionally returns a guard that will stop the monitoring.
		682
		683	This function is useful when you create e.g. timers or other watchers and
		684	want to free them when the port gets killed (note the use of C<psub>):
		685
		686	$port->rcv (start => sub {
		687	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
		688	undef $timer if 0.9 < rand;
		689	});
		690	});
		691
		692	=cut
		693
		694	sub mon_guard {
		695	my ($port, @refs) = @_;
		696
		697	#TODO: mon-less form?
		698
		699	mon $port, sub { 0 && @refs }
		700	}
		701
		702	=item kil $port[, @reason]
		703
		704	Kill the specified port with the given C<@reason>.
		705
		706	If no C<@reason> is specified, then the port is killed "normally" -
		707	monitor callback will be invoked, but the kil will not cause linked ports
		708	(C<mon $mport, $lport> form) to get killed.
		709
		710	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
		711	form) get killed with the same reason.
		712
		713	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
		714	will be reported as reason C<< die => $@ >>.
		715
		716	Transport/communication errors are reported as C<< transport_error =>
		717	$message >>.
		718
		719	=cut
		720
		721	=item $port = spawn $node, $initfunc[, @initdata]
		722
		723	Creates a port on the node C<$node> (which can also be a port ID, in which
		724	case it's the node where that port resides).
		725
		726	The port ID of the newly created port is returned immediately, and it is
		727	possible to immediately start sending messages or to monitor the port.
		728
		729	After the port has been created, the init function is called on the remote
		730	node, in the same context as a C<rcv> callback. This function must be a
		731	fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
		732	specify a function in the main program, use C<::name>.
		733
		734	If the function doesn't exist, then the node tries to C<require>
		735	the package, then the package above the package and so on (e.g.
		736	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		737	exists or it runs out of package names.
		738
		739	The init function is then called with the newly-created port as context
		740	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		741	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		742	the port might not get created.
		743
		744	A common idiom is to pass a local port, immediately monitor the spawned
		745	port, and in the remote init function, immediately monitor the passed
		746	local port. This two-way monitoring ensures that both ports get cleaned up
		747	when there is a problem.
		748
		749	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		750	caller before C<spawn> returns (by delaying invocation when spawn is
		751	called for the local node).
		752
		753	Example: spawn a chat server port on C<$othernode>.
		754
		755	# this node, executed from within a port context:
		756	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		757	mon $server;
		758
		759	# init function on C<$othernode>
		760	sub connect {
		761	my ($srcport) = @_;
		762
		763	mon $srcport;
		764
		765	rcv $SELF, sub {
		766	...
		767	};
		768	}
		769
		770	=cut
		771
		772	sub _spawn {
		773	my $port = shift;
		774	my $init = shift;
		775
		776	# rcv will create the actual port
		777	local $SELF = "$NODE#$port";
		778	eval {
		779	&{ load_func $init }
156	};	780	};
157		781	_self_die if $@;
158	$self
159	}	782	}
160		783
161	=item $portid = create_miniport { }	784	sub spawn(@) {
		785	my ($nodeid, undef) = split /#/, shift, 2;
162		786
163	Creates a "mini port", that is, a port without much #TODO	787	my $id = "$RUNIQ." . ++$ID;
164		788
165	=cut	789	$_[0] =~ /::/
		790	or Carp::croak "spawn init function must be a fully-qualified name, caught";
166		791
167	sub create_miniport(&) {	792	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
168	my $cb = shift;
169	my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID;
170		793
171	$AnyEvent::MP::Base::PORT{$id} = sub {	794	"$nodeid#$id"
172	# unshift @_, "$NODE#$id";	795	}
173	&$cb	796
174	and delete $AnyEvent::MP::Base::PORT{$id};	797
		798	=item after $timeout, @msg
		799
		800	=item after $timeout, $callback
		801
		802	Either sends the given message, or call the given callback, after the
		803	specified number of seconds.
		804
		805	This is simply a utility function that comes in handy at times - the
		806	AnyEvent::MP author is not convinced of the wisdom of having it, though,
		807	so it may go away in the future.
		808
		809	=cut
		810
		811	sub after($@) {
		812	my ($timeout, @action) = @_;
		813
		814	my $t; $t = AE::timer $timeout, 0, sub {
		815	undef $t;
		816	ref $action[0]
		817	? $action[0]()
		818	: snd @action;
175	};	819	};
176
177	"$NODE#$id"
178	}	820	}
179		821
180	package AnyEvent::MP::Port;	822	=item cal $port, @msg, $callback[, $timeout]
		823
		824	A simple form of RPC - sends a message to the given C<$port> with the
		825	given contents (C<@msg>), but adds a reply port to the message.
		826
		827	The reply port is created temporarily just for the purpose of receiving
		828	the reply, and will be C<kil>ed when no longer needed.
		829
		830	A reply message sent to the port is passed to the C<$callback> as-is.
		831
		832	If an optional time-out (in seconds) is given and it is not C<undef>,
		833	then the callback will be called without any arguments after the time-out
		834	elapsed and the port is C<kil>ed.
		835
		836	If no time-out is given (or it is C<undef>), then the local port will
		837	monitor the remote port instead, so it eventually gets cleaned-up.
		838
		839	Currently this function returns the temporary port, but this "feature"
		840	might go in future versions unless you can make a convincing case that
		841	this is indeed useful for something.
		842
		843	=cut
		844
		845	sub cal(@) {
		846	my $timeout = ref $_[-1] ? undef : pop;
		847	my $cb = pop;
		848
		849	my $port = port {
		850	undef $timeout;
		851	kil $SELF;
		852	&$cb;
		853	};
		854
		855	if (defined $timeout) {
		856	$timeout = AE::timer $timeout, 0, sub {
		857	undef $timeout;
		858	kil $port;
		859	$cb->();
		860	};
		861	} else {
		862	mon $_[0], sub {
		863	kil $port;
		864	$cb->();
		865	};
		866	}
		867
		868	push @_, $port;
		869	&snd;
		870
		871	$port
		872	}
181		873
182	=back	874	=back
183		875
184	=head1 METHODS FOR PORT OBJECTS	876	=head1 AnyEvent::MP vs. Distributed Erlang
		877
		878	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
		879	== aemp node, Erlang process == aemp port), so many of the documents and
		880	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
		881	sample:
		882
		883	http://www.erlang.se/doc/programming_rules.shtml
		884	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
		885	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
		886	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
		887
		888	Despite the similarities, there are also some important differences:
185		889
186	=over 4	890	=over 4
187		891
188	=item "$port"	892	=item * Node IDs are arbitrary strings in AEMP.
189		893
190	A port object stringifies to its port ID, so can be used directly for	894	Erlang relies on special naming and DNS to work everywhere in the same
191	C<snd> operations.	895	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
		896	configuration or DNS), and possibly the addresses of some seed nodes, but
		897	will otherwise discover other nodes (and their IDs) itself.
192		898
193	=cut	899	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
		900	uses "local ports are like remote ports".
194		901
195	use overload	902	The failure modes for local ports are quite different (runtime errors
196	'""' => sub { $_[0]{id} },	903	only) then for remote ports - when a local port dies, you I<know> it dies,
197	fallback => 1;	904	when a connection to another node dies, you know nothing about the other
		905	port.
198		906
199	=item $port->rcv (type => $callback->($port, @msg))	907	Erlang pretends remote ports are as reliable as local ports, even when
		908	they are not.
200		909
201	=item $port->rcv ($smartmatch => $callback->($port, @msg))	910	AEMP encourages a "treat remote ports differently" philosophy, with local
		911	ports being the special case/exception, where transport errors cannot
		912	occur.
202		913
203	=item $port->rcv ([$smartmatch...] => $callback->($port, @msg))	914	=item * Erlang uses processes and a mailbox, AEMP does not queue.
204		915
205	Register a callback on the given port.	916	Erlang uses processes that selectively receive messages out of order, and
		917	therefore needs a queue. AEMP is event based, queuing messages would serve
		918	no useful purpose. For the same reason the pattern-matching abilities
		919	of AnyEvent::MP are more limited, as there is little need to be able to
		920	filter messages without dequeuing them.
206		921
207	The callback has to return a true value when its work is done, after	922	This is not a philosophical difference, but simply stems from AnyEvent::MP
208	which is will be removed, or a false value in which case it will stay	923	being event-based, while Erlang is process-based.
209	registered.
210		924
211	If the match is an array reference, then it will be matched against the	925	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
212	first elements of the message, otherwise only the first element is being	926	top of AEMP and Coro threads.
213	matched.
214		927
215	Any element in the match that is specified as C<_any_> (a function	928	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
216	exported by this module) matches any single element of the message.
217		929
218	While not required, it is highly recommended that the first matching	930	Sending messages in Erlang is synchronous and blocks the process until
219	element is a string identifying the message. The one-string-only match is	931	a conenction has been established and the message sent (and so does not
220	also the most efficient match (by far).	932	need a queue that can overflow). AEMP sends return immediately, connection
		933	establishment is handled in the background.
221		934
222	=cut	935	=item * Erlang suffers from silent message loss, AEMP does not.
223		936
224	sub rcv($@) {	937	Erlang implements few guarantees on messages delivery - messages can get
225	my ($self, $match, $cb) = @_;	938	lost without any of the processes realising it (i.e. you send messages a,
		939	b, and c, and the other side only receives messages a and c).
226		940
227	if (!ref $match) {	941	AEMP guarantees (modulo hardware errors) correct ordering, and the
228	push @{ $self->{rc0}{$match} }, [$cb];	942	guarantee that after one message is lost, all following ones sent to the
229	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {	943	same port are lost as well, until monitoring raises an error, so there are
230	my ($type, @match) = @$match;	944	no silent "holes" in the message sequence.
231	@match
232	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
233	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
234	} else {
235	push @{ $self->{any} }, [$cb, $match];
236	}
237	}
238		945
239	=item $port->register ($name)	946	If you want your software to be very reliable, you have to cope with
		947	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		948	simply tries to work better in common error cases, such as when a network
		949	link goes down.
240		950
241	Registers the given port under the well known name C<$name>. If the name	951	=item * Erlang can send messages to the wrong port, AEMP does not.
242	already exists it is replaced.
243		952
244	A port can only be registered under one well known name.	953	In Erlang it is quite likely that a node that restarts reuses an Erlang
		954	process ID known to other nodes for a completely different process,
		955	causing messages destined for that process to end up in an unrelated
		956	process.
245		957
246	=cut	958	AEMP does not reuse port IDs, so old messages or old port IDs floating
		959	around in the network will not be sent to an unrelated port.
247		960
248	sub register {	961	=item * Erlang uses unprotected connections, AEMP uses secure
249	my ($self, $name) = @_;	962	authentication and can use TLS.
250		963
251	$self->{wkname} = $name;	964	AEMP can use a proven protocol - TLS - to protect connections and
252	$AnyEvent::MP::Base::WKP{$name} = "$self";	965	securely authenticate nodes.
253	}
254		966
255	=item $port->destroy	967	=item * The AEMP protocol is optimised for both text-based and binary
		968	communications.
256		969
257	Explicitly destroy/remove/nuke/vaporise the port.	970	The AEMP protocol, unlike the Erlang protocol, supports both programming
		971	language independent text-only protocols (good for debugging), and binary,
		972	language-specific serialisers (e.g. Storable). By default, unless TLS is
		973	used, the protocol is actually completely text-based.
258		974
259	Ports are normally kept alive by there mere existance alone, and need to	975	It has also been carefully designed to be implementable in other languages
260	be destroyed explicitly.	976	with a minimum of work while gracefully degrading functionality to make the
		977	protocol simple.
261		978
262	=cut	979	=item * AEMP has more flexible monitoring options than Erlang.
263		980
264	sub destroy {	981	In Erlang, you can chose to receive I<all> exit signals as messages or
265	my ($self) = @_;	982	I<none>, there is no in-between, so monitoring single Erlang processes is
		983	difficult to implement.
266		984
267	delete $AnyEvent::MP::Base::WKP{ $self->{wkname} };	985	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		986	between automatic kill, exit message or callback on a per-port basis.
268		987
269	delete $AnyEvent::MP::Base::PORT{$_}	988	=item * Erlang tries to hide remote/local connections, AEMP does not.
270	for @{ $self->{names} };	989
271	}	990	Monitoring in Erlang is not an indicator of process death/crashes, in the
		991	same way as linking is (except linking is unreliable in Erlang).
		992
		993	In AEMP, you don't "look up" registered port names or send to named ports
		994	that might or might not be persistent. Instead, you normally spawn a port
		995	on the remote node. The init function monitors you, and you monitor the
		996	remote port. Since both monitors are local to the node, they are much more
		997	reliable (no need for C<spawn_link>).
		998
		999	This also saves round-trips and avoids sending messages to the wrong port
		1000	(hard to do in Erlang).
272		1001
273	=back	1002	=back
274		1003
275	=head1 FUNCTIONS FOR NODES	1004	=head1 RATIONALE
276		1005
277	=over 4	1006	=over 4
278		1007
279	=item mon $noderef, $callback->($noderef, $status, $)	1008	=item Why strings for port and node IDs, why not objects?
280		1009
281	Monitors the given noderef.	1010	We considered "objects", but found that the actual number of methods
		1011	that can be called are quite low. Since port and node IDs travel over
		1012	the network frequently, the serialising/deserialising would add lots of
		1013	overhead, as well as having to keep a proxy object everywhere.
282		1014
283	=item become_public endpoint...	1015	Strings can easily be printed, easily serialised etc. and need no special
		1016	procedures to be "valid".
284		1017
285	Tells the node to become a public node, i.e. reachable from other nodes.	1018	And as a result, a port with just a default receiver consists of a single
		1019	code reference stored in a global hash - it can't become much cheaper.
286		1020
287	If no arguments are given, or the first argument is C<undef>, then	1021	=item Why favour JSON, why not a real serialising format such as Storable?
288	AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the
289	local nodename resolves to.
290		1022
291	Otherwise the first argument must be an array-reference with transport	1023	In fact, any AnyEvent::MP node will happily accept Storable as framing
292	endpoints ("ip:port", "hostname:port") or port numbers (in which case the	1024	format, but currently there is no way to make a node use Storable by
293	local nodename is used as hostname). The endpoints are all resolved and	1025	default (although all nodes will accept it).
294	will become the node reference.
295		1026
296	=cut	1027	The default framing protocol is JSON because a) JSON::XS is many times
		1028	faster for small messages and b) most importantly, after years of
		1029	experience we found that object serialisation is causing more problems
		1030	than it solves: Just like function calls, objects simply do not travel
		1031	easily over the network, mostly because they will always be a copy, so you
		1032	always have to re-think your design.
		1033
		1034	Keeping your messages simple, concentrating on data structures rather than
		1035	objects, will keep your messages clean, tidy and efficient.
297		1036
298	=back	1037	=back
299		1038
300	=head1 NODE MESSAGES
301
302	Nodes understand the following messages sent to them. Many of them take
303	arguments called C<@reply>, which will simply be used to compose a reply
304	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
305	the remaining arguments are simply the message data.
306
307	=over 4
308
309	=cut
310
311	=item wkp => $name, @reply
312
313	Replies with the port ID of the specified well-known port, or C<undef>.
314
315	=item devnull => ...
316
317	Generic data sink/CPU heat conversion.
318
319	=item relay => $port, @msg
320
321	Simply forwards the message to the given port.
322
323	=item eval => $string[ @reply]
324
325	Evaluates the given string. If C<@reply> is given, then a message of the
326	form C<@reply, $@, @evalres> is sent.
327
328	Example: crash another node.
329
330	snd $othernode, eval => "exit";
331
332	=item time => @reply
333
334	Replies the the current node time to C<@reply>.
335
336	Example: tell the current node to send the current time to C<$myport> in a
337	C<timereply> message.
338
339	snd $NODE, time => $myport, timereply => 1, 2;
340	# => snd $myport, timereply => 1, 2, <time>
341
342	=back
343
344	=head1 SEE ALSO	1039	=head1 SEE ALSO
		1040
		1041	L<AnyEvent::MP::Intro> - a gentle introduction.
		1042
		1043	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
		1044
		1045	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
		1046	your applications.
		1047
		1048	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
		1049
		1050	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
		1051	all nodes.
345		1052
346	L<AnyEvent>.	1053	L<AnyEvent>.
347		1054
348	=head1 AUTHOR	1055	=head1 AUTHOR
349		1056

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs. Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs.
Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC