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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.44 by root, Wed Aug 12 21:39:58 2009 UTC vs. Revision 1.126 by root, Sat Mar 3 19:43:41 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.44 by root, Wed Aug 12 21:39:58 2009 UTC vs.
Revision 1.126 by root, Sat Mar 3 19:43:41 2012 UTC