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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.47 by root, Thu Aug 13 01:57:10 2009 UTC vs. Revision 1.124 by root, Sat Mar 3 11:38:43 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.47 by root, Thu Aug 13 01:57:10 2009 UTC vs.
Revision 1.124 by root, Sat Mar 3 11:38:43 2012 UTC