ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent-MP/MP.pm

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.36 by root, Thu Aug 6 10:46:48 2009 UTC vs.
Revision 1.151 by root, Wed Aug 17 19:45:36 2016 UTC

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

Diff Legend

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