ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent-MP/MP.pm

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.48 by root, Thu Aug 13 02:59:42 2009 UTC vs.
Revision 1.139 by root, Thu Mar 22 20:07:31 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
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 port 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 $port, $cb->(@msg) # callback is invoked on death
45	mon $port, $otherport # kill otherport on abnormal death	41	mon $port, $localport # kill localport on abnormal death
46	mon $port, $otherport, @msg # send message on death	42	mon $port, $localport, @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	Ports are represented by (printable) strings called "port IDs".
		84
83	=item port id - C<noderef#portname>	85	=item port ID - C<nodeid#portname>
84		86
85	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<#>)
86	separator, and a port name (a printable string of unspecified format). An	88	as separator, and a port name (a printable string of unspecified
87	exception is the the node port, whose ID is identical to its node	89	format created by AnyEvent::MP).
88	reference.
89		90
90	=item node	91	=item node
91		92
92	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,
93	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
94	create new ports, among other things.	95	ports.
95		96
96	Nodes are either private (single-process only), slaves (connected to a	97	Nodes are either public (have one or more listening ports) or private
97	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.
98		100
99	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	101	Nodes is represented by (printable) strings called "node IDs".
100		102
101	A node reference is a string that either simply identifies the node (for	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
102	private and slave nodes), or contains a recipe on how to reach a given
103	node (for public nodes).
104		104
105	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
106	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.
107		109
108	Node references come in two flavours: resolved (containing only numerical	110	=item binds - C<ip:port>
109	addresses) or unresolved (where hostnames are used instead of addresses).
110		111
111	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
112	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).
113		170
114	=back	171	=back
115		172
116	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
117		174
…		…
119		176
120	=cut	177	=cut
121		178
122	package AnyEvent::MP;	179	package AnyEvent::MP;
123		180
		181	use AnyEvent::MP::Config ();
124	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
125		184
126	use common::sense;	185	use common::sense;
127		186
128	use Carp ();	187	use Carp ();
129		188
130	use AE ();	189	use AE ();
		190	use Guard ();
131		191
132	use base "Exporter";	192	use base "Exporter";
133		193
134	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
135		195
136	our @EXPORT = qw(	196	our @EXPORT = qw(
137	NODE $NODE *SELF node_of _any_	197	NODE $NODE *SELF node_of after
138	resolve_node initialise_node	198	configure
139	snd rcv mon kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
140	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
141	);	203	);
142		204
143	our $SELF;	205	our $SELF;
144		206
145	sub _self_die() {	207	sub _self_die() {
…		…
148	kil $SELF, die => $msg;	210	kil $SELF, die => $msg;
149	}	211	}
150		212
151	=item $thisnode = NODE / $NODE	213	=item $thisnode = NODE / $NODE
152		214
153	The C<NODE> function returns, and the C<$NODE> variable contains	215	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	216	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	217	a call to C<configure>.
156	identifiers become invalid.
157		218
158	=item $noderef = node_of $port	219	=item $nodeid = node_of $port
159		220
160	Extracts and returns the noderef from a portid or a noderef.	221	Extracts and returns the node ID from a port ID or a node ID.
161		222
162	=item initialise_node $noderef, $seednode, $seednode...	223	=item configure $profile, key => value...
163		224
164	=item initialise_node "slave/", $master, $master...	225	=item configure key => value...
165		226
166	Before a node can talk to other nodes on the network it has to initialise	227	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	228	"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.	229	to know is its own name, and optionally it should know the addresses of
		230	some other nodes in the network to discover other nodes.
169		231
170	This function initialises a node - it must be called exactly once (or	232	This function configures a node - it must be called exactly once (or
171	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
172		234
173	All arguments are noderefs, which can be either resolved or unresolved.	235	The key/value pairs are basically the same ones as documented for the
174		236	F<aemp> command line utility (sans the set/del prefix), with these additions:
175	There are two types of networked nodes, public nodes and slave nodes:
176		237
177	=over 4	238	=over 4
178		239
179	=item public nodes	240	=item norc => $boolean (default false)
180		241
181	For public nodes, C<$noderef> must either be a (possibly unresolved)	242	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
182	noderef, in which case it will be resolved, or C<undef> (or missing), in	243	be consulted - all configuraiton options must be specified in the
183	which case the noderef will be guessed.	244	C<configure> call.
184		245
185	Afterwards, the node will bind itself on all endpoints and try to connect	246	=item force => $boolean (default false)
186	to all additional C<$seednodes> that are specified. Seednodes are optional
187	and can be used to quickly bootstrap the node into an existing network.
188		247
189	=item slave nodes	248	IF true, then the values specified in the C<configure> will take
		249	precedence over any values configured via the rc file. The default is for
		250	the rc file to override any options specified in the program.
190		251
191	When the C<$noderef> is the special string C<slave/>, then the node will	252	=item secure => $pass->(@msg)
192	become a slave node. Slave nodes cannot be contacted from outside and will
193	route most of their traffic to the master node that they attach to.
194		253
195	At least one additional noderef is required: The node will try to connect	254	In addition to specifying a boolean, you can specify a code reference that
196	to all of them and will become a slave attached to the first node it can	255	is called for every code execution attempt - the execution request is
197	successfully connect to.	256	granted iff the callback returns a true value.
		257
		258	Most of the time the callback should look only at
		259	C<$AnyEvent::MP::Kernel::SRCNODE> to make a decision, and not at the
		260	actual message (which can be about anything, and is mostly provided for
		261	diagnostic purposes).
		262
		263	See F<semp setsecure> for more info.
198		264
199	=back	265	=back
200		266
201	This function will block until all nodes have been resolved and, for slave
202	nodes, until it has successfully established a connection to a master
203	server.
204
205	Example: become a public node listening on the default node.
206
207	initialise_node;
208
209	Example: become a public node, and try to contact some well-known master
210	servers to become part of the network.
211
212	initialise_node undef, "master1", "master2";
213
214	Example: become a public node listening on port C<4041>.
215
216	initialise_node 4041;
217
218	Example: become a public node, only visible on localhost port 4044.
219
220	initialise_node "locahost:4044";
221
222	Example: become a slave node to any of the specified master servers.
223
224	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
225
226	=item $cv = resolve_node $noderef
227
228	Takes an unresolved node reference that may contain hostnames and
229	abbreviated IDs, resolves all of them and returns a resolved node
230	reference.
231
232	In addition to C<address:port> pairs allowed in resolved noderefs, the
233	following forms are supported:
234
235	=over 4	267	=over 4
236		268
237	=item the empty string	269	=item step 1, gathering configuration from profiles
238		270
239	An empty-string component gets resolved as if the default port (4040) was	271	The function first looks up a profile in the aemp configuration (see the
240	specified.	272	L<aemp> commandline utility). The profile name can be specified via the
		273	named C<profile> parameter or can simply be the first parameter). If it is
		274	missing, then the nodename (F<uname -n>) will be used as profile name.
241		275
242	=item naked port numbers (e.g. C<1234>)	276	The profile data is then gathered as follows:
243		277
244	These are resolved by prepending the local nodename and a colon, to be	278	First, all remaining key => value pairs (all of which are conveniently
245	further resolved.	279	undocumented at the moment) will be interpreted as configuration
		280	data. Then they will be overwritten by any values specified in the global
		281	default configuration (see the F<aemp> utility), then the chain of
		282	profiles chosen by the profile name (and any C<parent> attributes).
246		283
247	=item hostnames (e.g. C<localhost:1234>, C<localhost>)	284	That means that the values specified in the profile have highest priority
		285	and the values specified directly via C<configure> have lowest priority,
		286	and can only be used to specify defaults.
248		287
249	These are resolved by using AnyEvent::DNS to resolve them, optionally	288	If the profile specifies a node ID, then this will become the node ID of
250	looking up SRV records for the C<aemp=4040> port, if no port was	289	this process. If not, then the profile name will be used as node ID, with
251	specified.	290	a unique randoms tring (C</%u>) appended.
		291
		292	The node ID can contain some C<%> sequences that are expanded: C<%n>
		293	is expanded to the local nodename, C<%u> is replaced by a random
		294	strign to make the node unique. For example, the F<aemp> commandline
		295	utility uses C<aemp/%n/%u> as nodename, which might expand to
		296	C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
		297
		298	=item step 2, bind listener sockets
		299
		300	The next step is to look up the binds in the profile, followed by binding
		301	aemp protocol listeners on all binds specified (it is possible and valid
		302	to have no binds, meaning that the node cannot be contacted form the
		303	outside. This means the node cannot talk to other nodes that also have no
		304	binds, but it can still talk to all "normal" nodes).
		305
		306	If the profile does not specify a binds list, then a default of C<*> is
		307	used, meaning the node will bind on a dynamically-assigned port on every
		308	local IP address it finds.
		309
		310	=item step 3, connect to seed nodes
		311
		312	As the last step, the seed ID list from the profile is passed to the
		313	L<AnyEvent::MP::Global> module, which will then use it to keep
		314	connectivity with at least one node at any point in time.
252		315
253	=back	316	=back
		317
		318	Example: become a distributed node using the local node name as profile.
		319	This should be the most common form of invocation for "daemon"-type nodes.
		320
		321	configure
		322
		323	Example: become a semi-anonymous node. This form is often used for
		324	commandline clients.
		325
		326	configure nodeid => "myscript/%n/%u";
		327
		328	Example: configure a node using a profile called seed, which is suitable
		329	for a seed node as it binds on all local addresses on a fixed port (4040,
		330	customary for aemp).
		331
		332	# use the aemp commandline utility
		333	# aemp profile seed binds '*:4040'
		334
		335	# then use it
		336	configure profile => "seed";
		337
		338	# or simply use aemp from the shell again:
		339	# aemp run profile seed
		340
		341	# or provide a nicer-to-remember nodeid
		342	# aemp run profile seed nodeid "$(hostname)"
254		343
255	=item $SELF	344	=item $SELF
256		345
257	Contains the current port id while executing C<rcv> callbacks or C<psub>	346	Contains the current port id while executing C<rcv> callbacks or C<psub>
258	blocks.	347	blocks.
259		348
260	=item SELF, %SELF, @SELF...	349	=item *SELF, SELF, %SELF, @SELF...
261		350
262	Due to some quirks in how perl exports variables, it is impossible to	351	Due to some quirks in how perl exports variables, it is impossible to
263	just export C<$SELF>, all the symbols called C<SELF> are exported by this	352	just export C<$SELF>, all the symbols named C<SELF> are exported by this
264	module, but only C<$SELF> is currently used.	353	module, but only C<$SELF> is currently used.
265		354
266	=item snd $port, type => @data	355	=item snd $port, type => @data
267		356
268	=item snd $port, @msg	357	=item snd $port, @msg
269		358
270	Send the given message to the given port ID, which can identify either	359	Send the given message to the given port, which can identify either a
271	a local or a remote port, and can be either a string or soemthignt hat	360	local or a remote port, and must be a port ID.
272	stringifies a sa port ID (such as a port object :).
273		361
274	While the message can be about anything, it is highly recommended to use a	362	While the message can be almost anything, it is highly recommended to
275	string as first element (a portid, or some word that indicates a request	363	use a string as first element (a port ID, or some word that indicates a
276	type etc.).	364	request type etc.) and to consist if only simple perl values (scalars,
		365	arrays, hashes) - if you think you need to pass an object, think again.
277		366
278	The message data effectively becomes read-only after a call to this	367	The message data logically becomes read-only after a call to this
279	function: modifying any argument is not allowed and can cause many	368	function: modifying any argument (or values referenced by them) is
280	problems.	369	forbidden, as there can be considerable time between the call to C<snd>
		370	and the time the message is actually being serialised - in fact, it might
		371	never be copied as within the same process it is simply handed to the
		372	receiving port.
281		373
282	The type of data you can transfer depends on the transport protocol: when	374	The type of data you can transfer depends on the transport protocol: when
283	JSON is used, then only strings, numbers and arrays and hashes consisting	375	JSON is used, then only strings, numbers and arrays and hashes consisting
284	of those are allowed (no objects). When Storable is used, then anything	376	of those are allowed (no objects). When Storable is used, then anything
285	that Storable can serialise and deserialise is allowed, and for the local	377	that Storable can serialise and deserialise is allowed, and for the local
286	node, anything can be passed.	378	node, anything can be passed. Best rely only on the common denominator of
		379	these.
287		380
288	=item $local_port = port	381	=item $local_port = port
289		382
290	Create a new local port object that can be used either as a pattern	383	Create a new local port object and returns its port ID. Initially it has
291	matching port ("full port") or a single-callback port ("miniport"),	384	no callbacks set and will throw an error when it receives messages.
292	depending on how C<rcv> callbacks are bound to the object.
293		385
294	=item $port = port { my @msg = @_; $finished }	386	=item $local_port = port { my @msg = @_ }
295		387
296	Creates a "miniport", that is, a very lightweight port without any pattern	388	Creates a new local port, and returns its ID. Semantically the same as
297	matching behind it, and returns its ID. Semantically the same as creating
298	a port and calling C<rcv $port, $callback> on it.	389	creating a port and calling C<rcv $port, $callback> on it.
299		390
300	The block will be called for every message received on the port. When the	391	The block will be called for every message received on the port, with the
301	callback returns a true value its job is considered "done" and the port	392	global variable C<$SELF> set to the port ID. Runtime errors will cause the
302	will be destroyed. Otherwise it will stay alive.	393	port to be C<kil>ed. The message will be passed as-is, no extra argument
		394	(i.e. no port ID) will be passed to the callback.
303		395
304	The message will be passed as-is, no extra argument (i.e. no port id) will	396	If you want to stop/destroy the port, simply C<kil> it:
305	be passed to the callback.
306		397
307	If you need the local port id in the callback, this works nicely:	398	my $port = port {
308		399	my @msg = @_;
309	my $port; $port = port {	400	...
310	snd $otherport, reply => $port;	401	kil $SELF;
311	};	402	};
312		403
313	=cut	404	=cut
314		405
315	sub rcv($@);	406	sub rcv($@);
316		407
		408	my $KILME = sub {
		409	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
		410	kil $SELF, unhandled_message => "no callback found for message '$tag'";
		411	};
		412
317	sub port(;&) {	413	sub port(;&) {
318	my $id = "$UNIQ." . $ID++;	414	my $id = $UNIQ . ++$ID;
319	my $port = "$NODE#$id";	415	my $port = "$NODE#$id";
320		416
321	if (@_) {
322	rcv $port, shift;	417	rcv $port, shift || $KILME;
323	} else {
324	$PORT{$id} = sub { }; # nop
325	}
326		418
327	$port	419	$port
328	}	420	}
329		421
330	=item reg $port, $name
331
332	=item reg $name
333
334	Registers the given port (or C<$SELF><<< if missing) under the name
335	C<$name>. If the name already exists it is replaced.
336
337	A port can only be registered under one well known name.
338
339	A port automatically becomes unregistered when it is killed.
340
341	=cut
342
343	sub reg(@) {
344	my $port = @_ > 1 ? shift : $SELF || Carp::croak 'reg: called with one argument only, but $SELF not set,';
345
346	$REG{$_[0]} = $port;
347	}
348
349	=item rcv $port, $callback->(@msg)	422	=item rcv $local_port, $callback->(@msg)
350		423
351	Replaces the callback on the specified miniport (after converting it to	424	Replaces the default callback on the specified port. There is no way to
352	one if required).	425	remove the default callback: use C<sub { }> to disable it, or better
353		426	C<kil> the port when it is no longer needed.
354	=item rcv $port, tagstring => $callback->(@msg), ...
355
356	=item rcv $port, $smartmatch => $callback->(@msg), ...
357
358	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
359
360	Register callbacks to be called on matching messages on the given full
361	port (after converting it to one if required) and return the port.
362
363	The callback has to return a true value when its work is done, after
364	which is will be removed, or a false value in which case it will stay
365	registered.
366		427
367	The global C<$SELF> (exported by this module) contains C<$port> while	428	The global C<$SELF> (exported by this module) contains C<$port> while
368	executing the callback.	429	executing the callback. Runtime errors during callback execution will
		430	result in the port being C<kil>ed.
369		431
370	Runtime errors during callback execution will result in the port being	432	The default callback receives all messages not matched by a more specific
371	C<kil>ed.	433	C<tag> match.
372		434
373	If the match is an array reference, then it will be matched against the	435	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
374	first elements of the message, otherwise only the first element is being
375	matched.
376		436
377	Any element in the match that is specified as C<_any_> (a function	437	Register (or replace) callbacks to be called on messages starting with the
378	exported by this module) matches any single element of the message.	438	given tag on the given port (and return the port), or unregister it (when
		439	C<$callback> is C<$undef> or missing). There can only be one callback
		440	registered for each tag.
379		441
380	While not required, it is highly recommended that the first matching	442	The original message will be passed to the callback, after the first
381	element is a string identifying the message. The one-string-only match is	443	element (the tag) has been removed. The callback will use the same
382	also the most efficient match (by far).	444	environment as the default callback (see above).
383		445
384	Example: create a port and bind receivers on it in one go.	446	Example: create a port and bind receivers on it in one go.
385		447
386	my $port = rcv port,	448	my $port = rcv port,
387	msg1 => sub { ...; 0 },	449	msg1 => sub { ... },
388	msg2 => sub { ...; 0 },	450	msg2 => sub { ... },
389	;	451	;
390		452
391	Example: create a port, bind receivers and send it in a message elsewhere	453	Example: create a port, bind receivers and send it in a message elsewhere
392	in one go:	454	in one go:
393		455
394	snd $otherport, reply =>	456	snd $otherport, reply =>
395	rcv port,	457	rcv port,
396	msg1 => sub { ...; 0 },	458	msg1 => sub { ... },
397	...	459	...
398	;	460	;
399		461
		462	Example: temporarily register a rcv callback for a tag matching some port
		463	(e.g. for an rpc reply) and unregister it after a message was received.
		464
		465	rcv $port, $otherport => sub {
		466	my @reply = @_;
		467
		468	rcv $SELF, $otherport;
		469	};
		470
400	=cut	471	=cut
401		472
402	sub rcv($@) {	473	sub rcv($@) {
403	my $port = shift;	474	my $port = shift;
404	my ($noderef, $portid) = split /#/, $port, 2;	475	my ($nodeid, $portid) = split /#/, $port, 2;
405		476
406	($NODE{$noderef} || add_node $noderef) == $NODE{""}	477	$NODE{$nodeid} == $NODE{""}
407	or Carp::croak "$port: rcv can only be called on local ports, caught";	478	or Carp::croak "$port: rcv can only be called on local ports, caught";
408		479
409	if (@_ == 1) {	480	while (@_) {
		481	if (ref $_[0]) {
		482	if (my $self = $PORT_DATA{$portid}) {
		483	"AnyEvent::MP::Port" eq ref $self
		484	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		485
		486	$self->[0] = shift;
		487	} else {
410	my $cb = shift;	488	my $cb = shift;
411	delete $PORT_DATA{$portid};
412	$PORT{$portid} = sub {	489	$PORT{$portid} = sub {
413	local $SELF = $port;	490	local $SELF = $port;
414	eval {	491	eval { &$cb }; _self_die if $@;
415	&$cb	492	};
416	and kil $port;
417	};	493	}
418	_self_die if $@;	494	} elsif (defined $_[0]) {
419	};
420	} else {
421	my $self = $PORT_DATA{$portid} ||= do {	495	my $self = $PORT_DATA{$portid} ||= do {
422	my $self = bless {	496	my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
423	id => $port,
424	}, "AnyEvent::MP::Port";
425		497
426	$PORT{$portid} = sub {	498	$PORT{$portid} = sub {
427	local $SELF = $port;	499	local $SELF = $port;
428		500
429	eval {
430	for (@{ $self->{rc0}{$_[0]} }) {	501	if (my $cb = $self->[1]{$_[0]}) {
431	$_ && &{$_->[0]}	502	shift;
432	&& undef $_;	503	eval { &$cb }; _self_die if $@;
433	}	504	} else {
434
435	for (@{ $self->{rcv}{$_[0]} }) {
436	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
437	&& &{$_->[0]}	505	&{ $self->[0] };
438	&& undef $_;
439	}
440
441	for (@{ $self->{any} }) {
442	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
443	&& &{$_->[0]}
444	&& undef $_;
445	}	506	}
446	};	507	};
447	_self_die if $@;	508
		509	$self
448	};	510	};
449		511
450	$self
451	};
452
453	"AnyEvent::MP::Port" eq ref $self	512	"AnyEvent::MP::Port" eq ref $self
454	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	513	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
455		514
456	while (@_) {
457	my ($match, $cb) = splice @_, 0, 2;	515	my ($tag, $cb) = splice @_, 0, 2;
458		516
459	if (!ref $match) {	517	if (defined $cb) {
460	push @{ $self->{rc0}{$match} }, [$cb];	518	$self->[1]{$tag} = $cb;
461	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
462	my ($type, @match) = @$match;
463	@match
464	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
465	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
466	} else {	519	} else {
467	push @{ $self->{any} }, [$cb, $match];	520	delete $self->[1]{$tag};
468	}	521	}
469	}	522	}
470	}	523	}
471		524
472	$port	525	$port
473	}	526	}
474		527
		528	=item peval $port, $coderef[, @args]
		529
		530	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		531	when the code throews an exception the C<$port> will be killed.
		532
		533	Any remaining args will be passed to the callback. Any return values will
		534	be returned to the caller.
		535
		536	This is useful when you temporarily want to execute code in the context of
		537	a port.
		538
		539	Example: create a port and run some initialisation code in it's context.
		540
		541	my $port = port { ... };
		542
		543	peval $port, sub {
		544	init
		545	or die "unable to init";
		546	};
		547
		548	=cut
		549
		550	sub peval($$) {
		551	local $SELF = shift;
		552	my $cb = shift;
		553
		554	if (wantarray) {
		555	my @res = eval { &$cb };
		556	_self_die if $@;
		557	@res
		558	} else {
		559	my $res = eval { &$cb };
		560	_self_die if $@;
		561	$res
		562	}
		563	}
		564
475	=item $closure = psub { BLOCK }	565	=item $closure = psub { BLOCK }
476		566
477	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	567	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
478	closure is executed, sets up the environment in the same way as in C<rcv>	568	closure is executed, sets up the environment in the same way as in C<rcv>
479	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.	569	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		570
		571	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		572	BLOCK }, @_ } >>.
480		573
481	This is useful when you register callbacks from C<rcv> callbacks:	574	This is useful when you register callbacks from C<rcv> callbacks:
482		575
483	rcv delayed_reply => sub {	576	rcv delayed_reply => sub {
484	my ($delay, @reply) = @_;	577	my ($delay, @reply) = @_;
…		…
508	$res	601	$res
509	}	602	}
510	}	603	}
511	}	604	}
512		605
513	=item $guard = mon $port, $cb->(@reason)	606	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
514		607
515	=item $guard = mon $port, $rcvport	608	=item $guard = mon $port # kill $SELF when $port dies
516		609
517	=item $guard = mon $port	610	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
518		611
519	=item $guard = mon $port, $rcvport, @msg	612	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
520		613
521	Monitor the given port and do something when the port is killed or	614	Monitor the given port and do something when the port is killed or
522	messages to it were lost, and optionally return a guard that can be used	615	messages to it were lost, and optionally return a guard that can be used
523	to stop monitoring again.	616	to stop monitoring again.
524		617
		618	The first two forms distinguish between "normal" and "abnormal" kil's:
		619
		620	In the first form (another port given), if the C<$port> is C<kil>'ed with
		621	a non-empty reason, the other port (C<$rcvport>) will be kil'ed with the
		622	same reason. That is, on "normal" kil's nothing happens, while under all
		623	other conditions, the other port is killed with the same reason.
		624
		625	The second form (kill self) is the same as the first form, except that
		626	C<$rvport> defaults to C<$SELF>.
		627
		628	The remaining forms don't distinguish between "normal" and "abnormal" kil's
		629	- it's up to the callback or receiver to check whether the C<@reason> is
		630	empty and act accordingly.
		631
		632	In the third form (callback), the callback is simply called with any
		633	number of C<@reason> elements (empty @reason means that the port was deleted
		634	"normally"). Note also that I<< the callback B<must> never die >>, so use
		635	C<eval> if unsure.
		636
		637	In the last form (message), a message of the form C<$rcvport, @msg,
		638	@reason> will be C<snd>.
		639
		640	Monitoring-actions are one-shot: once messages are lost (and a monitoring
		641	alert was raised), they are removed and will not trigger again, even if it
		642	turns out that the port is still alive.
		643
		644	As a rule of thumb, monitoring requests should always monitor a remote
		645	port locally (using a local C<$rcvport> or a callback). The reason is that
		646	kill messages might get lost, just like any other message. Another less
		647	obvious reason is that even monitoring requests can get lost (for example,
		648	when the connection to the other node goes down permanently). When
		649	monitoring a port locally these problems do not exist.
		650
525	C<mon> effectively guarantees that, in the absence of hardware failures,	651	C<mon> effectively guarantees that, in the absence of hardware failures,
526	that after starting the monitor, either all messages sent to the port	652	after starting the monitor, either all messages sent to the port will
527	will arrive, or the monitoring action will be invoked after possible	653	arrive, or the monitoring action will be invoked after possible message
528	message loss has been detected. No messages will be lost "in between"	654	loss has been detected. No messages will be lost "in between" (after
529	(after the first lost message no further messages will be received by the	655	the first lost message no further messages will be received by the
530	port). After the monitoring action was invoked, further messages might get	656	port). After the monitoring action was invoked, further messages might get
531	delivered again.	657	delivered again.
532		658
533	In the first form (callback), the callback is simply called with any	659	Inter-host-connection timeouts and monitoring depend on the transport
534	number of C<@reason> elements (no @reason means that the port was deleted	660	used. The only transport currently implemented is TCP, and AnyEvent::MP
535	"normally"). Note also that I<< the callback B<must> never die >>, so use	661	relies on TCP to detect node-downs (this can take 10-15 minutes on a
536	C<eval> if unsure.	662	non-idle connection, and usually around two hours for idle connections).
537		663
538	In the second form (another port given), the other port (C<$rcvport>)	664	This means that monitoring is good for program errors and cleaning up
539	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on	665	stuff eventually, but they are no replacement for a timeout when you need
540	"normal" kils nothing happens, while under all other conditions, the other	666	to ensure some maximum latency.
541	port is killed with the same reason.
542
543	The third form (kill self) is the same as the second form, except that
544	C<$rvport> defaults to C<$SELF>.
545
546	In the last form (message), a message of the form C<@msg, @reason> will be
547	C<snd>.
548
549	As a rule of thumb, monitoring requests should always monitor a port from
550	a local port (or callback). The reason is that kill messages might get
551	lost, just like any other message. Another less obvious reason is that
552	even monitoring requests can get lost (for exmaple, when the connection
553	to the other node goes down permanently). When monitoring a port locally
554	these problems do not exist.
555		667
556	Example: call a given callback when C<$port> is killed.	668	Example: call a given callback when C<$port> is killed.
557		669
558	mon $port, sub { warn "port died because of <@_>\n" };	670	mon $port, sub { warn "port died because of <@_>\n" };
559		671
…		…
566	mon $port, $self => "restart";	678	mon $port, $self => "restart";
567		679
568	=cut	680	=cut
569		681
570	sub mon {	682	sub mon {
571	my ($noderef, $port) = split /#/, shift, 2;	683	my ($nodeid, $port) = split /#/, shift, 2;
572		684
573	my $node = $NODE{$noderef} || add_node $noderef;	685	my $node = $NODE{$nodeid} || add_node $nodeid;
574		686
575	my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';	687	my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
576		688
577	unless (ref $cb) {	689	unless (ref $cb) {
578	if (@_) {	690	if (@_) {
…		…
587	}	699	}
588		700
589	$node->monitor ($port, $cb);	701	$node->monitor ($port, $cb);
590		702
591	defined wantarray	703	defined wantarray
592	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	704	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
593	}	705	}
594		706
595	=item $guard = mon_guard $port, $ref, $ref...	707	=item $guard = mon_guard $port, $ref, $ref...
596		708
597	Monitors the given C<$port> and keeps the passed references. When the port	709	Monitors the given C<$port> and keeps the passed references. When the port
598	is killed, the references will be freed.	710	is killed, the references will be freed.
599		711
600	Optionally returns a guard that will stop the monitoring.	712	Optionally returns a guard that will stop the monitoring.
601		713
602	This function is useful when you create e.g. timers or other watchers and	714	This function is useful when you create e.g. timers or other watchers and
603	want to free them when the port gets killed:	715	want to free them when the port gets killed (note the use of C<psub>):
604		716
605	$port->rcv (start => sub {	717	$port->rcv (start => sub {
606	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {	718	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
607	undef $timer if 0.9 < rand;	719	undef $timer if 0.9 < rand;
608	});	720	});
609	});	721	});
610		722
611	=cut	723	=cut
…		…
620		732
621	=item kil $port[, @reason]	733	=item kil $port[, @reason]
622		734
623	Kill the specified port with the given C<@reason>.	735	Kill the specified port with the given C<@reason>.
624		736
625	If no C<@reason> is specified, then the port is killed "normally" (linked	737	If no C<@reason> is specified, then the port is killed "normally" -
626	ports will not be kileld, or even notified).	738	monitor callback will be invoked, but the kil will not cause linked ports
		739	(C<mon $mport, $lport> form) to get killed.
627		740
628	Otherwise, linked ports get killed with the same reason (second form of	741	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
629	C<mon>, see below).	742	form) get killed with the same reason.
630		743
631	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	744	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
632	will be reported as reason C<< die => $@ >>.	745	will be reported as reason C<< die => $@ >>.
633		746
634	Transport/communication errors are reported as C<< transport_error =>	747	Transport/communication errors are reported as C<< transport_error =>
635	$message >>.	748	$message >>.
636		749
637	=cut	750	Common idioms:
		751
		752	# silently remove yourself, do not kill linked ports
		753	kil $SELF;
		754
		755	# report a failure in some detail
		756	kil $SELF, failure_mode_1 => "it failed with too high temperature";
		757
		758	# do not waste much time with killing, just die when something goes wrong
		759	open my $fh, "<file"
		760	or die "file: $!";
638		761
639	=item $port = spawn $node, $initfunc[, @initdata]	762	=item $port = spawn $node, $initfunc[, @initdata]
640		763
641	Creates a port on the node C<$node> (which can also be a port ID, in which	764	Creates a port on the node C<$node> (which can also be a port ID, in which
642	case it's the node where that port resides).	765	case it's the node where that port resides).
643		766
644	The port ID of the newly created port is return immediately, and it is	767	The port ID of the newly created port is returned immediately, and it is
645	permissible to immediately start sending messages or monitor the port.	768	possible to immediately start sending messages or to monitor the port.
646		769
647	After the port has been created, the init function is	770	After the port has been created, the init function is called on the remote
648	called. This function must be a fully-qualified function name	771	node, in the same context as a C<rcv> callback. This function must be a
649	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main	772	fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
650	program, use C<::name>.	773	specify a function in the main program, use C<::name>.
651		774
652	If the function doesn't exist, then the node tries to C<require>	775	If the function doesn't exist, then the node tries to C<require>
653	the package, then the package above the package and so on (e.g.	776	the package, then the package above the package and so on (e.g.
654	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	777	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
655	exists or it runs out of package names.	778	exists or it runs out of package names.
656		779
657	The init function is then called with the newly-created port as context	780	The init function is then called with the newly-created port as context
658	object (C<$SELF>) and the C<@initdata> values as arguments.	781	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		782	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		783	the port might not get created.
659		784
660	A common idiom is to pass your own port, monitor the spawned port, and	785	A common idiom is to pass a local port, immediately monitor the spawned
661	in the init function, monitor the original port. This two-way monitoring	786	port, and in the remote init function, immediately monitor the passed
662	ensures that both ports get cleaned up when there is a problem.	787	local port. This two-way monitoring ensures that both ports get cleaned up
		788	when there is a problem.
		789
		790	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		791	caller before C<spawn> returns (by delaying invocation when spawn is
		792	called for the local node).
663		793
664	Example: spawn a chat server port on C<$othernode>.	794	Example: spawn a chat server port on C<$othernode>.
665		795
666	# this node, executed from within a port context:	796	# this node, executed from within a port context:
667	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	797	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
…		…
682		812
683	sub _spawn {	813	sub _spawn {
684	my $port = shift;	814	my $port = shift;
685	my $init = shift;	815	my $init = shift;
686		816
		817	# rcv will create the actual port
687	local $SELF = "$NODE#$port";	818	local $SELF = "$NODE#$port";
688	eval {	819	eval {
689	&{ load_func $init }	820	&{ load_func $init }
690	};	821	};
691	_self_die if $@;	822	_self_die if $@;
692	}	823	}
693		824
694	sub spawn(@) {	825	sub spawn(@) {
695	my ($noderef, undef) = split /#/, shift, 2;	826	my ($nodeid, undef) = split /#/, shift, 2;
696		827
697	my $id = "$RUNIQ." . $ID++;	828	my $id = $RUNIQ . ++$ID;
698		829
699	$_[0] =~ /::/	830	$_[0] =~ /::/
700	or Carp::croak "spawn init function must be a fully-qualified name, caught";	831	or Carp::croak "spawn init function must be a fully-qualified name, caught";
701		832
702	($NODE{$noderef} || add_node $noderef)	833	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
703	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
704		834
705	"$noderef#$id"	835	"$nodeid#$id"
706	}	836	}
707		837
		838
		839	=item after $timeout, @msg
		840
		841	=item after $timeout, $callback
		842
		843	Either sends the given message, or call the given callback, after the
		844	specified number of seconds.
		845
		846	This is simply a utility function that comes in handy at times - the
		847	AnyEvent::MP author is not convinced of the wisdom of having it, though,
		848	so it may go away in the future.
		849
		850	=cut
		851
		852	sub after($@) {
		853	my ($timeout, @action) = @_;
		854
		855	my $t; $t = AE::timer $timeout, 0, sub {
		856	undef $t;
		857	ref $action[0]
		858	? $action[0]()
		859	: snd @action;
		860	};
		861	}
		862
		863	#=item $cb2 = timeout $seconds, $cb[, @args]
		864
		865	=item cal $port, @msg, $callback[, $timeout]
		866
		867	A simple form of RPC - sends a message to the given C<$port> with the
		868	given contents (C<@msg>), but adds a reply port to the message.
		869
		870	The reply port is created temporarily just for the purpose of receiving
		871	the reply, and will be C<kil>ed when no longer needed.
		872
		873	A reply message sent to the port is passed to the C<$callback> as-is.
		874
		875	If an optional time-out (in seconds) is given and it is not C<undef>,
		876	then the callback will be called without any arguments after the time-out
		877	elapsed and the port is C<kil>ed.
		878
		879	If no time-out is given (or it is C<undef>), then the local port will
		880	monitor the remote port instead, so it eventually gets cleaned-up.
		881
		882	Currently this function returns the temporary port, but this "feature"
		883	might go in future versions unless you can make a convincing case that
		884	this is indeed useful for something.
		885
		886	=cut
		887
		888	sub cal(@) {
		889	my $timeout = ref $_[-1] ? undef : pop;
		890	my $cb = pop;
		891
		892	my $port = port {
		893	undef $timeout;
		894	kil $SELF;
		895	&$cb;
		896	};
		897
		898	if (defined $timeout) {
		899	$timeout = AE::timer $timeout, 0, sub {
		900	undef $timeout;
		901	kil $port;
		902	$cb->();
		903	};
		904	} else {
		905	mon $_[0], sub {
		906	kil $port;
		907	$cb->();
		908	};
		909	}
		910
		911	push @_, $port;
		912	&snd;
		913
		914	$port
		915	}
		916
708	=back	917	=back
709		918
710	=head1 NODE MESSAGES	919	=head1 DISTRIBUTED DATABASE
711		920
712	Nodes understand the following messages sent to them. Many of them take	921	AnyEvent::MP comes with a simple distributed database. The database will
713	arguments called C<@reply>, which will simply be used to compose a reply	922	be mirrored asynchronously on all global nodes. Other nodes bind to one
714	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and	923	of the global nodes for their needs. Every node has a "local database"
715	the remaining arguments are simply the message data.	924	which contains all the values that are set locally. All local databases
		925	are merged together to form the global database, which can be queried.
716		926
717	While other messages exist, they are not public and subject to change.	927	The database structure is that of a two-level hash - the database hash
		928	contains hashes which contain values, similarly to a perl hash of hashes,
		929	i.e.:
718		930
		931	$DATABASE{$family}{$subkey} = $value
		932
		933	The top level hash key is called "family", and the second-level hash key
		934	is called "subkey" or simply "key".
		935
		936	The family must be alphanumeric, i.e. start with a letter and consist
		937	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		938	pretty much like Perl module names.
		939
		940	As the family namespace is global, it is recommended to prefix family names
		941	with the name of the application or module using it.
		942
		943	The subkeys must be non-empty strings, with no further restrictions.
		944
		945	The values should preferably be strings, but other perl scalars should
		946	work as well (such as C<undef>, arrays and hashes).
		947
		948	Every database entry is owned by one node - adding the same family/subkey
		949	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		950	but the result might be nondeterministic, i.e. the key might have
		951	different values on different nodes.
		952
		953	Different subkeys in the same family can be owned by different nodes
		954	without problems, and in fact, this is the common method to create worker
		955	pools. For example, a worker port for image scaling might do this:
		956
		957	db_set my_image_scalers => $port;
		958
		959	And clients looking for an image scaler will want to get the
		960	C<my_image_scalers> keys from time to time:
		961
		962	db_keys my_image_scalers => sub {
		963	@ports = @{ $_[0] };
		964	};
		965
		966	Or better yet, they want to monitor the database family, so they always
		967	have a reasonable up-to-date copy:
		968
		969	db_mon my_image_scalers => sub {
		970	@ports = keys %{ $_[0] };
		971	};
		972
		973	In general, you can set or delete single subkeys, but query and monitor
		974	whole families only.
		975
		976	If you feel the need to monitor or query a single subkey, try giving it
		977	it's own family.
		978
719	=over 4	979	=over
		980
		981	=item $guard = db_set $family => $subkey [=> $value]
		982
		983	Sets (or replaces) a key to the database - if C<$value> is omitted,
		984	C<undef> is used instead.
		985
		986	When called in non-void context, C<db_set> returns a guard that
		987	automatically calls C<db_del> when it is destroyed.
		988
		989	=item db_del $family => $subkey...
		990
		991	Deletes one or more subkeys from the database family.
		992
		993	=item $guard = db_reg $family => $port => $value
		994
		995	=item $guard = db_reg $family => $port
		996
		997	=item $guard = db_reg $family
		998
		999	Registers a port in the given family and optionally returns a guard to
		1000	remove it.
		1001
		1002	This function basically does the same as:
		1003
		1004	db_set $family => $port => $value
		1005
		1006	Except that the port is monitored and automatically removed from the
		1007	database family when it is kil'ed.
		1008
		1009	If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
		1010	C<$SELF> is used.
		1011
		1012	This function is most useful to register a port in some port group (which
		1013	is just another name for a database family), and have it removed when the
		1014	port is gone. This works best when the port is a local port.
720		1015
721	=cut	1016	=cut
722		1017
723	=item lookup => $name, @reply	1018	sub db_reg($$;$) {
		1019	my $family = shift;
		1020	my $port = @_ ? shift : $SELF;
724		1021
725	Replies with the port ID of the specified well-known port, or C<undef>.	1022	my $clr = sub { db_del $family => $port };
		1023	mon $port, $clr;
726		1024
727	=item devnull => ...	1025	db_set $family => $port => $_[0];
728		1026
729	Generic data sink/CPU heat conversion.	1027	defined wantarray
		1028	and &Guard::guard ($clr)
		1029	}
730		1030
731	=item relay => $port, @msg	1031	=item db_family $family => $cb->(\%familyhash)
732		1032
733	Simply forwards the message to the given port.	1033	Queries the named database C<$family> and call the callback with the
		1034	family represented as a hash. You can keep and freely modify the hash.
734		1035
735	=item eval => $string[ @reply]	1036	=item db_keys $family => $cb->(\@keys)
736		1037
737	Evaluates the given string. If C<@reply> is given, then a message of the	1038	Same as C<db_family>, except it only queries the family I<subkeys> and passes
738	form C<@reply, $@, @evalres> is sent.	1039	them as array reference to the callback.
739		1040
740	Example: crash another node.	1041	=item db_values $family => $cb->(\@values)
741		1042
742	snd $othernode, eval => "exit";	1043	Same as C<db_family>, except it only queries the family I<values> and passes them
		1044	as array reference to the callback.
743		1045
744	=item time => @reply	1046	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
745		1047
746	Replies the the current node time to C<@reply>.	1048	Creates a monitor on the given database family. Each time a key is set
		1049	or or is deleted the callback is called with a hash containing the
		1050	database family and three lists of added, changed and deleted subkeys,
		1051	respectively. If no keys have changed then the array reference might be
		1052	C<undef> or even missing.
747		1053
748	Example: tell the current node to send the current time to C<$myport> in a	1054	If not called in void context, a guard object is returned that, when
749	C<timereply> message.	1055	destroyed, stops the monitor.
750		1056
751	snd $NODE, time => $myport, timereply => 1, 2;	1057	The family hash reference and the key arrays belong to AnyEvent::MP and
752	# => snd $myport, timereply => 1, 2, <time>	1058	B<must not be modified or stored> by the callback. When in doubt, make a
		1059	copy.
		1060
		1061	As soon as possible after the monitoring starts, the callback will be
		1062	called with the intiial contents of the family, even if it is empty,
		1063	i.e. there will always be a timely call to the callback with the current
		1064	contents.
		1065
		1066	It is possible that the callback is called with a change event even though
		1067	the subkey is already present and the value has not changed.
		1068
		1069	The monitoring stops when the guard object is destroyed.
		1070
		1071	Example: on every change to the family "mygroup", print out all keys.
		1072
		1073	my $guard = db_mon mygroup => sub {
		1074	my ($family, $a, $c, $d) = @_;
		1075	print "mygroup members: ", (join " ", keys %$family), "\n";
		1076	};
		1077
		1078	Exmaple: wait until the family "My::Module::workers" is non-empty.
		1079
		1080	my $guard; $guard = db_mon My::Module::workers => sub {
		1081	my ($family, $a, $c, $d) = @_;
		1082	return unless %$family;
		1083	undef $guard;
		1084	print "My::Module::workers now nonempty\n";
		1085	};
		1086
		1087	Example: print all changes to the family "AnyRvent::Fantasy::Module".
		1088
		1089	my $guard = db_mon AnyRvent::Fantasy::Module => sub {
		1090	my ($family, $a, $c, $d) = @_;
		1091
		1092	print "+$_=$family->{$_}\n" for @$a;
		1093	print "*$_=$family->{$_}\n" for @$c;
		1094	print "-$_=$family->{$_}\n" for @$d;
		1095	};
		1096
		1097	=cut
753		1098
754	=back	1099	=back
755		1100
756	=head1 AnyEvent::MP vs. Distributed Erlang	1101	=head1 AnyEvent::MP vs. Distributed Erlang
757		1102
758	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	1103	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
759	== aemp node, Erlang process == aemp port), so many of the documents and	1104	== aemp node, Erlang process == aemp port), so many of the documents and
760	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	1105	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
761	sample:	1106	sample:
762		1107
763	http://www.Erlang.se/doc/programming_rules.shtml	1108	http://www.erlang.se/doc/programming_rules.shtml
764	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	1109	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
765	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6	1110	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
766	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	1111	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
767		1112
768	Despite the similarities, there are also some important differences:	1113	Despite the similarities, there are also some important differences:
769		1114
770	=over 4	1115	=over 4
771		1116
772	=item * Node references contain the recipe on how to contact them.	1117	=item * Node IDs are arbitrary strings in AEMP.
773		1118
774	Erlang relies on special naming and DNS to work everywhere in the	1119	Erlang relies on special naming and DNS to work everywhere in the same
775	same way. AEMP relies on each node knowing it's own address(es), with	1120	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
776	convenience functionality.	1121	configuration or DNS), and possibly the addresses of some seed nodes, but
		1122	will otherwise discover other nodes (and their IDs) itself.
777		1123
778	This means that AEMP requires a less tightly controlled environment at the	1124	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
779	cost of longer node references and a slightly higher management overhead.	1125	uses "local ports are like remote ports".
		1126
		1127	The failure modes for local ports are quite different (runtime errors
		1128	only) then for remote ports - when a local port dies, you I<know> it dies,
		1129	when a connection to another node dies, you know nothing about the other
		1130	port.
		1131
		1132	Erlang pretends remote ports are as reliable as local ports, even when
		1133	they are not.
		1134
		1135	AEMP encourages a "treat remote ports differently" philosophy, with local
		1136	ports being the special case/exception, where transport errors cannot
		1137	occur.
780		1138
781	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1139	=item * Erlang uses processes and a mailbox, AEMP does not queue.
782		1140
783	Erlang uses processes that selctively receive messages, and therefore	1141	Erlang uses processes that selectively receive messages out of order, and
784	needs a queue. AEMP is event based, queuing messages would serve no useful	1142	therefore needs a queue. AEMP is event based, queuing messages would serve
785	purpose.	1143	no useful purpose. For the same reason the pattern-matching abilities
		1144	of AnyEvent::MP are more limited, as there is little need to be able to
		1145	filter messages without dequeuing them.
786		1146
787	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	1147	This is not a philosophical difference, but simply stems from AnyEvent::MP
		1148	being event-based, while Erlang is process-based.
		1149
		1150	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		1151	top of AEMP and Coro threads.
788		1152
789	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1153	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
790		1154
791	Sending messages in Erlang is synchronous and blocks the process. AEMP	1155	Sending messages in Erlang is synchronous and blocks the process until
792	sends are immediate, connection establishment is handled in the	1156	a conenction has been established and the message sent (and so does not
793	background.	1157	need a queue that can overflow). AEMP sends return immediately, connection
		1158	establishment is handled in the background.
794		1159
795	=item * Erlang can silently lose messages, AEMP cannot.	1160	=item * Erlang suffers from silent message loss, AEMP does not.
796		1161
797	Erlang makes few guarantees on messages delivery - messages can get lost	1162	Erlang implements few guarantees on messages delivery - messages can get
798	without any of the processes realising it (i.e. you send messages a, b,	1163	lost without any of the processes realising it (i.e. you send messages a,
799	and c, and the other side only receives messages a and c).	1164	b, and c, and the other side only receives messages a and c).
800		1165
801	AEMP guarantees correct ordering, and the guarantee that there are no	1166	AEMP guarantees (modulo hardware errors) correct ordering, and the
		1167	guarantee that after one message is lost, all following ones sent to the
		1168	same port are lost as well, until monitoring raises an error, so there are
802	holes in the message sequence.	1169	no silent "holes" in the message sequence.
803		1170
804	=item * In Erlang, processes can be declared dead and later be found to be	1171	If you want your software to be very reliable, you have to cope with
805	alive.	1172	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
806		1173	simply tries to work better in common error cases, such as when a network
807	In Erlang it can happen that a monitored process is declared dead and	1174	link goes down.
808	linked processes get killed, but later it turns out that the process is
809	still alive - and can receive messages.
810
811	In AEMP, when port monitoring detects a port as dead, then that port will
812	eventually be killed - it cannot happen that a node detects a port as dead
813	and then later sends messages to it, finding it is still alive.
814		1175
815	=item * Erlang can send messages to the wrong port, AEMP does not.	1176	=item * Erlang can send messages to the wrong port, AEMP does not.
816		1177
817	In Erlang it is quite possible that a node that restarts reuses a process	1178	In Erlang it is quite likely that a node that restarts reuses an Erlang
818	ID known to other nodes for a completely different process, causing	1179	process ID known to other nodes for a completely different process,
819	messages destined for that process to end up in an unrelated process.	1180	causing messages destined for that process to end up in an unrelated
		1181	process.
820		1182
821	AEMP never reuses port IDs, so old messages or old port IDs floating	1183	AEMP does not reuse port IDs, so old messages or old port IDs floating
822	around in the network will not be sent to an unrelated port.	1184	around in the network will not be sent to an unrelated port.
823		1185
824	=item * Erlang uses unprotected connections, AEMP uses secure	1186	=item * Erlang uses unprotected connections, AEMP uses secure
825	authentication and can use TLS.	1187	authentication and can use TLS.
826		1188
827	AEMP can use a proven protocol - SSL/TLS - to protect connections and	1189	AEMP can use a proven protocol - TLS - to protect connections and
828	securely authenticate nodes.	1190	securely authenticate nodes.
829		1191
830	=item * The AEMP protocol is optimised for both text-based and binary	1192	=item * The AEMP protocol is optimised for both text-based and binary
831	communications.	1193	communications.
832		1194
833	The AEMP protocol, unlike the Erlang protocol, supports both	1195	The AEMP protocol, unlike the Erlang protocol, supports both programming
834	language-independent text-only protocols (good for debugging) and binary,	1196	language independent text-only protocols (good for debugging), and binary,
835	language-specific serialisers (e.g. Storable).	1197	language-specific serialisers (e.g. Storable). By default, unless TLS is
		1198	used, the protocol is actually completely text-based.
836		1199
837	It has also been carefully designed to be implementable in other languages	1200	It has also been carefully designed to be implementable in other languages
838	with a minimum of work while gracefully degrading fucntionality to make the	1201	with a minimum of work while gracefully degrading functionality to make the
839	protocol simple.	1202	protocol simple.
840		1203
841	=item * AEMP has more flexible monitoring options than Erlang.	1204	=item * AEMP has more flexible monitoring options than Erlang.
842		1205
843	In Erlang, you can chose to receive I<all> exit signals as messages	1206	In Erlang, you can chose to receive I<all> exit signals as messages or
844	or I<none>, there is no in-between, so monitoring single processes is	1207	I<none>, there is no in-between, so monitoring single Erlang processes is
845	difficult to implement. Monitoring in AEMP is more flexible than in	1208	difficult to implement.
846	Erlang, as one can choose between automatic kill, exit message or callback	1209
847	on a per-process basis.	1210	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		1211	between automatic kill, exit message or callback on a per-port basis.
848		1212
849	=item * Erlang tries to hide remote/local connections, AEMP does not.	1213	=item * Erlang tries to hide remote/local connections, AEMP does not.
850		1214
851	Monitoring in Erlang is not an indicator of process death/crashes,	1215	Monitoring in Erlang is not an indicator of process death/crashes, in the
852	as linking is (except linking is unreliable in Erlang).	1216	same way as linking is (except linking is unreliable in Erlang).
853		1217
854	In AEMP, you don't "look up" registered port names or send to named ports	1218	In AEMP, you don't "look up" registered port names or send to named ports
855	that might or might not be persistent. Instead, you normally spawn a port	1219	that might or might not be persistent. Instead, you normally spawn a port
856	on the remote node. The init function monitors the you, and you monitor	1220	on the remote node. The init function monitors you, and you monitor the
857	the remote port. Since both monitors are local to the node, they are much	1221	remote port. Since both monitors are local to the node, they are much more
858	more reliable.	1222	reliable (no need for C<spawn_link>).
859		1223
860	This also saves round-trips and avoids sending messages to the wrong port	1224	This also saves round-trips and avoids sending messages to the wrong port
861	(hard to do in Erlang).	1225	(hard to do in Erlang).
862		1226
863	=back	1227	=back
864		1228
865	=head1 RATIONALE	1229	=head1 RATIONALE
866		1230
867	=over 4	1231	=over 4
868		1232
869	=item Why strings for ports and noderefs, why not objects?	1233	=item Why strings for port and node IDs, why not objects?
870		1234
871	We considered "objects", but found that the actual number of methods	1235	We considered "objects", but found that the actual number of methods
872	thatc an be called are very low. Since port IDs and noderefs travel over	1236	that can be called are quite low. Since port and node IDs travel over
873	the network frequently, the serialising/deserialising would add lots of	1237	the network frequently, the serialising/deserialising would add lots of
874	overhead, as well as having to keep a proxy object.	1238	overhead, as well as having to keep a proxy object everywhere.
875		1239
876	Strings can easily be printed, easily serialised etc. and need no special	1240	Strings can easily be printed, easily serialised etc. and need no special
877	procedures to be "valid".	1241	procedures to be "valid".
878		1242
879	And a a miniport consists of a single closure stored in a global hash - it	1243	And as a result, a port with just a default receiver consists of a single
880	can't become much cheaper.	1244	code reference stored in a global hash - it can't become much cheaper.
881		1245
882	=item Why favour JSON, why not real serialising format such as Storable?	1246	=item Why favour JSON, why not a real serialising format such as Storable?
883		1247
884	In fact, any AnyEvent::MP node will happily accept Storable as framing	1248	In fact, any AnyEvent::MP node will happily accept Storable as framing
885	format, but currently there is no way to make a node use Storable by	1249	format, but currently there is no way to make a node use Storable by
886	default.	1250	default (although all nodes will accept it).
887		1251
888	The default framing protocol is JSON because a) JSON::XS is many times	1252	The default framing protocol is JSON because a) JSON::XS is many times
889	faster for small messages and b) most importantly, after years of	1253	faster for small messages and b) most importantly, after years of
890	experience we found that object serialisation is causing more problems	1254	experience we found that object serialisation is causing more problems
891	than it gains: Just like function calls, objects simply do not travel	1255	than it solves: Just like function calls, objects simply do not travel
892	easily over the network, mostly because they will always be a copy, so you	1256	easily over the network, mostly because they will always be a copy, so you
893	always have to re-think your design.	1257	always have to re-think your design.
894		1258
895	Keeping your messages simple, concentrating on data structures rather than	1259	Keeping your messages simple, concentrating on data structures rather than
896	objects, will keep your messages clean, tidy and efficient.	1260	objects, will keep your messages clean, tidy and efficient.
897		1261
898	=back	1262	=back
899		1263
		1264	=head1 PORTING FROM AnyEvent::MP VERSION 1.X
		1265
		1266	AEMP version 2 has a few major incompatible changes compared to version 1:
		1267
		1268	=over 4
		1269
		1270	=item AnyEvent::MP::Global no longer has group management functions.
		1271
		1272	AnyEvent::MP now comes with a distributed database that is more
		1273	powerful. Its database families map closely to port groups, but the API
		1274	has changed (the functions are also now exported by AnyEvent::MP). Here is
		1275	a rough porting guide:
		1276
		1277	grp_reg $group, $port # old
		1278	db_reg $group, $port # new
		1279
		1280	$list = grp_get $group # old
		1281	db_keys $group, sub { my $list = shift } # new
		1282
		1283	grp_mon $group, $cb->(\@ports, $add, $del) # old
		1284	db_mon $group, $cb->(\%ports, $add, $change, $del) # new
		1285
		1286	C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> is
		1287	no longer instant, because the local node might not have a copy of the
		1288	group. You can either modify your code to allow for a callback, or use
		1289	C<db_mon> to keep an updated copy of the group:
		1290
		1291	my $local_group_copy;
		1292	db_mon $group => sub { $local_group_copy = $_[0] };
		1293
		1294	# now "keys %$local_group_copy" always returns the most up-to-date
		1295	# list of ports in the group.
		1296
		1297	C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon>
		1298	passes a hash as first argument, and an extra C<$chg> argument that can be
		1299	ignored:
		1300
		1301	db_mon $group => sub {
		1302	my ($ports, $add, $chg, $lde) = @_;
		1303	$ports = [keys %$ports];
		1304
		1305	# now $ports, $add and $del are the same as
		1306	# were originally passed by grp_mon.
		1307	...
		1308	};
		1309
		1310	=item Nodes not longer connect to all other nodes.
		1311
		1312	In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
		1313	module, which in turn would create connections to all other nodes in the
		1314	network (helped by the seed nodes).
		1315
		1316	In version 2.x, global nodes still connect to all other global nodes, but
		1317	other nodes don't - now every node either is a global node itself, or
		1318	attaches itself to another global node.
		1319
		1320	If a node isn't a global node itself, then it attaches itself to one
		1321	of its seed nodes. If that seed node isn't a global node yet, it will
		1322	automatically be upgraded to a global node.
		1323
		1324	So in many cases, nothing needs to be changed - one just has to make sure
		1325	that all seed nodes are meshed together with the other seed nodes (as with
		1326	AEMP 1.x), and other nodes specify them as seed nodes. This is most easily
		1327	achieved by specifying the same set of seed nodes for all nodes in the
		1328	network.
		1329
		1330	Not opening a connection to every other node is usually an advantage,
		1331	except when you need the lower latency of an already established
		1332	connection. To ensure a node establishes a connection to another node,
		1333	you can monitor the node port (C<mon $node, ...>), which will attempt to
		1334	create the connection (and notify you when the connection fails).
		1335
		1336	=item Listener-less nodes (nodes without binds) are gone.
		1337
		1338	And are not coming back, at least not in their old form. If no C<binds>
		1339	are specified for a node, AnyEvent::MP assumes a default of C<*:*>.
		1340
		1341	There are vague plans to implement some form of routing domains, which
		1342	might or might not bring back listener-less nodes, but don't count on it.
		1343
		1344	The fact that most connections are now optional somewhat mitigates this,
		1345	as a node can be effectively unreachable from the outside without any
		1346	problems, as long as it isn't a global node and only reaches out to other
		1347	nodes (as opposed to being contacted from other nodes).
		1348
		1349	=item $AnyEvent::MP::Kernel::WARN has gone.
		1350
		1351	AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
		1352	uses this, and so should your programs.
		1353
		1354	Every module now documents what kinds of messages it generates, with
		1355	AnyEvent::MP acting as a catch all.
		1356
		1357	On the positive side, this means that instead of setting
		1358	C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE> -
		1359	much less to type.
		1360
		1361	=back
		1362
		1363	=head1 LOGGING
		1364
		1365	AnyEvent::MP does not normally log anything by itself, but sinc eit is the
		1366	root of the contetx hierarchy for AnyEvent::MP modules, it will receive
		1367	all log messages by submodules.
		1368
900	=head1 SEE ALSO	1369	=head1 SEE ALSO
		1370
		1371	L<AnyEvent::MP::Intro> - a gentle introduction.
		1372
		1373	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
		1374
		1375	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
		1376	your applications.
		1377
		1378	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
		1379
		1380	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
		1381	all nodes.
901		1382
902	L<AnyEvent>.	1383	L<AnyEvent>.
903		1384
904	=head1 AUTHOR	1385	=head1 AUTHOR
905		1386

Diff Legend

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