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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.42 by root, Sun Aug 9 00:41:49 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
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::Base;	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 ();
117		190
118	use base "Exporter";	191	use base "Exporter";
119		192
120	our $VERSION = '0.1';	193	our $VERSION = $AnyEvent::MP::Config::VERSION;
		194
121	our @EXPORT = qw(	195	our @EXPORT = qw(
122	NODE $NODE *SELF node_of _any_	196	NODE $NODE *SELF node_of after
123	resolve_node initialise_node	197	configure
124	snd rcv mon kil reg psub spawn	198	snd rcv mon mon_guard kil psub peval spawn cal
125	port	199	port
126	);	200	);
127		201
128	our $SELF;	202	our $SELF;
129		203
…		…
133	kil $SELF, die => $msg;	207	kil $SELF, die => $msg;
134	}	208	}
135		209
136	=item $thisnode = NODE / $NODE	210	=item $thisnode = NODE / $NODE
137		211
138	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
139	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
140	to C<become_public> or C<become_slave>, after which all local port	214	a call to C<configure>.
141	identifiers become invalid.
142		215
143	=item $noderef = node_of $port	216	=item $nodeid = node_of $port
144		217
145	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.
146		219
147	=item initialise_node $noderef, $seednode, $seednode...	220	=item configure $profile, key => value...
148		221
149	=item initialise_node "slave/", $master, $master...	222	=item configure key => value...
150		223
151	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
152	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
153	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.
154		228
155	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
156	never) before calling other AnyEvent::MP functions.	230	never) before calling other AnyEvent::MP functions.
157		231
158	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
159		233	F<aemp> command line utility (sans the set/del prefix), with two additions:
160	There are two types of networked nodes, public nodes and slave nodes:
161		234
162	=over 4	235	=over 4
163		236
164	=item public nodes	237	=item norc => $boolean (default false)
165		238
166	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>
167	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
168	which case the noderef will be guessed.	241	C<configure> call.
169		242
170	Afterwards, the node will bind itself on all endpoints and try to connect	243	=item force => $boolean (default false)
171	to all additional C<$seednodes> that are specified. Seednodes are optional
172	and can be used to quickly bootstrap the node into an existing network.
173		244
174	=item slave nodes	245	IF true, then the values specified in the C<configure> will take
175		246	precedence over any values configured via the rc file. The default is for
176	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.
177	become a slave node. Slave nodes cannot be contacted from outside and will
178	route most of their traffic to the master node that they attach to.
179
180	At least one additional noderef is required: The node will try to connect
181	to all of them and will become a slave attached to the first node it can
182	successfully connect to.
183		248
184	=back	249	=back
185		250
186	This function will block until all nodes have been resolved and, for slave
187	nodes, until it has successfully established a connection to a master
188	server.
189
190	Example: become a public node listening on the default node.
191
192	initialise_node;
193
194	Example: become a public node, and try to contact some well-known master
195	servers to become part of the network.
196
197	initialise_node undef, "master1", "master2";
198
199	Example: become a public node listening on port C<4041>.
200
201	initialise_node 4041;
202
203	Example: become a public node, only visible on localhost port 4044.
204
205	initialise_node "locahost:4044";
206
207	Example: become a slave node to any of the specified master servers.
208
209	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
210
211	=item $cv = resolve_node $noderef
212
213	Takes an unresolved node reference that may contain hostnames and
214	abbreviated IDs, resolves all of them and returns a resolved node
215	reference.
216
217	In addition to C<address:port> pairs allowed in resolved noderefs, the
218	following forms are supported:
219
220	=over 4	251	=over 4
221		252
222	=item the empty string	253	=item step 1, gathering configuration from profiles
223		254
224	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
225	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.
226		259
227	=item naked port numbers (e.g. C<1234>)	260	The profile data is then gathered as follows:
228		261
229	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
230	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).
231		267
232	=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.
233		271
234	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
235	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
236	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.
237		296
238	=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)"
239		324
240	=item $SELF	325	=item $SELF
241		326
242	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>
243	blocks.	328	blocks.
244		329
245	=item SELF, %SELF, @SELF...	330	=item *SELF, SELF, %SELF, @SELF...
246		331
247	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
248	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
249	module, but only C<$SELF> is currently used.	334	module, but only C<$SELF> is currently used.
250		335
251	=item snd $port, type => @data	336	=item snd $port, type => @data
252		337
253	=item snd $port, @msg	338	=item snd $port, @msg
254		339
255	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
256	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.
257	stringifies a sa port ID (such as a port object :).
258		342
259	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
260	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
261	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.
262		347
263	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
264	function: modifying any argument is not allowed and can cause many	349	function: modifying any argument (or values referenced by them) is
265	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.
266		354
267	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
268	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
269	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
270	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
271	node, anything can be passed.	359	node, anything can be passed. Best rely only on the common denominator of
		360	these.
272		361
273	=item $local_port = port	362	=item $local_port = port
274		363
275	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
276	matching port ("full port") or a single-callback port ("miniport"),	365	no callbacks set and will throw an error when it receives messages.
277	depending on how C<rcv> callbacks are bound to the object.
278		366
279	=item $port = port { my @msg = @_; $finished }	367	=item $local_port = port { my @msg = @_ }
280		368
281	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
282	matching behind it, and returns its ID. Semantically the same as creating
283	a port and calling C<rcv $port, $callback> on it.	370	creating a port and calling C<rcv $port, $callback> on it.
284		371
285	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
286	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
287	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.
288		376
289	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:
290	be passed to the callback.
291		378
292	If you need the local port id in the callback, this works nicely:	379	my $port = port {
293		380	my @msg = @_;
294	my $port; $port = port {	381	...
295	snd $otherport, reply => $port;	382	kil $SELF;
296	};	383	};
297		384
298	=cut	385	=cut
299		386
300	sub rcv($@);	387	sub rcv($@);
301		388
		389	sub _kilme {
		390	die "received message on port without callback";
		391	}
		392
302	sub port(;&) {	393	sub port(;&) {
303	my $id = "$UNIQ." . $ID++;	394	my $id = $UNIQ . ++$ID;
304	my $port = "$NODE#$id";	395	my $port = "$NODE#$id";
305		396
306	if (@_) {	397	rcv $port, shift \|\| \&_kilme;
307	rcv $port, shift;
308	} else {
309	$PORT{$id} = sub { }; # nop
310	}
311		398
312	$port	399	$port
313	}	400	}
314		401
315	=item reg $port, $name
316
317	=item reg $name
318
319	Registers the given port (or C<$SELF><<< if missing) under the name
320	C<$name>. If the name already exists it is replaced.
321
322	A port can only be registered under one well known name.
323
324	A port automatically becomes unregistered when it is killed.
325
326	=cut
327
328	sub reg(@) {
329	my $port = @_ > 1 ? shift : $SELF \|\| Carp::croak 'reg: called with one argument only, but $SELF not set,';
330
331	$REG{$_[0]} = $port;
332	}
333
334	=item rcv $port, $callback->(@msg)	402	=item rcv $local_port, $callback->(@msg)
335		403
336	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
337	one if required).	405	remove the default callback: use C<sub { }> to disable it, or better
338		406	C<kil> the port when it is no longer needed.
339	=item rcv $port, tagstring => $callback->(@msg), ...
340
341	=item rcv $port, $smartmatch => $callback->(@msg), ...
342
343	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
344
345	Register callbacks to be called on matching messages on the given full
346	port (after converting it to one if required) and return the port.
347
348	The callback has to return a true value when its work is done, after
349	which is will be removed, or a false value in which case it will stay
350	registered.
351		407
352	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
353	executing the callback.	409	executing the callback. Runtime errors during callback execution will
		410	result in the port being C<kil>ed.
354		411
355	Runtime errors during callback execution will result in the port being	412	The default callback received all messages not matched by a more specific
356	C<kil>ed.	413	C<tag> match.
357		414
358	If the match is an array reference, then it will be matched against the	415	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
359	first elements of the message, otherwise only the first element is being
360	matched.
361		416
362	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
363	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.
364		421
365	While not required, it is highly recommended that the first matching	422	The original message will be passed to the callback, after the first
366	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
367	also the most efficient match (by far).	424	environment as the default callback (see above).
368		425
369	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.
370		427
371	my $port = rcv port,	428	my $port = rcv port,
372	msg1 => sub { ...; 0 },	429	msg1 => sub { ... },
373	msg2 => sub { ...; 0 },	430	msg2 => sub { ... },
374	;	431	;
375		432
376	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
377	in one go:	434	in one go:
378		435
379	snd $otherport, reply =>	436	snd $otherport, reply =>
380	rcv port,	437	rcv port,
381	msg1 => sub { ...; 0 },	438	msg1 => sub { ... },
382	...	439	...
383	;	440	;
384		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
385	=cut	451	=cut
386		452
387	sub rcv($@) {	453	sub rcv($@) {
388	my $port = shift;	454	my $port = shift;
389	my ($noderef, $portid) = split /#/, $port, 2;	455	my ($nodeid, $portid) = split /#/, $port, 2;
390		456
391	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}	457	$NODE{$nodeid} == $NODE{""}
392	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";
393		459
394	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 {
395	my $cb = shift;	468	my $cb = shift;
396	delete $PORT_DATA{$portid};
397	$PORT{$portid} = sub {	469	$PORT{$portid} = sub {
398	local $SELF = $port;	470	local $SELF = $port;
399	eval {	471	eval { &$cb }; _self_die if $@;
400	&$cb	472	};
401	and kil $port;
402	};	473	}
403	_self_die if $@;	474	} elsif (defined $_[0]) {
404	};
405	} else {
406	my $self = $PORT_DATA{$portid} \|\|= do {	475	my $self = $PORT_DATA{$portid} \|\|= do {
407	my $self = bless {	476	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
408	id => $port,
409	}, "AnyEvent::MP::Port";
410		477
411	$PORT{$portid} = sub {	478	$PORT{$portid} = sub {
412	local $SELF = $port;	479	local $SELF = $port;
413		480
414	eval {
415	for (@{ $self->{rc0}{$_[0]} }) {	481	if (my $cb = $self->[1]{$_[0]}) {
416	$_ && &{$_->[0]}	482	shift;
417	&& undef $_;	483	eval { &$cb }; _self_die if $@;
418	}	484	} else {
419
420	for (@{ $self->{rcv}{$_[0]} }) {
421	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
422	&& &{$_->[0]}	485	&{ $self->[0] };
423	&& undef $_;
424	}
425
426	for (@{ $self->{any} }) {
427	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
428	&& &{$_->[0]}
429	&& undef $_;
430	}	486	}
431	};	487	};
432	_self_die if $@;	488
		489	$self
433	};	490	};
434		491
435	$self
436	};
437
438	"AnyEvent::MP::Port" eq ref $self	492	"AnyEvent::MP::Port" eq ref $self
439	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";
440		494
441	while (@_) {
442	my ($match, $cb) = splice @_, 0, 2;	495	my ($tag, $cb) = splice @_, 0, 2;
443		496
444	if (!ref $match) {	497	if (defined $cb) {
445	push @{ $self->{rc0}{$match} }, [$cb];	498	$self->[1]{$tag} = $cb;
446	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
447	my ($type, @match) = @$match;
448	@match
449	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
450	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
451	} else {	499	} else {
452	push @{ $self->{any} }, [$cb, $match];	500	delete $self->[1]{$tag};
453	}	501	}
454	}	502	}
455	}	503	}
456		504
457	$port	505	$port
458	}	506	}
459		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
460	=item $closure = psub { BLOCK }	545	=item $closure = psub { BLOCK }
461		546
462	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
463	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>
464	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 }, @_ } >>.
465		553
466	This is useful when you register callbacks from C<rcv> callbacks:	554	This is useful when you register callbacks from C<rcv> callbacks:
467		555
468	rcv delayed_reply => sub {	556	rcv delayed_reply => sub {
469	my ($delay, @reply) = @_;	557	my ($delay, @reply) = @_;
…		…
493	$res	581	$res
494	}	582	}
495	}	583	}
496	}	584	}
497		585
498	=item $guard = mon $port, $cb->(@reason)	586	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
499		587
500	=item $guard = mon $port, $rcvport	588	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
501		589
502	=item $guard = mon $port	590	=item $guard = mon $port # kill $SELF when $port dies
503		591
504	=item $guard = mon $port, $rcvport, @msg	592	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
505		593
506	Monitor the given port and do something when the port is killed or	594	Monitor the given port and do something when the port is killed or
507	messages to it were lost, and optionally return a guard that can be used	595	messages to it were lost, and optionally return a guard that can be used
508	to stop monitoring again.	596	to stop monitoring again.
509
510	C<mon> effectively guarantees that, in the absence of hardware failures,
511	that after starting the monitor, either all messages sent to the port
512	will arrive, or the monitoring action will be invoked after possible
513	message loss has been detected. No messages will be lost "in between"
514	(after the first lost message no further messages will be received by the
515	port). After the monitoring action was invoked, further messages might get
516	delivered again.
517		597
518	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
519	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
520	"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
521	C<eval> if unsure.	601	C<eval> if unsure.
522		602
523	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>)
524	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
525	"normal" kils nothing happens, while under all other conditions, the other	605	"normal" kils nothing happens, while under all other conditions, the other
526	port is killed with the same reason.	606	port is killed with the same reason.
527		607
528	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
529	C<$rvport> defaults to C<$SELF>.	609	C<$rvport> defaults to C<$SELF>.
530		610
531	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
532	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.
533		616
534	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
535	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
536	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
537	even monitoring requests can get lost (for exmaple, when the connection	620	even monitoring requests can get lost (for example, when the connection
538	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
539	these problems do not exist.	622	these problems do not exist.
540		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
541	Example: call a given callback when C<$port> is killed.	641	Example: call a given callback when C<$port> is killed.
542		642
543	mon $port, sub { warn "port died because of <@_>\n" };	643	mon $port, sub { warn "port died because of <@_>\n" };
544		644
545	Example: kill ourselves when C<$port> is killed abnormally.	645	Example: kill ourselves when C<$port> is killed abnormally.
…		…
551	mon $port, $self => "restart";	651	mon $port, $self => "restart";
552		652
553	=cut	653	=cut
554		654
555	sub mon {	655	sub mon {
556	my ($noderef, $port) = split /#/, shift, 2;	656	my ($nodeid, $port) = split /#/, shift, 2;
557		657
558	my $node = $NODE{$noderef} \|\| add_node $noderef;	658	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
559		659
560	my $cb = @_ ? shift : $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,';
561		661
562	unless (ref $cb) {	662	unless (ref $cb) {
563	if (@_) {	663	if (@_) {
…		…
572	}	672	}
573		673
574	$node->monitor ($port, $cb);	674	$node->monitor ($port, $cb);
575		675
576	defined wantarray	676	defined wantarray
577	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	677	and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
578	}	678	}
579		679
580	=item $guard = mon_guard $port, $ref, $ref...	680	=item $guard = mon_guard $port, $ref, $ref...
581		681
582	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
583	is killed, the references will be freed.	683	is killed, the references will be freed.
584		684
585	Optionally returns a guard that will stop the monitoring.	685	Optionally returns a guard that will stop the monitoring.
586		686
587	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
588	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>):
589		689
590	$port->rcv (start => sub {	690	$port->rcv (start => sub {
591	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {	691	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
592	undef $timer if 0.9 < rand;	692	undef $timer if 0.9 < rand;
593	});	693	});
594	});	694	});
595		695
596	=cut	696	=cut
…		…
605		705
606	=item kil $port[, @reason]	706	=item kil $port[, @reason]
607		707
608	Kill the specified port with the given C<@reason>.	708	Kill the specified port with the given C<@reason>.
609		709
610	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" -
611	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.
612		713
613	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>
614	C<mon>, see below).	715	form) get killed with the same reason.
615		716
616	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
617	will be reported as reason C<< die => $@ >>.	718	will be reported as reason C<< die => $@ >>.
618		719
619	Transport/communication errors are reported as C<< transport_error =>	720	Transport/communication errors are reported as C<< transport_error =>
…		…
624	=item $port = spawn $node, $initfunc[, @initdata]	725	=item $port = spawn $node, $initfunc[, @initdata]
625		726
626	Creates a port on the node C<$node> (which can also be a port ID, in which	727	Creates a port on the node C<$node> (which can also be a port ID, in which
627	case it's the node where that port resides).	728	case it's the node where that port resides).
628		729
629	The port ID of the newly created port is return immediately, and it is	730	The port ID of the newly created port is returned immediately, and it is
630	permissible to immediately start sending messages or monitor the port.	731	possible to immediately start sending messages or to monitor the port.
631		732
632	After the port has been created, the init function is	733	After the port has been created, the init function is called on the remote
633	called. This function must be a fully-qualified function name	734	node, in the same context as a C<rcv> callback. This function must be a
634	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main	735	fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
635	program, use C<::name>.	736	specify a function in the main program, use C<::name>.
636		737
637	If the function doesn't exist, then the node tries to C<require>	738	If the function doesn't exist, then the node tries to C<require>
638	the package, then the package above the package and so on (e.g.	739	the package, then the package above the package and so on (e.g.
639	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	740	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
640	exists or it runs out of package names.	741	exists or it runs out of package names.
641		742
642	The init function is then called with the newly-created port as context	743	The init function is then called with the newly-created port as context
643	object (C<$SELF>) and the C<@initdata> values as arguments.	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.
644		747
645	A common idiom is to pass your own port, monitor the spawned port, and	748	A common idiom is to pass a local port, immediately monitor the spawned
646	in the init function, monitor the original port. This two-way monitoring	749	port, and in the remote init function, immediately monitor the passed
647	ensures that both ports get cleaned up when there is a problem.	750	local port. This two-way monitoring ensures that both ports get cleaned up
		751	when there is a problem.
		752
		753	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		754	caller before C<spawn> returns (by delaying invocation when spawn is
		755	called for the local node).
648		756
649	Example: spawn a chat server port on C<$othernode>.	757	Example: spawn a chat server port on C<$othernode>.
650		758
651	# this node, executed from within a port context:	759	# this node, executed from within a port context:
652	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	760	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
…		…
667		775
668	sub _spawn {	776	sub _spawn {
669	my $port = shift;	777	my $port = shift;
670	my $init = shift;	778	my $init = shift;
671		779
		780	# rcv will create the actual port
672	local $SELF = "$NODE#$port";	781	local $SELF = "$NODE#$port";
673	eval {	782	eval {
674	&{ load_func $init }	783	&{ load_func $init }
675	};	784	};
676	_self_die if $@;	785	_self_die if $@;
677	}	786	}
678		787
679	sub spawn(@) {	788	sub spawn(@) {
680	my ($noderef, undef) = split /#/, shift, 2;	789	my ($nodeid, undef) = split /#/, shift, 2;
681		790
682	my $id = "$RUNIQ." . $ID++;	791	my $id = $RUNIQ . ++$ID;
683		792
684	$_[0] =~ /::/	793	$_[0] =~ /::/
685	or Carp::croak "spawn init function must be a fully-qualified name, caught";	794	or Carp::croak "spawn init function must be a fully-qualified name, caught";
686		795
687	($NODE{$noderef} \|\| add_node $noderef)	796	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
688	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
689		797
690	"$noderef#$id"	798	"$nodeid#$id"
691	}	799	}
692		800
693	=back
694		801
695	=head1 NODE MESSAGES	802	=item after $timeout, @msg
696		803
697	Nodes understand the following messages sent to them. Many of them take	804	=item after $timeout, $callback
698	arguments called C<@reply>, which will simply be used to compose a reply
699	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
700	the remaining arguments are simply the message data.
701		805
702	While other messages exist, they are not public and subject to change.	806	Either sends the given message, or call the given callback, after the
		807	specified number of seconds.
703		808
704	=over 4	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.
705		812
706	=cut	813	=cut
707		814
708	=item lookup => $name, @reply	815	sub after($@) {
		816	my ($timeout, @action) = @_;
709		817
710	Replies with the port ID of the specified well-known port, or C<undef>.	818	my $t; $t = AE::timer $timeout, 0, sub {
		819	undef $t;
		820	ref $action[0]
		821	? $action[0]()
		822	: snd @action;
		823	};
		824	}
711		825
712	=item devnull => ...	826	=item cal $port, @msg, $callback[, $timeout]
713		827
714	Generic data sink/CPU heat conversion.	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.
715		830
716	=item relay => $port, @msg	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.
717		833
718	Simply forwards the message to the given port.	834	A reply message sent to the port is passed to the C<$callback> as-is.
719		835
720	=item eval => $string[ @reply]	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.
721		839
722	Evaluates the given string. If C<@reply> is given, then a message of the	840	If no time-out is given (or it is C<undef>), then the local port will
723	form C<@reply, $@, @evalres> is sent.	841	monitor the remote port instead, so it eventually gets cleaned-up.
724		842
725	Example: crash another node.	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.
726		846
727	snd $othernode, eval => "exit";	847	=cut
728		848
729	=item time => @reply	849	sub cal(@) {
		850	my $timeout = ref $_[-1] ? undef : pop;
		851	my $cb = pop;
730		852
731	Replies the the current node time to C<@reply>.	853	my $port = port {
		854	undef $timeout;
		855	kil $SELF;
		856	&$cb;
		857	};
732		858
733	Example: tell the current node to send the current time to C<$myport> in a	859	if (defined $timeout) {
734	C<timereply> message.	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	}
735		871
736	snd $NODE, time => $myport, timereply => 1, 2;	872	push @_, $port;
737	# => snd $myport, timereply => 1, 2, <time>	873	&snd;
		874
		875	$port
		876	}
738		877
739	=back	878	=back
740		879
741	=head1 AnyEvent::MP vs. Distributed Erlang	880	=head1 AnyEvent::MP vs. Distributed Erlang
742		881
743	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
744	== 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
745	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
746	sample:	885	sample:
747		886
748	http://www.Erlang.se/doc/programming_rules.shtml	887	http://www.erlang.se/doc/programming_rules.shtml
749	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
750	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
751	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
752		891
753	Despite the similarities, there are also some important differences:	892	Despite the similarities, there are also some important differences:
754		893
755	=over 4	894	=over 4
756		895
757	=item * Node references contain the recipe on how to contact them.	896	=item * Node IDs are arbitrary strings in AEMP.
758		897
759	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
760	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
761	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.
762		902
763	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
764	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.
765		917
766	=item * Erlang uses processes and a mailbox, AEMP does not queue.	918	=item * Erlang uses processes and a mailbox, AEMP does not queue.
767		919
768	Erlang uses processes that selctively receive messages, and therefore	920	Erlang uses processes that selectively receive messages out of order, and
769	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
770	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.
771		925
772	(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.
773		931
774	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	932	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
775		933
776	Sending messages in Erlang is synchronous and blocks the process. AEMP	934	Sending messages in Erlang is synchronous and blocks the process until
777	sends are immediate, connection establishment is handled in the	935	a conenction has been established and the message sent (and so does not
778	background.	936	need a queue that can overflow). AEMP sends return immediately, connection
		937	establishment is handled in the background.
779		938
780	=item * Erlang can silently lose messages, AEMP cannot.	939	=item * Erlang suffers from silent message loss, AEMP does not.
781		940
782	Erlang makes few guarantees on messages delivery - messages can get lost	941	Erlang implements few guarantees on messages delivery - messages can get
783	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,
784	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).
785		944
786	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
787	holes in the message sequence.	948	no silent "holes" in the message sequence.
788		949
789	=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
790	alive.	951	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
791		952	simply tries to work better in common error cases, such as when a network
792	In Erlang it can happen that a monitored process is declared dead and	953	link goes down.
793	linked processes get killed, but later it turns out that the process is
794	still alive - and can receive messages.
795
796	In AEMP, when port monitoring detects a port as dead, then that port will
797	eventually be killed - it cannot happen that a node detects a port as dead
798	and then later sends messages to it, finding it is still alive.
799		954
800	=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.
801		956
802	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
803	ID known to other nodes for a completely different process, causing	958	process ID known to other nodes for a completely different process,
804	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.
805		961
806	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
807	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.
808		964
809	=item * Erlang uses unprotected connections, AEMP uses secure	965	=item * Erlang uses unprotected connections, AEMP uses secure
810	authentication and can use TLS.	966	authentication and can use TLS.
811		967
812	AEMP can use a proven protocol - SSL/TLS - to protect connections and	968	AEMP can use a proven protocol - TLS - to protect connections and
813	securely authenticate nodes.	969	securely authenticate nodes.
814		970
815	=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
816	communications.	972	communications.
817		973
818	The AEMP protocol, unlike the Erlang protocol, supports both	974	The AEMP protocol, unlike the Erlang protocol, supports both programming
819	language-independent text-only protocols (good for debugging) and binary,	975	language independent text-only protocols (good for debugging), and binary,
820	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.
821		978
822	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
823	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
824	protocol simple.	981	protocol simple.
825		982
826	=item * AEMP has more flexible monitoring options than Erlang.	983	=item * AEMP has more flexible monitoring options than Erlang.
827		984
828	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
829	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
830	difficult to implement. Monitoring in AEMP is more flexible than in	987	difficult to implement.
831	Erlang, as one can choose between automatic kill, exit message or callback	988
832	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.
833		991
834	=item * Erlang tries to hide remote/local connections, AEMP does not.	992	=item * Erlang tries to hide remote/local connections, AEMP does not.
835		993
836	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
837	as linking is (except linking is unreliable in Erlang).	995	same way as linking is (except linking is unreliable in Erlang).
838		996
839	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
840	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
841	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
842	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
843	more reliable.	1001	reliable (no need for C<spawn_link>).
844		1002
845	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
846	(hard to do in Erlang).	1004	(hard to do in Erlang).
847		1005
848	=back	1006	=back
849		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
850	=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.
851		1056
852	L<AnyEvent>.	1057	L<AnyEvent>.
853		1058
854	=head1 AUTHOR	1059	=head1 AUTHOR
855		1060

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.42 by root, Sun Aug 9 00:41:49 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.42 by root, Sun Aug 9 00:41:49 2009 UTC vs.
Revision 1.123 by root, Thu Mar 1 19:37:59 2012 UTC