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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.104 by root, Fri Nov 6 17:47:20 2009 UTC vs.
Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC

…		…
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 prot again	35	# destroy a port again
36	kil $port; # "normal" kill	36	kil $port; # "normal" kill
37	kil $port, my_error => "everything is broken"; # error kill	37	kil $port, my_error => "everything is broken"; # error kill
38		38
39	# monitoring	39	# monitoring
40	mon $localport, $cb->(@msg) # callback is invoked on death	40	mon $port, $cb->(@msg) # callback is invoked on death
41	mon $localport, $otherport # kill otherport on abnormal death	41	mon $port, $localport # kill localport on abnormal death
42	mon $localport, $otherport, @msg # send message on death	42	mon $port, $localport, @msg # send message on death
43		43
44	# temporarily execute code in port context	44	# temporarily execute code in port context
45	peval $port, sub { die "kill the port!" };	45	peval $port, sub { die "kill the port!" };
46		46
47	# execute callbacks in $SELF port context	47	# execute callbacks in $SELF port context
…		…
78		78
79	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
80	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
81	anything was listening for them or not.	81	anything was listening for them or not.
82		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
83	=item port ID - C<nodeid#portname>	85	=item port ID - C<nodeid#portname>
84		86
85	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<#>)
86	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).
87		90
88	=item node	91	=item node
89		92
90	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,
91	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
92	ports.	95	ports.
93		96
94	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
95	(no listening ports). Private nodes cannot talk to other private nodes	98	(no listening ports). Private nodes cannot talk to other private nodes
96	currently.	99	currently, but all nodes can talk to public nodes.
97		100
		101	Nodes is represented by (printable) strings called "node IDs".
		102
98	=item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*>	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
99		104
100	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
101	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
102	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
103	doesn't interpret node IDs in any way.	108	doesn't interpret node IDs in any way except to uniquely identify a node.
104		109
105	=item binds - C<ip:port>	110	=item binds - C<ip:port>
106		111
107	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
108	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
109	endpoints - binds. Currently, only standard C<ip:port> specifications can	116	Currently, only standard C<ip:port> specifications can be used, which
110	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.
111		119
112	=item seed nodes	120	=item seed nodes
113		121
114	When a node starts, it knows nothing about the network. To teach the node	122	When a node starts, it knows nothing about the network it is in - it
115	about the network it first has to contact some other node within the	123	needs to connect to at least one other node that is already in the
116	network. This node is called a seed.	124	network. These other nodes are called "seed nodes".
117		125
118	Apart from the fact that other nodes know them as seed nodes and they have	126	Seed nodes themselves are not special - they are seed nodes only because
119	to have fixed listening addresses, seed nodes are perfectly normal nodes -	127	some other node I<uses> them as such, but any node can be used as seed
120	any node can function as a seed node for others.	128	node for other nodes, and eahc node cna use a different set of seed nodes.
121		129
122	In addition to discovering the network, seed nodes are also used to	130	In addition to discovering the network, seed nodes are also used to
123	maintain the network and to connect nodes that otherwise would have	131	maintain the network - all nodes using the same seed node form are part of
124	trouble connecting. They form the backbone of an AnyEvent::MP network.	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.
125		135
126	Seed nodes are expected to be long-running, and at least one seed node	136	Seed nodes are expected to be long-running, and at least one seed node
127	should always be available. They should also be relatively responsive - a	137	should always be available. They should also be relatively responsive - a
128	seed node that blocks for long periods will slow down everybody else.	138	seed node that blocks for long periods will slow down everybody else.
129		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
130	=item seeds - C<host:port>	149	=item seed IDs - C<host:port>
131		150
132	Seeds are transport endpoint(s) (usually a hostname/IP address and a	151	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
133	TCP port) of nodes that should be used as seed nodes.	152	TCP port) of nodes that should be used as seed nodes.
134		153
135	The nodes listening on those endpoints are expected to be long-running,	154	=item global nodes
136	and at least one of those should always be available. When nodes run out	155
137	of connections (e.g. due to a network error), they try to re-establish	156	An AEMP network needs a discovery service - nodes need to know how to
138	connections to some seednodes again to join the network.	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).
139		170
140	=back	171	=back
141		172
142	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
143		174
…		…
145		176
146	=cut	177	=cut
147		178
148	package AnyEvent::MP;	179	package AnyEvent::MP;
149		180
		181	use AnyEvent::MP::Config ();
150	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
151		184
152	use common::sense;	185	use common::sense;
153		186
154	use Carp ();	187	use Carp ();
155		188
156	use AE ();	189	use AE ();
		190	use Guard ();
157		191
158	use base "Exporter";	192	use base "Exporter";
159		193
160	our $VERSION = 1.23;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
161		195
162	our @EXPORT = qw(	196	our @EXPORT = qw(
163	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
164	configure	198	configure
165	snd rcv mon mon_guard kil psub peval spawn cal	199	snd rcv mon mon_guard kil psub peval spawn cal
166	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
167	);	203	);
168		204
169	our $SELF;	205	our $SELF;
170		206
171	sub _self_die() {	207	sub _self_die() {
…		…
194	some other nodes in the network to discover other nodes.	230	some other nodes in the network to discover other nodes.
195		231
196	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
197	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
198		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
199	=over 4	267	=over 4
200		268
201	=item step 1, gathering configuration from profiles	269	=item step 1, gathering configuration from profiles
202		270
203	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
…		…
216	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
217	and the values specified directly via C<configure> have lowest priority,	285	and the values specified directly via C<configure> have lowest priority,
218	and can only be used to specify defaults.	286	and can only be used to specify defaults.
219		287
220	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
221	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
222	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>.
223		297
224	=item step 2, bind listener sockets	298	=item step 2, bind listener sockets
225		299
226	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
227	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
…		…
233	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
234	local IP address it finds.	308	local IP address it finds.
235		309
236	=item step 3, connect to seed nodes	310	=item step 3, connect to seed nodes
237		311
238	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
239	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
240	connectivity with at least one node at any point in time.	314	connectivity with at least one node at any point in time.
241		315
242	=back	316	=back
243		317
244	Example: become a distributed node using the local node name as profile.	318	Example: become a distributed node using the local node name as profile.
245	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.
246		320
247	configure	321	configure
248		322
249	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
250	clients.	324	commandline clients.
251		325
252	configure nodeid => "anon/";	326	configure nodeid => "myscript/%n/%u";
253		327
254	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
255	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,
256	customary for aemp).	330	customary for aemp).
257		331
258	# use the aemp commandline utility	332	# use the aemp commandline utility
259	# aemp profile seed nodeid anon/ binds '*:4040'	333	# aemp profile seed binds '*:4040'
260		334
261	# then use it	335	# then use it
262	configure profile => "seed";	336	configure profile => "seed";
263		337
264	# or simply use aemp from the shell again:	338	# or simply use aemp from the shell again:
…		…
329		403
330	=cut	404	=cut
331		405
332	sub rcv($@);	406	sub rcv($@);
333		407
334	sub _kilme {	408	my $KILME = sub {
335	die "received message on port without callback";	409	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
336	}	410	kil $SELF, unhandled_message => "no callback found for message '$tag'";
		411	};
337		412
338	sub port(;&) {	413	sub port(;&) {
339	my $id = "$UNIQ." . $ID++;	414	my $id = $UNIQ . ++$ID;
340	my $port = "$NODE#$id";	415	my $port = "$NODE#$id";
341		416
342	rcv $port, shift \|\| \&_kilme;	417	rcv $port, shift \|\| $KILME;
343		418
344	$port	419	$port
345	}	420	}
346		421
347	=item rcv $local_port, $callback->(@msg)	422	=item rcv $local_port, $callback->(@msg)
…		…
352		427
353	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
354	executing the callback. Runtime errors during callback execution will	429	executing the callback. Runtime errors during callback execution will
355	result in the port being C<kil>ed.	430	result in the port being C<kil>ed.
356		431
357	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
358	C<tag> match.	433	C<tag> match.
359		434
360	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	435	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
361		436
362	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
…		…
492	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
493	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>
494	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.
495		570
496	The effect is basically as if it returned C<< sub { peval $SELF, sub {	571	The effect is basically as if it returned C<< sub { peval $SELF, sub {
497	BLOCK } } >>.	572	BLOCK }, @_ } >>.
498		573
499	This is useful when you register callbacks from C<rcv> callbacks:	574	This is useful when you register callbacks from C<rcv> callbacks:
500		575
501	rcv delayed_reply => sub {	576	rcv delayed_reply => sub {
502	my ($delay, @reply) = @_;	577	my ($delay, @reply) = @_;
…		…
526	$res	601	$res
527	}	602	}
528	}	603	}
529	}	604	}
530		605
		606	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
		607
		608	=item $guard = mon $port # kill $SELF when $port dies
		609
531	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies	610	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
532
533	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
534
535	=item $guard = mon $port # kill $SELF when $port dies
536		611
537	=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
538		613
539	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
540	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
541	to stop monitoring again.	616	to stop monitoring again.
542		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
543	In the first form (callback), the callback is simply called with any	632	In the third form (callback), the callback is simply called with any
544	number of C<@reason> elements (no @reason means that the port was deleted	633	number of C<@reason> elements (empty @reason means that the port was deleted
545	"normally"). Note also that I<< the callback B<must> never die >>, so use	634	"normally"). Note also that I<< the callback B<must> never die >>, so use
546	C<eval> if unsure.	635	C<eval> if unsure.
547		636
548	In the second form (another port given), the other port (C<$rcvport>)
549	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
550	"normal" kils nothing happens, while under all other conditions, the other
551	port is killed with the same reason.
552
553	The third form (kill self) is the same as the second form, except that
554	C<$rvport> defaults to C<$SELF>.
555
556	In the last form (message), a message of the form C<@msg, @reason> will be	637	In the last form (message), a message of the form C<$rcvport, @msg,
557	C<snd>.	638	@reason> will be C<snd>.
558		639
559	Monitoring-actions are one-shot: once messages are lost (and a monitoring	640	Monitoring-actions are one-shot: once messages are lost (and a monitoring
560	alert was raised), they are removed and will not trigger again.	641	alert was raised), they are removed and will not trigger again, even if it
		642	turns out that the port is still alive.
561		643
562	As a rule of thumb, monitoring requests should always monitor a port from	644	As a rule of thumb, monitoring requests should always monitor a remote
563	a local port (or callback). The reason is that kill messages might get	645	port locally (using a local C<$rcvport> or a callback). The reason is that
564	lost, just like any other message. Another less obvious reason is that	646	kill messages might get lost, just like any other message. Another less
565	even monitoring requests can get lost (for example, when the connection	647	obvious reason is that even monitoring requests can get lost (for example,
566	to the other node goes down permanently). When monitoring a port locally	648	when the connection to the other node goes down permanently). When
567	these problems do not exist.	649	monitoring a port locally these problems do not exist.
568		650
569	C<mon> effectively guarantees that, in the absence of hardware failures,	651	C<mon> effectively guarantees that, in the absence of hardware failures,
570	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
571	arrive, or the monitoring action will be invoked after possible message	653	arrive, or the monitoring action will be invoked after possible message
572	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
…		…
617	}	699	}
618		700
619	$node->monitor ($port, $cb);	701	$node->monitor ($port, $cb);
620		702
621	defined wantarray	703	defined wantarray
622	and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })	704	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
623	}	705	}
624		706
625	=item $guard = mon_guard $port, $ref, $ref...	707	=item $guard = mon_guard $port, $ref, $ref...
626		708
627	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
…		…
650		732
651	=item kil $port[, @reason]	733	=item kil $port[, @reason]
652		734
653	Kill the specified port with the given C<@reason>.	735	Kill the specified port with the given C<@reason>.
654		736
655	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" -
656	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
657	"normally").	739	(C<mon $mport, $lport> form) to get killed.
658		740
659	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>
660	C<mon>, see above).	742	form) get killed with the same reason.
661		743
662	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
663	will be reported as reason C<< die => $@ >>.	745	will be reported as reason C<< die => $@ >>.
664		746
665	Transport/communication errors are reported as C<< transport_error =>	747	Transport/communication errors are reported as C<< transport_error =>
666	$message >>.	748	$message >>.
667		749
668	=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: $!";
669		761
670	=item $port = spawn $node, $initfunc[, @initdata]	762	=item $port = spawn $node, $initfunc[, @initdata]
671		763
672	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
673	case it's the node where that port resides).	765	case it's the node where that port resides).
…		…
731	}	823	}
732		824
733	sub spawn(@) {	825	sub spawn(@) {
734	my ($nodeid, undef) = split /#/, shift, 2;	826	my ($nodeid, undef) = split /#/, shift, 2;
735		827
736	my $id = "$RUNIQ." . $ID++;	828	my $id = $RUNIQ . ++$ID;
737		829
738	$_[0] =~ /::/	830	$_[0] =~ /::/
739	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";
740		832
741	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;	833	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
742		834
743	"$nodeid#$id"	835	"$nodeid#$id"
744	}	836	}
		837
745		838
746	=item after $timeout, @msg	839	=item after $timeout, @msg
747		840
748	=item after $timeout, $callback	841	=item after $timeout, $callback
749		842
…		…
764	ref $action[0]	857	ref $action[0]
765	? $action[0]()	858	? $action[0]()
766	: snd @action;	859	: snd @action;
767	};	860	};
768	}	861	}
		862
		863	#=item $cb2 = timeout $seconds, $cb[, @args]
769		864
770	=item cal $port, @msg, $callback[, $timeout]	865	=item cal $port, @msg, $callback[, $timeout]
771		866
772	A simple form of RPC - sends a message to the given C<$port> with the	867	A simple form of RPC - sends a message to the given C<$port> with the
773	given contents (C<@msg>), but adds a reply port to the message.	868	given contents (C<@msg>), but adds a reply port to the message.
…		…
819	$port	914	$port
820	}	915	}
821		916
822	=back	917	=back
823		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
		1099	=back
		1100
824	=head1 AnyEvent::MP vs. Distributed Erlang	1101	=head1 AnyEvent::MP vs. Distributed Erlang
825		1102
826	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
827	== 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
828	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
…		…
859	ports being the special case/exception, where transport errors cannot	1136	ports being the special case/exception, where transport errors cannot
860	occur.	1137	occur.
861		1138
862	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1139	=item * Erlang uses processes and a mailbox, AEMP does not queue.
863		1140
864	Erlang uses processes that selectively receive messages, and therefore	1141	Erlang uses processes that selectively receive messages out of order, and
865	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
866	useful purpose. For the same reason the pattern-matching abilities of	1143	no useful purpose. For the same reason the pattern-matching abilities
867	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
868	filter messages without dequeuing them.	1145	filter messages without dequeuing them.
869		1146
870	(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.
871		1152
872	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1153	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
873		1154
874	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
875	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
876	connection establishment is handled in the background.	1158	establishment is handled in the background.
877		1159
878	=item * Erlang suffers from silent message loss, AEMP does not.	1160	=item * Erlang suffers from silent message loss, AEMP does not.
879		1161
880	Erlang implements few guarantees on messages delivery - messages can get	1162	Erlang implements few guarantees on messages delivery - messages can get
881	lost without any of the processes realising it (i.e. you send messages a,	1163	lost without any of the processes realising it (i.e. you send messages a,
882	b, 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).
883		1165
884	AEMP guarantees correct ordering, and the guarantee that after one message	1166	AEMP guarantees (modulo hardware errors) correct ordering, and the
885	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
886	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
887	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.
888		1175
889	=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.
890		1177
891	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
892	known to other nodes for a completely different process, causing messages	1179	process ID known to other nodes for a completely different process,
893	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.
894		1182
895	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
896	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.
897		1185
898	=item * Erlang uses unprotected connections, AEMP uses secure	1186	=item * Erlang uses unprotected connections, AEMP uses secure
899	authentication and can use TLS.	1187	authentication and can use TLS.
900		1188
…		…
903		1191
904	=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
905	communications.	1193	communications.
906		1194
907	The AEMP protocol, unlike the Erlang protocol, supports both programming	1195	The AEMP protocol, unlike the Erlang protocol, supports both programming
908	language independent text-only protocols (good for debugging) and binary,	1196	language independent text-only protocols (good for debugging), and binary,
909	language-specific serialisers (e.g. Storable). By default, unless TLS is	1197	language-specific serialisers (e.g. Storable). By default, unless TLS is
910	used, the protocol is actually completely text-based.	1198	used, the protocol is actually completely text-based.
911		1199
912	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
913	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
914	protocol simple.	1202	protocol simple.
915		1203
916	=item * AEMP has more flexible monitoring options than Erlang.	1204	=item * AEMP has more flexible monitoring options than Erlang.
917		1205
918	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
919	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
920	difficult to implement. Monitoring in AEMP is more flexible than in	1208	difficult to implement.
921	Erlang, as one can choose between automatic kill, exit message or callback	1209
922	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.
923		1212
924	=item * Erlang tries to hide remote/local connections, AEMP does not.	1213	=item * Erlang tries to hide remote/local connections, AEMP does not.
925		1214
926	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
927	same way as linking is (except linking is unreliable in Erlang).	1216	same way as linking is (except linking is unreliable in Erlang).
…		…
949	overhead, as well as having to keep a proxy object everywhere.	1238	overhead, as well as having to keep a proxy object everywhere.
950		1239
951	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
952	procedures to be "valid".	1241	procedures to be "valid".
953		1242
954	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
955	global hash - it can't become much cheaper.	1244	code reference stored in a global hash - it can't become much cheaper.
956		1245
957	=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?
958		1247
959	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
960	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
…		…
970	Keeping your messages simple, concentrating on data structures rather than	1259	Keeping your messages simple, concentrating on data structures rather than
971	objects, will keep your messages clean, tidy and efficient.	1260	objects, will keep your messages clean, tidy and efficient.
972		1261
973	=back	1262	=back
974		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
975	=head1 SEE ALSO	1369	=head1 SEE ALSO
976		1370
977	L<AnyEvent::MP::Intro> - a gentle introduction.	1371	L<AnyEvent::MP::Intro> - a gentle introduction.
978		1372
979	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1373	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
980		1374
981	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1375	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
982	your applications.	1376	your applications.
		1377
		1378	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
983		1379
984	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from	1380	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
985	all nodes.	1381	all nodes.
986		1382
987	L<AnyEvent>.	1383	L<AnyEvent>.

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.104 by root, Fri Nov 6 17:47:20 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.104 by root, Fri Nov 6 17:47:20 2009 UTC vs.
Revision 1.139 by root, Thu Mar 22 20:07:31 2012 UTC