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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.54 by root, Fri Aug 14 16:15:37 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 ports, the simple way	24	# creating/using ports, the simple way
28	my $simple_port = port { my @msg = @_; 0 };	25	my $simple_port = port { my @msg = @_ };
29		26
30	# creating/using ports, tagged message matching	27	# creating/using ports, tagged message matching
31	my $port = port;	28	my $port = port;
32	rcv $port, ping => sub { snd $_[0], "pong"; 0 };	29	rcv $port, ping => sub { snd $_[0], "pong" };
33	rcv $port, pong => sub { warn "pong received\n"; 0 };	30	rcv $port, pong => sub { warn "pong received\n" };
34		31
35	# create a port on another node	32	# create a port on another node
36	my $port = spawn $node, $initfunc, @initdata;	33	my $port = spawn $node, $initfunc, @initdata;
37		34
		35	# destroy a port again
		36	kil $port; # "normal" kill
		37	kil $port, my_error => "everything is broken"; # error kill
		38
38	# monitoring	39	# monitoring
39	mon $port, $cb->(@msg) # callback is invoked on death	40	mon $port, $cb->(@msg) # callback is invoked on death
40	mon $port, $otherport # kill otherport on abnormal death	41	mon $port, $localport # kill localport on abnormal death
41	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	};
42		51
43	=head1 CURRENT STATUS	52	=head1 CURRENT STATUS
44		53
		54	bin/aemp - stable.
45	AnyEvent::MP - stable API, should work	55	AnyEvent::MP - stable API, should work.
46	AnyEvent::MP::Intro - outdated	56	AnyEvent::MP::Intro - explains most concepts.
47	AnyEvent::MP::Kernel - WIP
48	AnyEvent::MP::Transport - mostly stable	57	AnyEvent::MP::Kernel - mostly stable API.
49		58	AnyEvent::MP::Global - stable API.
50	stay tuned.
51		59
52	=head1 DESCRIPTION	60	=head1 DESCRIPTION
53		61
54	This module (-family) implements a simple message passing framework.	62	This module (-family) implements a simple message passing framework.
55		63
56	Despite its simplicity, you can securely message other processes running	64	Despite its simplicity, you can securely message other processes running
57	on the same or other hosts.	65	on the same or other hosts, and you can supervise entities remotely.
58		66
59	For an introduction to this module family, see the L<AnyEvent::MP::Intro>	67	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
60	manual page.	68	manual page and the examples under F<eg/>.
61
62	At the moment, this module family is severly broken and underdocumented,
63	so do not use. This was uploaded mainly to reserve the CPAN namespace -
64	stay tuned!
65		69
66	=head1 CONCEPTS	70	=head1 CONCEPTS
67		71
68	=over 4	72	=over 4
69		73
70	=item port	74	=item port
71		75
72	A port is something you can send messages to (with the C<snd> function).	76	Not to be confused with a TCP port, a "port" is something you can send
		77	messages to (with the C<snd> function).
73		78
74	Ports allow you to register C<rcv> handlers that can match all or just	79	Ports allow you to register C<rcv> handlers that can match all or just
75	some messages. Messages will not be queued.	80	some messages. Messages send to ports will not be queued, regardless of
		81	anything was listening for them or not.
76		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
77	=item port id - C<noderef#portname>	85	=item port ID - C<nodeid#portname>
78		86
79	A port ID is 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<#>)
80	separator, and a port name (a printable string of unspecified format). An	88	as separator, and a port name (a printable string of unspecified
81	exception is the the node port, whose ID is identical to its node	89	format created by AnyEvent::MP).
82	reference.
83		90
84	=item node	91	=item node
85		92
86	A node is a single process containing at least one port - the node port,	93	A node is a single process containing at least one port - the node port,
87	which provides nodes to manage each other remotely, and to create new	94	which enables nodes to manage each other remotely, and to create new
88	ports.	95	ports.
89		96
90	Nodes are either private (single-process only), slaves (connected to a	97	Nodes are either public (have one or more listening ports) or private
91	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.
92		100
93	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	101	Nodes is represented by (printable) strings called "node IDs".
94		102
95	A node reference is a string that either simply identifies the node (for	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
96	private and slave nodes), or contains a recipe on how to reach a given
97	node (for public nodes).
98		104
99	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
100	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.
101		109
102	Node references come in two flavours: resolved (containing only numerical	110	=item binds - C<ip:port>
103	addresses) or unresolved (where hostnames are used instead of addresses).
104		111
105	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
106	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).
107		170
108	=back	171	=back
109		172
110	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
111		174
113		176
114	=cut	177	=cut
115		178
116	package AnyEvent::MP;	179	package AnyEvent::MP;
117		180
		181	use AnyEvent::MP::Config ();
118	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
119		184
120	use common::sense;	185	use common::sense;
121		186
122	use Carp ();	187	use Carp ();
123		188
124	use AE ();	189	use AE ();
		190	use Guard ();
125		191
126	use base "Exporter";	192	use base "Exporter";
127		193
128	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
129		195
130	our @EXPORT = qw(	196	our @EXPORT = qw(
131	NODE $NODE *SELF node_of _any_	197	NODE $NODE *SELF node_of after
132	resolve_node initialise_node	198	configure
133	snd rcv mon kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
134	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
135	);	203	);
136		204
137	our $SELF;	205	our $SELF;
138		206
139	sub _self_die() {	207	sub _self_die() {
…		…
142	kil $SELF, die => $msg;	210	kil $SELF, die => $msg;
143	}	211	}
144		212
145	=item $thisnode = NODE / $NODE	213	=item $thisnode = NODE / $NODE
146		214
147	The C<NODE> function returns, and the C<$NODE> variable contains the	215	The C<NODE> function returns, and the C<$NODE> variable contains, the node
148	noderef of the local node. The value is initialised by a call to	216	ID of the node running in the current process. This value is initialised by
149	C<initialise_node>.	217	a call to C<configure>.
150		218
151	=item $noderef = node_of $port	219	=item $nodeid = node_of $port
152		220
153	Extracts and returns the noderef from a port ID or a noderef.	221	Extracts and returns the node ID from a port ID or a node ID.
154		222
155	=item initialise_node $noderef, $seednode, $seednode...	223	=item configure $profile, key => value...
156		224
157	=item initialise_node "slave/", $master, $master...	225	=item configure key => value...
158		226
159	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
160	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
161	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.
162		231
163	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
164	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
165		234
166	All arguments (optionally except for the first) are noderefs, which can be	235	The key/value pairs are basically the same ones as documented for the
167	either resolved or unresolved.	236	F<aemp> command line utility (sans the set/del prefix), with these additions:
168
169	The first argument will be looked up in the configuration database first
170	(if it is C<undef> then the current nodename will be used instead) to find
171	the relevant configuration profile (see L<aemp>). If none is found then
172	the default configuration is used. The configuration supplies additional
173	seed/master nodes and can override the actual noderef.
174
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> (supplied either directly to	242	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
182	C<initialise_node> or indirectly via a profile or the nodename) must be a	243	be consulted - all configuraiton options must be specified in the
183	noderef (possibly unresolved, in which case it will be resolved).	244	C<configure> call.
184		245
185	After resolving, the node will bind itself on all endpoints and try to	246	=item force => $boolean (default false)
186	connect to all additional C<$seednodes> that are specified. Seednodes are
187	optional and can be used to quickly bootstrap the node into an existing
188	network.
189		247
190	=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.
191		251
192	When the C<$noderef> (either as given or overriden by the config file)	252	=item secure => $pass->(@msg)
193	is the special string C<slave/>, then the node will become a slave
194	node. Slave nodes cannot be contacted from outside and will route most of
195	their traffic to the master node that they attach to.
196		253
197	At least one additional noderef is required (either by specifying it	254	In addition to specifying a boolean, you can specify a code reference that
198	directly or because it is part of the configuration profile): The node	255	is called for every code execution attempt - the execution request is
199	will try to connect to all of them and will become a slave attached to the	256	granted iff the callback returns a true value.
200	first node it can successfully connect to.	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.
201		264
202	=back	265	=back
203		266
204	This function will block until all nodes have been resolved and, for slave
205	nodes, until it has successfully established a connection to a master
206	server.
207
208	Example: become a public node listening on the guessed noderef, or the one
209	specified via C<aemp> for the current node. This should be the most common
210	form of invocation for "daemon"-type nodes.
211
212	initialise_node;
213
214	Example: become a slave node to any of the the seednodes specified via
215	C<aemp>. This form is often used for commandline clients.
216
217	initialise_node "slave/";
218
219	Example: become a slave node to any of the specified master servers. This
220	form is also often used for commandline clients.
221
222	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
223
224	Example: become a public node, and try to contact some well-known master
225	servers to become part of the network.
226
227	initialise_node undef, "master1", "master2";
228
229	Example: become a public node listening on port C<4041>.
230
231	initialise_node 4041;
232
233	Example: become a public node, only visible on localhost port 4044.
234
235	initialise_node "localhost:4044";
236
237	=item $cv = resolve_node $noderef
238
239	Takes an unresolved node reference that may contain hostnames and
240	abbreviated IDs, resolves all of them and returns a resolved node
241	reference.
242
243	In addition to C<address:port> pairs allowed in resolved noderefs, the
244	following forms are supported:
245
246	=over 4	267	=over 4
247		268
248	=item the empty string	269	=item step 1, gathering configuration from profiles
249		270
250	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
251	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.
252		275
253	=item naked port numbers (e.g. C<1234>)	276	The profile data is then gathered as follows:
254		277
255	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
256	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).
257		283
258	=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.
259		287
260	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
261	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
262	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.
263		315
264	=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)"
265		343
266	=item $SELF	344	=item $SELF
267		345
268	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>
269	blocks.	347	blocks.
270		348
271	=item SELF, %SELF, @SELF...	349	=item *SELF, SELF, %SELF, @SELF...
272		350
273	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
274	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
275	module, but only C<$SELF> is currently used.	353	module, but only C<$SELF> is currently used.
276		354
277	=item snd $port, type => @data	355	=item snd $port, type => @data
278		356
279	=item snd $port, @msg	357	=item snd $port, @msg
280		358
281	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
282	a local or a remote port, and must be a port ID.	360	local or a remote port, and must be a port ID.
283		361
284	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
285	string as first element (a port ID, or some word that indicates a request	363	use a string as first element (a port ID, or some word that indicates a
286	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.
287		366
288	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
289	function: modifying any argument is not allowed and can cause many	368	function: modifying any argument (or values referenced by them) is
290	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.
291		373
292	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
293	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
294	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
295	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
296	node, anything can be passed.	378	node, anything can be passed. Best rely only on the common denominator of
		379	these.
297		380
298	=item $local_port = port	381	=item $local_port = port
299		382
300	Create a new local port object and returns its port ID. Initially it has	383	Create a new local port object and returns its port ID. Initially it has
301	no callbacks set and will throw an error when it receives messages.	384	no callbacks set and will throw an error when it receives messages.
…		…
320		403
321	=cut	404	=cut
322		405
323	sub rcv($@);	406	sub rcv($@);
324		407
325	sub _kilme {	408	my $KILME = sub {
326	die "received message on port without callback";	409	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
327	}	410	kil $SELF, unhandled_message => "no callback found for message '$tag'";
		411	};
328		412
329	sub port(;&) {	413	sub port(;&) {
330	my $id = "$UNIQ." . $ID++;	414	my $id = $UNIQ . ++$ID;
331	my $port = "$NODE#$id";	415	my $port = "$NODE#$id";
332		416
333	rcv $port, shift \|\| \&_kilme;	417	rcv $port, shift \|\| $KILME;
334		418
335	$port	419	$port
336	}	420	}
337		421
338	=item rcv $local_port, $callback->(@msg)	422	=item rcv $local_port, $callback->(@msg)
…		…
343		427
344	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
345	executing the callback. Runtime errors during callback execution will	429	executing the callback. Runtime errors during callback execution will
346	result in the port being C<kil>ed.	430	result in the port being C<kil>ed.
347		431
348	The default callback received all messages not matched by a more specific	432	The default callback receives all messages not matched by a more specific
349	C<tag> match.	433	C<tag> match.
350		434
351	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	435	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
352		436
353	Register (or replace) callbacks to be called on messages starting with the	437	Register (or replace) callbacks to be called on messages starting with the
…		…
374	msg1 => sub { ... },	458	msg1 => sub { ... },
375	...	459	...
376	;	460	;
377		461
378	Example: temporarily register a rcv callback for a tag matching some port	462	Example: temporarily register a rcv callback for a tag matching some port
379	(e.g. for a rpc reply) and unregister it after a message was received.	463	(e.g. for an rpc reply) and unregister it after a message was received.
380		464
381	rcv $port, $otherport => sub {	465	rcv $port, $otherport => sub {
382	my @reply = @_;	466	my @reply = @_;
383		467
384	rcv $SELF, $otherport;	468	rcv $SELF, $otherport;
…		…
386		470
387	=cut	471	=cut
388		472
389	sub rcv($@) {	473	sub rcv($@) {
390	my $port = shift;	474	my $port = shift;
391	my ($noderef, $portid) = split /#/, $port, 2;	475	my ($nodeid, $portid) = split /#/, $port, 2;
392		476
393	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}	477	$NODE{$nodeid} == $NODE{""}
394	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";
395		479
396	while (@_) {	480	while (@_) {
397	if (ref $_[0]) {	481	if (ref $_[0]) {
398	if (my $self = $PORT_DATA{$portid}) {	482	if (my $self = $PORT_DATA{$portid}) {
399	"AnyEvent::MP::Port" eq ref $self	483	"AnyEvent::MP::Port" eq ref $self
400	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	484	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
401		485
402	$self->[2] = shift;	486	$self->[0] = shift;
403	} else {	487	} else {
404	my $cb = shift;	488	my $cb = shift;
405	$PORT{$portid} = sub {	489	$PORT{$portid} = sub {
406	local $SELF = $port;	490	local $SELF = $port;
407	eval { &$cb }; _self_die if $@;	491	eval { &$cb }; _self_die if $@;
408	};	492	};
409	}	493	}
410	} elsif (defined $_[0]) {	494	} elsif (defined $_[0]) {
411	my $self = $PORT_DATA{$portid} \|\|= do {	495	my $self = $PORT_DATA{$portid} \|\|= do {
412	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	496	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
413		497
414	$PORT{$portid} = sub {	498	$PORT{$portid} = sub {
415	local $SELF = $port;	499	local $SELF = $port;
416		500
417	if (my $cb = $self->[1]{$_[0]}) {	501	if (my $cb = $self->[1]{$_[0]}) {
…		…
439	}	523	}
440		524
441	$port	525	$port
442	}	526	}
443		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
444	=item $closure = psub { BLOCK }	565	=item $closure = psub { BLOCK }
445		566
446	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
447	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>
448	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 }, @_ } >>.
449		573
450	This is useful when you register callbacks from C<rcv> callbacks:	574	This is useful when you register callbacks from C<rcv> callbacks:
451		575
452	rcv delayed_reply => sub {	576	rcv delayed_reply => sub {
453	my ($delay, @reply) = @_;	577	my ($delay, @reply) = @_;
…		…
477	$res	601	$res
478	}	602	}
479	}	603	}
480	}	604	}
481		605
482	=item $guard = mon $port, $cb->(@reason)	606	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
483		607
484	=item $guard = mon $port, $rcvport	608	=item $guard = mon $port # kill $SELF when $port dies
485		609
486	=item $guard = mon $port	610	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
487		611
488	=item $guard = mon $port, $rcvport, @msg	612	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
489		613
490	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
491	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
492	to stop monitoring again.	616	to stop monitoring again.
493		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
494	C<mon> effectively guarantees that, in the absence of hardware failures,	651	C<mon> effectively guarantees that, in the absence of hardware failures,
495	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
496	will arrive, or the monitoring action will be invoked after possible	653	arrive, or the monitoring action will be invoked after possible message
497	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
498	(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
499	port). After the monitoring action was invoked, further messages might get	656	port). After the monitoring action was invoked, further messages might get
500	delivered again.	657	delivered again.
501		658
502	In the first form (callback), the callback is simply called with any	659	Inter-host-connection timeouts and monitoring depend on the transport
503	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
504	"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
505	C<eval> if unsure.	662	non-idle connection, and usually around two hours for idle connections).
506		663
507	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
508	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
509	"normal" kils nothing happens, while under all other conditions, the other	666	to ensure some maximum latency.
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
516	C<snd>.
517
518	As a rule of thumb, monitoring requests should always monitor a port from
519	a local port (or callback). The reason is that kill messages might get
520	lost, just like any other message. Another less obvious reason is that
521	even monitoring requests can get lost (for exmaple, when the connection
522	to the other node goes down permanently). When monitoring a port locally
523	these problems do not exist.
524		667
525	Example: call a given callback when C<$port> is killed.	668	Example: call a given callback when C<$port> is killed.
526		669
527	mon $port, sub { warn "port died because of <@_>\n" };	670	mon $port, sub { warn "port died because of <@_>\n" };
528		671
…		…
535	mon $port, $self => "restart";	678	mon $port, $self => "restart";
536		679
537	=cut	680	=cut
538		681
539	sub mon {	682	sub mon {
540	my ($noderef, $port) = split /#/, shift, 2;	683	my ($nodeid, $port) = split /#/, shift, 2;
541		684
542	my $node = $NODE{$noderef} \|\| add_node $noderef;	685	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
543		686
544	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,';
545		688
546	unless (ref $cb) {	689	unless (ref $cb) {
547	if (@_) {	690	if (@_) {
…		…
556	}	699	}
557		700
558	$node->monitor ($port, $cb);	701	$node->monitor ($port, $cb);
559		702
560	defined wantarray	703	defined wantarray
561	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	704	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
562	}	705	}
563		706
564	=item $guard = mon_guard $port, $ref, $ref...	707	=item $guard = mon_guard $port, $ref, $ref...
565		708
566	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
567	is killed, the references will be freed.	710	is killed, the references will be freed.
568		711
569	Optionally returns a guard that will stop the monitoring.	712	Optionally returns a guard that will stop the monitoring.
570		713
571	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
572	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>):
573		716
574	$port->rcv (start => sub {	717	$port->rcv (start => sub {
575	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {	718	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
576	undef $timer if 0.9 < rand;	719	undef $timer if 0.9 < rand;
577	});	720	});
578	});	721	});
579		722
580	=cut	723	=cut
…		…
589		732
590	=item kil $port[, @reason]	733	=item kil $port[, @reason]
591		734
592	Kill the specified port with the given C<@reason>.	735	Kill the specified port with the given C<@reason>.
593		736
594	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" -
595	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.
596		740
597	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>
598	C<mon>, see below).	742	form) get killed with the same reason.
599		743
600	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
601	will be reported as reason C<< die => $@ >>.	745	will be reported as reason C<< die => $@ >>.
602		746
603	Transport/communication errors are reported as C<< transport_error =>	747	Transport/communication errors are reported as C<< transport_error =>
604	$message >>.	748	$message >>.
605		749
606	=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: $!";
607		761
608	=item $port = spawn $node, $initfunc[, @initdata]	762	=item $port = spawn $node, $initfunc[, @initdata]
609		763
610	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
611	case it's the node where that port resides).	765	case it's the node where that port resides).
612		766
613	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
614	permissible to immediately start sending messages or monitor the port.	768	possible to immediately start sending messages or to monitor the port.
615		769
616	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
617	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
618	(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
619	program, use C<::name>.	773	specify a function in the main program, use C<::name>.
620		774
621	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>
622	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.
623	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
624	exists or it runs out of package names.	778	exists or it runs out of package names.
625		779
626	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
627	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.
628		784
629	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
630	in the init function, monitor the original port. This two-way monitoring	786	port, and in the remote init function, immediately monitor the passed
631	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).
632		793
633	Example: spawn a chat server port on C<$othernode>.	794	Example: spawn a chat server port on C<$othernode>.
634		795
635	# this node, executed from within a port context:	796	# this node, executed from within a port context:
636	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	797	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
…		…
651		812
652	sub _spawn {	813	sub _spawn {
653	my $port = shift;	814	my $port = shift;
654	my $init = shift;	815	my $init = shift;
655		816
		817	# rcv will create the actual port
656	local $SELF = "$NODE#$port";	818	local $SELF = "$NODE#$port";
657	eval {	819	eval {
658	&{ load_func $init }	820	&{ load_func $init }
659	};	821	};
660	_self_die if $@;	822	_self_die if $@;
661	}	823	}
662		824
663	sub spawn(@) {	825	sub spawn(@) {
664	my ($noderef, undef) = split /#/, shift, 2;	826	my ($nodeid, undef) = split /#/, shift, 2;
665		827
666	my $id = "$RUNIQ." . $ID++;	828	my $id = $RUNIQ . ++$ID;
667		829
668	$_[0] =~ /::/	830	$_[0] =~ /::/
669	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";
670		832
671	($NODE{$noderef} \|\| add_node $noderef)	833	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
672	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
673		834
674	"$noderef#$id"	835	"$nodeid#$id"
675	}	836	}
676		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
677	=back	917	=back
678		918
679	=head1 NODE MESSAGES	919	=head1 DISTRIBUTED DATABASE
680		920
681	Nodes understand the following messages sent to them. Many of them take	921	AnyEvent::MP comes with a simple distributed database. The database will
682	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
683	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"
684	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.
685		926
686	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.:
687		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
688	=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.
689		1015
690	=cut	1016	=cut
691		1017
692	=item lookup => $name, @reply	1018	sub db_reg($$;$) {
		1019	my $family = shift;
		1020	my $port = @_ ? shift : $SELF;
693		1021
694	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;
695		1024
696	=item devnull => ...	1025	db_set $family => $port => $_[0];
697		1026
698	Generic data sink/CPU heat conversion.	1027	defined wantarray
		1028	and &Guard::guard ($clr)
		1029	}
699		1030
700	=item relay => $port, @msg	1031	=item db_family $family => $cb->(\%familyhash)
701		1032
702	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.
703		1035
704	=item eval => $string[ @reply]	1036	=item db_keys $family => $cb->(\@keys)
705		1037
706	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
707	form C<@reply, $@, @evalres> is sent.	1039	them as array reference to the callback.
708		1040
709	Example: crash another node.	1041	=item db_values $family => $cb->(\@values)
710		1042
711	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.
712		1045
713	=item time => @reply	1046	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
714		1047
715	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.
716		1053
717	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
718	C<timereply> message.	1055	destroyed, stops the monitor.
719		1056
720	snd $NODE, time => $myport, timereply => 1, 2;	1057	The family hash reference and the key arrays belong to AnyEvent::MP and
721	# => 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
722		1098
723	=back	1099	=back
724		1100
725	=head1 AnyEvent::MP vs. Distributed Erlang	1101	=head1 AnyEvent::MP vs. Distributed Erlang
726		1102
727	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
728	== 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
729	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
730	sample:	1106	sample:
731		1107
732	http://www.Erlang.se/doc/programming_rules.shtml	1108	http://www.erlang.se/doc/programming_rules.shtml
733	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
734	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
735	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
736		1112
737	Despite the similarities, there are also some important differences:	1113	Despite the similarities, there are also some important differences:
738		1114
739	=over 4	1115	=over 4
740		1116
741	=item * Node references contain the recipe on how to contact them.	1117	=item * Node IDs are arbitrary strings in AEMP.
742		1118
743	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
744	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
745	convenience functionality.	1121	configuration or DNS), and possibly the addresses of some seed nodes, but
746		1122	will otherwise discover other nodes (and their IDs) itself.
747	This means that AEMP requires a less tightly controlled environment at the
748	cost of longer node references and a slightly higher management overhead.
749		1123
750	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	1124	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
751	uses "local ports are like remote ports".	1125	uses "local ports are like remote ports".
752		1126
753	The failure modes for local ports are quite different (runtime errors	1127	The failure modes for local ports are quite different (runtime errors
…		…
762	ports being the special case/exception, where transport errors cannot	1136	ports being the special case/exception, where transport errors cannot
763	occur.	1137	occur.
764		1138
765	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1139	=item * Erlang uses processes and a mailbox, AEMP does not queue.
766		1140
767	Erlang uses processes that selectively receive messages, and therefore	1141	Erlang uses processes that selectively receive messages out of order, and
768	needs a queue. AEMP is event based, queuing messages would serve no	1142	therefore needs a queue. AEMP is event based, queuing messages would serve
769	useful purpose. For the same reason the pattern-matching abilities of	1143	no useful purpose. For the same reason the pattern-matching abilities
770	AnyEvent::MP are more limited, as there is little need to be able to	1144	of AnyEvent::MP are more limited, as there is little need to be able to
771	filter messages without dequeing them.	1145	filter messages without dequeuing them.
772		1146
773	(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.
774		1152
775	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1153	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
776		1154
777	Sending messages in Erlang is synchronous and blocks the process (and	1155	Sending messages in Erlang is synchronous and blocks the process until
		1156	a conenction has been established and the message sent (and so does not
778	so does not need a queue that can overflow). AEMP sends are immediate,	1157	need a queue that can overflow). AEMP sends return immediately, connection
779	connection establishment is handled in the background.	1158	establishment is handled in the background.
780		1159
781	=item * Erlang suffers from silent message loss, AEMP does not.	1160	=item * Erlang suffers from silent message loss, AEMP does not.
782		1161
783	Erlang makes few guarantees on messages delivery - messages can get lost	1162	Erlang implements few guarantees on messages delivery - messages can get
784	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,
785	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).
786		1165
787	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
788	holes in the message sequence.	1169	no silent "holes" in the message sequence.
789		1170
790	=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
791	alive.	1172	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
792		1173	simply tries to work better in common error cases, such as when a network
793	In Erlang it can happen that a monitored process is declared dead and	1174	link goes down.
794	linked processes get killed, but later it turns out that the process is
795	still alive - and can receive messages.
796
797	In AEMP, when port monitoring detects a port as dead, then that port will
798	eventually be killed - it cannot happen that a node detects a port as dead
799	and then later sends messages to it, finding it is still alive.
800		1175
801	=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.
802		1177
803	In Erlang it is quite likely that a node that restarts reuses a process ID	1178	In Erlang it is quite likely that a node that restarts reuses an Erlang
804	known to other nodes for a completely different process, causing messages	1179	process ID known to other nodes for a completely different process,
805	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.
806		1182
807	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
808	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.
809		1185
810	=item * Erlang uses unprotected connections, AEMP uses secure	1186	=item * Erlang uses unprotected connections, AEMP uses secure
811	authentication and can use TLS.	1187	authentication and can use TLS.
812		1188
813	AEMP can use a proven protocol - SSL/TLS - to protect connections and	1189	AEMP can use a proven protocol - TLS - to protect connections and
814	securely authenticate nodes.	1190	securely authenticate nodes.
815		1191
816	=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
817	communications.	1193	communications.
818		1194
819	The AEMP protocol, unlike the Erlang protocol, supports both	1195	The AEMP protocol, unlike the Erlang protocol, supports both programming
820	language-independent text-only protocols (good for debugging) and binary,	1196	language independent text-only protocols (good for debugging), and binary,
821	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.
822		1199
823	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
824	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
825	protocol simple.	1202	protocol simple.
826		1203
827	=item * AEMP has more flexible monitoring options than Erlang.	1204	=item * AEMP has more flexible monitoring options than Erlang.
828		1205
829	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
830	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
831	difficult to implement. Monitoring in AEMP is more flexible than in	1208	difficult to implement.
832	Erlang, as one can choose between automatic kill, exit message or callback	1209
833	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.
834		1212
835	=item * Erlang tries to hide remote/local connections, AEMP does not.	1213	=item * Erlang tries to hide remote/local connections, AEMP does not.
836		1214
837	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
838	as linking is (except linking is unreliable in Erlang).	1216	same way as linking is (except linking is unreliable in Erlang).
839		1217
840	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
841	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
842	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
843	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
844	more reliable.	1222	reliable (no need for C<spawn_link>).
845		1223
846	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
847	(hard to do in Erlang).	1225	(hard to do in Erlang).
848		1226
849	=back	1227	=back
850		1228
851	=head1 RATIONALE	1229	=head1 RATIONALE
852		1230
853	=over 4	1231	=over 4
854		1232
855	=item Why strings for ports and noderefs, why not objects?	1233	=item Why strings for port and node IDs, why not objects?
856		1234
857	We considered "objects", but found that the actual number of methods	1235	We considered "objects", but found that the actual number of methods
858	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
859	the network frequently, the serialising/deserialising would add lots of	1237	the network frequently, the serialising/deserialising would add lots of
860	overhead, as well as having to keep a proxy object.	1238	overhead, as well as having to keep a proxy object everywhere.
861		1239
862	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
863	procedures to be "valid".	1241	procedures to be "valid".
864		1242
865	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
866	can't become much cheaper.	1244	code reference stored in a global hash - it can't become much cheaper.
867		1245
868	=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?
869		1247
870	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
871	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
872	default.	1250	default (although all nodes will accept it).
873		1251
874	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
875	faster for small messages and b) most importantly, after years of	1253	faster for small messages and b) most importantly, after years of
876	experience we found that object serialisation is causing more problems	1254	experience we found that object serialisation is causing more problems
877	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
878	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
879	always have to re-think your design.	1257	always have to re-think your design.
880		1258
881	Keeping your messages simple, concentrating on data structures rather than	1259	Keeping your messages simple, concentrating on data structures rather than
882	objects, will keep your messages clean, tidy and efficient.	1260	objects, will keep your messages clean, tidy and efficient.
883		1261
884	=back	1262	=back
885		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
886	=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.
887		1382
888	L<AnyEvent>.	1383	L<AnyEvent>.
889		1384
890	=head1 AUTHOR	1385	=head1 AUTHOR
891		1386

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.54 by root, Fri Aug 14 16:15:37 2009 UTC vs. Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.54 by root, Fri Aug 14 16:15:37 2009 UTC vs.
Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC