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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.49 by root, Thu Aug 13 15:29:58 2009 UTC vs. Revision 1.114 by root, Thu Apr 22 16:06:19 2010 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.49 by root, Thu Aug 13 15:29:58 2009 UTC vs.
Revision 1.114 by root, Thu Apr 22 16:06:19 2010 UTC