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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.76 by root, Mon Aug 31 18:45:05 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
30	rcv $port, pong => sub { warn "pong received\n" };	30	rcv $port, pong => sub { warn "pong received\n" };
31		31
32	# create a port on another node	32	# create a port on another node
33	my $port = spawn $node, $initfunc, @initdata;	33	my $port = spawn $node, $initfunc, @initdata;
34		34
		35	# destroy a port again
		36	kil $port; # "normal" kill
		37	kil $port, my_error => "everything is broken"; # error kill
		38
35	# monitoring	39	# monitoring
36	mon $port, $cb->(@msg) # callback is invoked on death	40	mon $port, $cb->(@msg) # callback is invoked on death
37	mon $port, $otherport # kill otherport on abnormal death	41	mon $port, $localport # kill localport on abnormal death
38	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	};
39		51
40	=head1 CURRENT STATUS	52	=head1 CURRENT STATUS
41		53
42	bin/aemp - stable.	54	bin/aemp - stable.
43	AnyEvent::MP - stable API, should work.	55	AnyEvent::MP - stable API, should work.
44	AnyEvent::MP::Intro - epxlains most concepts.	56	AnyEvent::MP::Intro - explains most concepts.
45	AnyEvent::MP::Kernel - mostly stable.	57	AnyEvent::MP::Kernel - mostly stable API.
46	AnyEvent::MP::Global - stable API, protocol not yet final.	58	AnyEvent::MP::Global - stable API.
47
48	stay tuned.
49		59
50	=head1 DESCRIPTION	60	=head1 DESCRIPTION
51		61
52	This module (-family) implements a simple message passing framework.	62	This module (-family) implements a simple message passing framework.
53		63
…		…
61		71
62	=over 4	72	=over 4
63		73
64	=item port	74	=item port
65		75
66	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).
67		78
68	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
69	some messages. Messages send to ports will not be queued, regardless of	80	some messages. Messages send to ports will not be queued, regardless of
70	anything was listening for them or not.	81	anything was listening for them or not.
71		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
72	=item port ID - C<nodeid#portname>	85	=item port ID - C<nodeid#portname>
73		86
74	A port ID is the concatenation of a node ID, a hash-mark (C<#>) as	87	A port ID is the concatenation of a node ID, a hash-mark (C<#>)
75	separator, and a port name (a printable string of unspecified format).	88	as separator, and a port name (a printable string of unspecified
		89	format created by AnyEvent::MP).
76		90
77	=item node	91	=item node
78		92
79	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,
80	which enables nodes to manage each other remotely, and to create new	94	which enables nodes to manage each other remotely, and to create new
81	ports.	95	ports.
82		96
83	Nodes are either public (have one or more listening ports) or private	97	Nodes are either public (have one or more listening ports) or private
84	(no listening ports). Private nodes cannot talk to other private nodes	98	(no listening ports). Private nodes cannot talk to other private nodes
85	currently.	99	currently, but all nodes can talk to public nodes.
86		100
		101	Nodes is represented by (printable) strings called "node IDs".
		102
87	=item node ID - C<[a-za-Z0-9_\-.:]+>	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
88		104
89	A node ID is a string that uniquely identifies the node within a	105	A node ID is a string that uniquely identifies the node within a
90	network. Depending on the configuration used, node IDs can look like a	106	network. Depending on the configuration used, node IDs can look like a
91	hostname, a hostname and a port, or a random string. AnyEvent::MP itself	107	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
92	doesn't interpret node IDs in any way.	108	doesn't interpret node IDs in any way except to uniquely identify a node.
93		109
94	=item binds - C<ip:port>	110	=item binds - C<ip:port>
95		111
96	Nodes can only talk to each other by creating some kind of connection to	112	Nodes can only talk to each other by creating some kind of connection to
97	each other. To do this, nodes should listen on one or more local transport	113	each other. To do this, nodes should listen on one or more local transport
		114	endpoints - binds.
		115
98	endpoints - binds. Currently, only standard C<ip:port> specifications can	116	Currently, only standard C<ip:port> specifications can be used, which
99	be used, which specify TCP ports to listen on.	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.
100		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
101	=item seeds - C<host:port>	149	=item seed IDs - C<host:port>
102		150
103	When a node starts, it knows nothing about the network. To teach the node	151	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
104	about the network it first has to contact some other node within the	152	TCP port) of nodes that should be used as seed nodes.
105	network. This node is called a seed.
106		153
107	Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes	154	=item global nodes
108	are expected to be long-running, and at least one of those should always
109	be available. When nodes run out of connections (e.g. due to a network
110	error), they try to re-establish connections to some seednodes again to
111	join the network.
112		155
113	Apart from being sued for seeding, seednodes are not special in any way -	156	An AEMP network needs a discovery service - nodes need to know how to
114	every public node can be a seednode.	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).
115		170
116	=back	171	=back
117		172
118	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
119		174
…		…
121		176
122	=cut	177	=cut
123		178
124	package AnyEvent::MP;	179	package AnyEvent::MP;
125		180
		181	use AnyEvent::MP::Config ();
126	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
127		184
128	use common::sense;	185	use common::sense;
129		186
130	use Carp ();	187	use Carp ();
131		188
132	use AE ();	189	use AE ();
		190	use Guard ();
133		191
134	use base "Exporter";	192	use base "Exporter";
135		193
136	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
137		195
138	our @EXPORT = qw(	196	our @EXPORT = qw(
139	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
140	configure	198	configure
141	snd rcv mon mon_guard kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
142	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
143	);	203	);
144		204
145	our $SELF;	205	our $SELF;
146		206
147	sub _self_die() {	207	sub _self_die() {
…		…
158		218
159	=item $nodeid = node_of $port	219	=item $nodeid = node_of $port
160		220
161	Extracts and returns the node ID from a port ID or a node ID.	221	Extracts and returns the node ID from a port ID or a node ID.
162		222
		223	=item configure $profile, key => value...
		224
163	=item configure key => value...	225	=item configure key => value...
164		226
165	Before a node can talk to other nodes on the network (i.e. enter	227	Before a node can talk to other nodes on the network (i.e. enter
166	"distributed mode") it has to configure itself - the minimum a node needs	228	"distributed mode") it has to configure itself - the minimum a node needs
167	to know is its own name, and optionally it should know the addresses of	229	to know is its own name, and optionally it should know the addresses of
168	some other nodes in the network to discover other nodes.	230	some other nodes in the network to discover other nodes.
169		231
170	This function configures a node - it must be called exactly once (or	232	This function configures a node - it must be called exactly once (or
171	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
172		234
		235	The key/value pairs are basically the same ones as documented for the
		236	F<aemp> command line utility (sans the set/del prefix), with these additions:
		237
		238	=over 4
		239
		240	=item norc => $boolean (default false)
		241
		242	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
		243	be consulted - all configuraiton options must be specified in the
		244	C<configure> call.
		245
		246	=item force => $boolean (default false)
		247
		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.
		251
		252	=item secure => $pass->(@msg)
		253
		254	In addition to specifying a boolean, you can specify a code reference that
		255	is called for every code execution attempt - the execution request is
		256	granted iff the callback returns a true value.
		257
		258	Most of the time the callback should look only at
		259	C<$AnyEvent::MP::Kernel::SRCNODE> to make a decision, and not at the
		260	actual message (which can be about anything, and is mostly provided for
		261	diagnostic purposes).
		262
		263	See F<semp setsecure> for more info.
		264
		265	=back
		266
173	=over 4	267	=over 4
174		268
175	=item step 1, gathering configuration from profiles	269	=item step 1, gathering configuration from profiles
176		270
177	The function first looks up a profile in the aemp configuration (see the	271	The function first looks up a profile in the aemp configuration (see the
178	L<aemp> commandline utility). The profile name can be specified via the	272	L<aemp> commandline utility). The profile name can be specified via the
179	named C<profile> parameter. If it is missing, then the nodename (F<uname	273	named C<profile> parameter or can simply be the first parameter). If it is
180	-n>) will be used as profile name.	274	missing, then the nodename (F<uname -n>) will be used as profile name.
181		275
182	The profile data is then gathered as follows:	276	The profile data is then gathered as follows:
183		277
184	First, all remaining key => value pairs (all of which are conviniently	278	First, all remaining key => value pairs (all of which are conveniently
185	undocumented at the moment) will be interpreted as configuration	279	undocumented at the moment) will be interpreted as configuration
186	data. Then they will be overwritten by any values specified in the global	280	data. Then they will be overwritten by any values specified in the global
187	default configuration (see the F<aemp> utility), then the chain of	281	default configuration (see the F<aemp> utility), then the chain of
188	profiles chosen by the profile name (and any C<parent> attributes).	282	profiles chosen by the profile name (and any C<parent> attributes).
189		283
190	That means that the values specified in the profile have highest priority	284	That means that the values specified in the profile have highest priority
191	and the values specified directly via C<configure> have lowest priority,	285	and the values specified directly via C<configure> have lowest priority,
192	and can only be used to specify defaults.	286	and can only be used to specify defaults.
193		287
194	If the profile specifies a node ID, then this will become the node ID of	288	If the profile specifies a node ID, then this will become the node ID of
195	this process. If not, then the profile name will be used as node ID. The	289	this process. If not, then the profile name will be used as node ID, with
196	special node ID of C<anon/> will be replaced by a random node ID.	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>.
197		297
198	=item step 2, bind listener sockets	298	=item step 2, bind listener sockets
199		299
200	The next step is to look up the binds in the profile, followed by binding	300	The next step is to look up the binds in the profile, followed by binding
201	aemp protocol listeners on all binds specified (it is possible and valid	301	aemp protocol listeners on all binds specified (it is possible and valid
…		…
207	used, meaning the node will bind on a dynamically-assigned port on every	307	used, meaning the node will bind on a dynamically-assigned port on every
208	local IP address it finds.	308	local IP address it finds.
209		309
210	=item step 3, connect to seed nodes	310	=item step 3, connect to seed nodes
211		311
212	As the last step, the seeds list from the profile is passed to the	312	As the last step, the seed ID list from the profile is passed to the
213	L<AnyEvent::MP::Global> module, which will then use it to keep	313	L<AnyEvent::MP::Global> module, which will then use it to keep
214	connectivity with at least one node at any point in time.	314	connectivity with at least one node at any point in time.
215		315
216	=back	316	=back
217		317
218	Example: become a distributed node using the locla node name as profile.	318	Example: become a distributed node using the local node name as profile.
219	This should be the most common form of invocation for "daemon"-type nodes.	319	This should be the most common form of invocation for "daemon"-type nodes.
220		320
221	configure	321	configure
222		322
223	Example: become an anonymous node. This form is often used for commandline	323	Example: become a semi-anonymous node. This form is often used for
224	clients.	324	commandline clients.
225		325
226	configure nodeid => "anon/";	326	configure nodeid => "myscript/%n/%u";
227		327
228	Example: configure a node using a profile called seed, which si suitable	328	Example: configure a node using a profile called seed, which is suitable
229	for a seed node as it binds on all local addresses on a fixed port (4040,	329	for a seed node as it binds on all local addresses on a fixed port (4040,
230	customary for aemp).	330	customary for aemp).
231		331
232	# use the aemp commandline utility	332	# use the aemp commandline utility
233	# aemp profile seed nodeid anon/ binds '*:4040'	333	# aemp profile seed binds '*:4040'
234		334
235	# then use it	335	# then use it
236	configure profile => "seed";	336	configure profile => "seed";
237		337
238	# or simply use aemp from the shell again:	338	# or simply use aemp from the shell again:
…		…
303		403
304	=cut	404	=cut
305		405
306	sub rcv($@);	406	sub rcv($@);
307		407
308	sub _kilme {	408	my $KILME = sub {
309	die "received message on port without callback";	409	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
310	}	410	kil $SELF, unhandled_message => "no callback found for message '$tag'";
		411	};
311		412
312	sub port(;&) {	413	sub port(;&) {
313	my $id = "$UNIQ." . $ID++;	414	my $id = $UNIQ . ++$ID;
314	my $port = "$NODE#$id";	415	my $port = "$NODE#$id";
315		416
316	rcv $port, shift \|\| \&_kilme;	417	rcv $port, shift \|\| $KILME;
317		418
318	$port	419	$port
319	}	420	}
320		421
321	=item rcv $local_port, $callback->(@msg)	422	=item rcv $local_port, $callback->(@msg)
…		…
326		427
327	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
328	executing the callback. Runtime errors during callback execution will	429	executing the callback. Runtime errors during callback execution will
329	result in the port being C<kil>ed.	430	result in the port being C<kil>ed.
330		431
331	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
332	C<tag> match.	433	C<tag> match.
333		434
334	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	435	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
335		436
336	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
…		…
357	msg1 => sub { ... },	458	msg1 => sub { ... },
358	...	459	...
359	;	460	;
360		461
361	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
362	(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.
363		464
364	rcv $port, $otherport => sub {	465	rcv $port, $otherport => sub {
365	my @reply = @_;	466	my @reply = @_;
366		467
367	rcv $SELF, $otherport;	468	rcv $SELF, $otherport;
…		…
380	if (ref $_[0]) {	481	if (ref $_[0]) {
381	if (my $self = $PORT_DATA{$portid}) {	482	if (my $self = $PORT_DATA{$portid}) {
382	"AnyEvent::MP::Port" eq ref $self	483	"AnyEvent::MP::Port" eq ref $self
383	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";
384		485
385	$self->[2] = shift;	486	$self->[0] = shift;
386	} else {	487	} else {
387	my $cb = shift;	488	my $cb = shift;
388	$PORT{$portid} = sub {	489	$PORT{$portid} = sub {
389	local $SELF = $port;	490	local $SELF = $port;
390	eval { &$cb }; _self_die if $@;	491	eval { &$cb }; _self_die if $@;
391	};	492	};
392	}	493	}
393	} elsif (defined $_[0]) {	494	} elsif (defined $_[0]) {
394	my $self = $PORT_DATA{$portid} \|\|= do {	495	my $self = $PORT_DATA{$portid} \|\|= do {
395	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	496	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
396		497
397	$PORT{$portid} = sub {	498	$PORT{$portid} = sub {
398	local $SELF = $port;	499	local $SELF = $port;
399		500
400	if (my $cb = $self->[1]{$_[0]}) {	501	if (my $cb = $self->[1]{$_[0]}) {
…		…
422	}	523	}
423		524
424	$port	525	$port
425	}	526	}
426		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
427	=item $closure = psub { BLOCK }	565	=item $closure = psub { BLOCK }
428		566
429	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
430	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>
431	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 }, @_ } >>.
432		573
433	This is useful when you register callbacks from C<rcv> callbacks:	574	This is useful when you register callbacks from C<rcv> callbacks:
434		575
435	rcv delayed_reply => sub {	576	rcv delayed_reply => sub {
436	my ($delay, @reply) = @_;	577	my ($delay, @reply) = @_;
…		…
460	$res	601	$res
461	}	602	}
462	}	603	}
463	}	604	}
464		605
		606	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
		607
		608	=item $guard = mon $port # kill $SELF when $port dies
		609
465	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies	610	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
466
467	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
468
469	=item $guard = mon $port # kill $SELF when $port dies
470		611
471	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies	612	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
472		613
473	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
474	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
475	to stop monitoring again.	616	to stop monitoring again.
		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.
476		650
477	C<mon> effectively guarantees that, in the absence of hardware failures,	651	C<mon> effectively guarantees that, in the absence of hardware failures,
478	after starting the monitor, either all messages sent to the port will	652	after starting the monitor, either all messages sent to the port will
479	arrive, or the monitoring action will be invoked after possible message	653	arrive, or the monitoring action will be invoked after possible message
480	loss has been detected. No messages will be lost "in between" (after	654	loss has been detected. No messages will be lost "in between" (after
481	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
482	port). After the monitoring action was invoked, further messages might get	656	port). After the monitoring action was invoked, further messages might get
483	delivered again.	657	delivered again.
484		658
485	Note that monitoring-actions are one-shot: once messages are lost (and a	659	Inter-host-connection timeouts and monitoring depend on the transport
486	monitoring alert was raised), they are removed and will not trigger again.	660	used. The only transport currently implemented is TCP, and AnyEvent::MP
		661	relies on TCP to detect node-downs (this can take 10-15 minutes on a
		662	non-idle connection, and usually around two hours for idle connections).
487		663
488	In the first form (callback), the callback is simply called with any	664	This means that monitoring is good for program errors and cleaning up
489	number of C<@reason> elements (no @reason means that the port was deleted	665	stuff eventually, but they are no replacement for a timeout when you need
490	"normally"). Note also that I<< the callback B<must> never die >>, so use	666	to ensure some maximum latency.
491	C<eval> if unsure.
492
493	In the second form (another port given), the other port (C<$rcvport>)
494	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
495	"normal" kils nothing happens, while under all other conditions, the other
496	port is killed with the same reason.
497
498	The third form (kill self) is the same as the second form, except that
499	C<$rvport> defaults to C<$SELF>.
500
501	In the last form (message), a message of the form C<@msg, @reason> will be
502	C<snd>.
503
504	As a rule of thumb, monitoring requests should always monitor a port from
505	a local port (or callback). The reason is that kill messages might get
506	lost, just like any other message. Another less obvious reason is that
507	even monitoring requests can get lost (for exmaple, when the connection
508	to the other node goes down permanently). When monitoring a port locally
509	these problems do not exist.
510		667
511	Example: call a given callback when C<$port> is killed.	668	Example: call a given callback when C<$port> is killed.
512		669
513	mon $port, sub { warn "port died because of <@_>\n" };	670	mon $port, sub { warn "port died because of <@_>\n" };
514		671
…		…
542	}	699	}
543		700
544	$node->monitor ($port, $cb);	701	$node->monitor ($port, $cb);
545		702
546	defined wantarray	703	defined wantarray
547	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	704	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
548	}	705	}
549		706
550	=item $guard = mon_guard $port, $ref, $ref...	707	=item $guard = mon_guard $port, $ref, $ref...
551		708
552	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
…		…
575		732
576	=item kil $port[, @reason]	733	=item kil $port[, @reason]
577		734
578	Kill the specified port with the given C<@reason>.	735	Kill the specified port with the given C<@reason>.
579		736
580	If no C<@reason> is specified, then the port is killed "normally" (ports	737	If no C<@reason> is specified, then the port is killed "normally" -
581	monitoring other ports will not necessarily die because a port dies	738	monitor callback will be invoked, but the kil will not cause linked ports
582	"normally").	739	(C<mon $mport, $lport> form) to get killed.
583		740
584	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>
585	C<mon>, see above).	742	form) get killed with the same reason.
586		743
587	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
588	will be reported as reason C<< die => $@ >>.	745	will be reported as reason C<< die => $@ >>.
589		746
590	Transport/communication errors are reported as C<< transport_error =>	747	Transport/communication errors are reported as C<< transport_error =>
591	$message >>.	748	$message >>.
592		749
593	=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: $!";
594		761
595	=item $port = spawn $node, $initfunc[, @initdata]	762	=item $port = spawn $node, $initfunc[, @initdata]
596		763
597	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
598	case it's the node where that port resides).	765	case it's the node where that port resides).
…		…
609	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.
610	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
611	exists or it runs out of package names.	778	exists or it runs out of package names.
612		779
613	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
614	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.
615		784
616	A common idiom is to pass a local port, immediately monitor the spawned	785	A common idiom is to pass a local port, immediately monitor the spawned
617	port, and in the remote init function, immediately monitor the passed	786	port, and in the remote init function, immediately monitor the passed
618	local port. This two-way monitoring ensures that both ports get cleaned up	787	local port. This two-way monitoring ensures that both ports get cleaned up
619	when there is a problem.	788	when there is a problem.
620		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).
		793
621	Example: spawn a chat server port on C<$othernode>.	794	Example: spawn a chat server port on C<$othernode>.
622		795
623	# this node, executed from within a port context:	796	# this node, executed from within a port context:
624	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	797	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
625	mon $server;	798	mon $server;
…		…
639		812
640	sub _spawn {	813	sub _spawn {
641	my $port = shift;	814	my $port = shift;
642	my $init = shift;	815	my $init = shift;
643		816
		817	# rcv will create the actual port
644	local $SELF = "$NODE#$port";	818	local $SELF = "$NODE#$port";
645	eval {	819	eval {
646	&{ load_func $init }	820	&{ load_func $init }
647	};	821	};
648	_self_die if $@;	822	_self_die if $@;
649	}	823	}
650		824
651	sub spawn(@) {	825	sub spawn(@) {
652	my ($nodeid, undef) = split /#/, shift, 2;	826	my ($nodeid, undef) = split /#/, shift, 2;
653		827
654	my $id = "$RUNIQ." . $ID++;	828	my $id = $RUNIQ . ++$ID;
655		829
656	$_[0] =~ /::/	830	$_[0] =~ /::/
657	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";
658		832
659	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;	833	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
660		834
661	"$nodeid#$id"	835	"$nodeid#$id"
662	}	836	}
		837
663		838
664	=item after $timeout, @msg	839	=item after $timeout, @msg
665		840
666	=item after $timeout, $callback	841	=item after $timeout, $callback
667		842
…		…
683	? $action[0]()	858	? $action[0]()
684	: snd @action;	859	: snd @action;
685	};	860	};
686	}	861	}
687		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
		917	=back
		918
		919	=head1 DISTRIBUTED DATABASE
		920
		921	AnyEvent::MP comes with a simple distributed database. The database will
		922	be mirrored asynchronously on all global nodes. Other nodes bind to one
		923	of the global nodes for their needs. Every node has a "local database"
		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.
		926
		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.:
		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
		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.
		1015
		1016	=cut
		1017
		1018	sub db_reg($$;$) {
		1019	my $family = shift;
		1020	my $port = @_ ? shift : $SELF;
		1021
		1022	my $clr = sub { db_del $family => $port };
		1023	mon $port, $clr;
		1024
		1025	db_set $family => $port => $_[0];
		1026
		1027	defined wantarray
		1028	and &Guard::guard ($clr)
		1029	}
		1030
		1031	=item db_family $family => $cb->(\%familyhash)
		1032
		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.
		1035
		1036	=item db_keys $family => $cb->(\@keys)
		1037
		1038	Same as C<db_family>, except it only queries the family I<subkeys> and passes
		1039	them as array reference to the callback.
		1040
		1041	=item db_values $family => $cb->(\@values)
		1042
		1043	Same as C<db_family>, except it only queries the family I<values> and passes them
		1044	as array reference to the callback.
		1045
		1046	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
		1047
		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.
		1053
		1054	If not called in void context, a guard object is returned that, when
		1055	destroyed, stops the monitor.
		1056
		1057	The family hash reference and the key arrays belong to AnyEvent::MP and
		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
		1098
688	=back	1099	=back
689		1100
690	=head1 AnyEvent::MP vs. Distributed Erlang	1101	=head1 AnyEvent::MP vs. Distributed Erlang
691		1102
692	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
693	== 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
694	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
695	sample:	1106	sample:
696		1107
697	http://www.Erlang.se/doc/programming_rules.shtml	1108	http://www.erlang.se/doc/programming_rules.shtml
698	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
699	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
700	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
701		1112
702	Despite the similarities, there are also some important differences:	1113	Despite the similarities, there are also some important differences:
703		1114
704	=over 4	1115	=over 4
705		1116
706	=item * Node IDs are arbitrary strings in AEMP.	1117	=item * Node IDs are arbitrary strings in AEMP.
707		1118
708	Erlang relies on special naming and DNS to work everywhere in the same	1119	Erlang relies on special naming and DNS to work everywhere in the same
709	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by	1120	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
710	configuraiton or DNS), but will otherwise discover other odes itself.	1121	configuration or DNS), and possibly the addresses of some seed nodes, but
		1122	will otherwise discover other nodes (and their IDs) itself.
711		1123
712	=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
713	uses "local ports are like remote ports".	1125	uses "local ports are like remote ports".
714		1126
715	The failure modes for local ports are quite different (runtime errors	1127	The failure modes for local ports are quite different (runtime errors
…		…
724	ports being the special case/exception, where transport errors cannot	1136	ports being the special case/exception, where transport errors cannot
725	occur.	1137	occur.
726		1138
727	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1139	=item * Erlang uses processes and a mailbox, AEMP does not queue.
728		1140
729	Erlang uses processes that selectively receive messages, and therefore	1141	Erlang uses processes that selectively receive messages out of order, and
730	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
731	useful purpose. For the same reason the pattern-matching abilities of	1143	no useful purpose. For the same reason the pattern-matching abilities
732	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
733	filter messages without dequeing them.	1145	filter messages without dequeuing them.
734		1146
735	(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.
736		1152
737	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1153	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
738		1154
739	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
740	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
741	connection establishment is handled in the background.	1158	establishment is handled in the background.
742		1159
743	=item * Erlang suffers from silent message loss, AEMP does not.	1160	=item * Erlang suffers from silent message loss, AEMP does not.
744		1161
745	Erlang makes few guarantees on messages delivery - messages can get lost	1162	Erlang implements few guarantees on messages delivery - messages can get
746	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,
747	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).
748		1165
749	AEMP guarantees correct ordering, and the guarantee that after one message	1166	AEMP guarantees (modulo hardware errors) correct ordering, and the
750	is lost, all following ones sent to the same port are lost as well, until	1167	guarantee that after one message is lost, all following ones sent to the
751	monitoring raises an error, so there are no silent "holes" in the message	1168	same port are lost as well, until monitoring raises an error, so there are
752	sequence.	1169	no silent "holes" in the message sequence.
		1170
		1171	If you want your software to be very reliable, you have to cope with
		1172	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		1173	simply tries to work better in common error cases, such as when a network
		1174	link goes down.
753		1175
754	=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.
755		1177
756	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
757	known to other nodes for a completely different process, causing messages	1179	process ID known to other nodes for a completely different process,
758	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.
759		1182
760	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
761	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.
762		1185
763	=item * Erlang uses unprotected connections, AEMP uses secure	1186	=item * Erlang uses unprotected connections, AEMP uses secure
764	authentication and can use TLS.	1187	authentication and can use TLS.
765		1188
…		…
768		1191
769	=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
770	communications.	1193	communications.
771		1194
772	The AEMP protocol, unlike the Erlang protocol, supports both programming	1195	The AEMP protocol, unlike the Erlang protocol, supports both programming
773	language independent text-only protocols (good for debugging) and binary,	1196	language independent text-only protocols (good for debugging), and binary,
774	language-specific serialisers (e.g. Storable). By default, unless TLS is	1197	language-specific serialisers (e.g. Storable). By default, unless TLS is
775	used, the protocol is actually completely text-based.	1198	used, the protocol is actually completely text-based.
776		1199
777	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
778	with a minimum of work while gracefully degrading functionality to make the	1201	with a minimum of work while gracefully degrading functionality to make the
779	protocol simple.	1202	protocol simple.
780		1203
781	=item * AEMP has more flexible monitoring options than Erlang.	1204	=item * AEMP has more flexible monitoring options than Erlang.
782		1205
783	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
784	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
785	difficult to implement. Monitoring in AEMP is more flexible than in	1208	difficult to implement.
786	Erlang, as one can choose between automatic kill, exit message or callback	1209
787	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.
788		1212
789	=item * Erlang tries to hide remote/local connections, AEMP does not.	1213	=item * Erlang tries to hide remote/local connections, AEMP does not.
790		1214
791	Monitoring in Erlang is not an indicator of process death/crashes, in the	1215	Monitoring in Erlang is not an indicator of process death/crashes, in the
792	same way as linking is (except linking is unreliable in Erlang).	1216	same way as linking is (except linking is unreliable in Erlang).
…		…
814	overhead, as well as having to keep a proxy object everywhere.	1238	overhead, as well as having to keep a proxy object everywhere.
815		1239
816	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
817	procedures to be "valid".	1241	procedures to be "valid".
818		1242
819	And as a result, a miniport consists of a single closure stored in a	1243	And as a result, a port with just a default receiver consists of a single
820	global hash - it can't become much cheaper.	1244	code reference stored in a global hash - it can't become much cheaper.
821		1245
822	=item Why favour JSON, why not a real serialising format such as Storable?	1246	=item Why favour JSON, why not a real serialising format such as Storable?
823		1247
824	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
825	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
…		…
835	Keeping your messages simple, concentrating on data structures rather than	1259	Keeping your messages simple, concentrating on data structures rather than
836	objects, will keep your messages clean, tidy and efficient.	1260	objects, will keep your messages clean, tidy and efficient.
837		1261
838	=back	1262	=back
839		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
840	=head1 SEE ALSO	1369	=head1 SEE ALSO
841		1370
842	L<AnyEvent::MP::Intro> - a gentle introduction.	1371	L<AnyEvent::MP::Intro> - a gentle introduction.
843		1372
844	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1373	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
845		1374
846	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1375	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
847	your applications.	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.
848		1382
849	L<AnyEvent>.	1383	L<AnyEvent>.
850		1384
851	=head1 AUTHOR	1385	=head1 AUTHOR
852		1386

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.76 by root, Mon Aug 31 18:45:05 2009 UTC vs. Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.76 by root, Mon Aug 31 18:45:05 2009 UTC vs.
Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC