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

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

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.37 by root, Fri Aug 7 16:47:23 2009 UTC vs. Revision 1.123 by root, Thu Mar 1 19:37:59 2012 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.37 by root, Fri Aug 7 16:47:23 2009 UTC vs.
Revision 1.123 by root, Thu Mar 1 19:37:59 2012 UTC