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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.86 by root, Wed Sep 9 01:47:01 2009 UTC vs.
Revision 1.138 by root, Thu Mar 22 00:48:29 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 - explains 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 but incomplete, 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
…		…
68		78
69	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
70	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
71	anything was listening for them or not.	81	anything was listening for them or not.
72		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
73	=item port ID - C<nodeid#portname>	85	=item port ID - C<nodeid#portname>
74		86
75	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<#>)
76	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).
77		90
78	=item node	91	=item node
79		92
80	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,
81	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
82	ports.	95	ports.
83		96
84	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
85	(no listening ports). Private nodes cannot talk to other private nodes	98	(no listening ports). Private nodes cannot talk to other private nodes
86	currently.	99	currently, but all nodes can talk to public nodes.
87		100
		101	Nodes is represented by (printable) strings called "node IDs".
		102
88	=item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*>	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
89		104
90	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
91	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
92	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
93	doesn't interpret node IDs in any way.	108	doesn't interpret node IDs in any way except to uniquely identify a node.
94		109
95	=item binds - C<ip:port>	110	=item binds - C<ip:port>
96		111
97	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
98	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
99	endpoints - binds. Currently, only standard C<ip:port> specifications can	116	Currently, only standard C<ip:port> specifications can be used, which
100	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.
101		119
102	=item seed nodes	120	=item seed nodes
103		121
104	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
105	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
106	network. This node is called a seed.	124	network. These other nodes are called "seed nodes".
107		125
108	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
109	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
110	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.
111		129
112	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
113	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
114	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.
115		135
116	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
117	should always be available. They should also be relatively responsive - a	137	should always be available. They should also be relatively responsive - a
118	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.
119		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
120	=item seeds - C<host:port>	149	=item seed IDs - C<host:port>
121		150
122	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
123	TCP port) of nodes thta should be used as seed nodes.	152	TCP port) of nodes that should be used as seed nodes.
124		153
125	The nodes listening on those endpoints are expected to be long-running,	154	=item global nodes
126	and at least one of those should always be available. When nodes run out	155
127	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
128	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).
129		170
130	=back	171	=back
131		172
132	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
133		174
…		…
135		176
136	=cut	177	=cut
137		178
138	package AnyEvent::MP;	179	package AnyEvent::MP;
139		180
		181	use AnyEvent::MP::Config ();
140	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
141		184
142	use common::sense;	185	use common::sense;
143		186
144	use Carp ();	187	use Carp ();
145		188
146	use AE ();	189	use AE ();
		190	use Guard ();
147		191
148	use base "Exporter";	192	use base "Exporter";
149		193
150	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
151		195
152	our @EXPORT = qw(	196	our @EXPORT = qw(
153	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
154	configure	198	configure
155	snd rcv mon mon_guard kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
156	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
157	);	203	);
158		204
159	our $SELF;	205	our $SELF;
160		206
161	sub _self_die() {	207	sub _self_die() {
…		…
184	some other nodes in the network to discover other nodes.	230	some other nodes in the network to discover other nodes.
185		231
186	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
187	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
188		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
189	=over 4	267	=over 4
190		268
191	=item step 1, gathering configuration from profiles	269	=item step 1, gathering configuration from profiles
192		270
193	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
…		…
206	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
207	and the values specified directly via C<configure> have lowest priority,	285	and the values specified directly via C<configure> have lowest priority,
208	and can only be used to specify defaults.	286	and can only be used to specify defaults.
209		287
210	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
211	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
212	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>.
213		297
214	=item step 2, bind listener sockets	298	=item step 2, bind listener sockets
215		299
216	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
217	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
…		…
223	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
224	local IP address it finds.	308	local IP address it finds.
225		309
226	=item step 3, connect to seed nodes	310	=item step 3, connect to seed nodes
227		311
228	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
229	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
230	connectivity with at least one node at any point in time.	314	connectivity with at least one node at any point in time.
231		315
232	=back	316	=back
233		317
234	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.
235	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.
236		320
237	configure	321	configure
238		322
239	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
240	clients.	324	commandline clients.
241		325
242	configure nodeid => "anon/";	326	configure nodeid => "myscript/%n/%u";
243		327
244	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
245	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,
246	customary for aemp).	330	customary for aemp).
247		331
248	# use the aemp commandline utility	332	# use the aemp commandline utility
249	# aemp profile seed nodeid anon/ binds '*:4040'	333	# aemp profile seed binds '*:4040'
250		334
251	# then use it	335	# then use it
252	configure profile => "seed";	336	configure profile => "seed";
253		337
254	# or simply use aemp from the shell again:	338	# or simply use aemp from the shell again:
…		…
319		403
320	=cut	404	=cut
321		405
322	sub rcv($@);	406	sub rcv($@);
323		407
324	sub _kilme {	408	my $KILME = sub {
325	die "received message on port without callback";	409	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
326	}	410	kil $SELF, unhandled_message => "no callback found for message '$tag'";
		411	};
327		412
328	sub port(;&) {	413	sub port(;&) {
329	my $id = "$UNIQ." . $ID++;	414	my $id = $UNIQ . ++$ID;
330	my $port = "$NODE#$id";	415	my $port = "$NODE#$id";
331		416
332	rcv $port, shift \|\| \&_kilme;	417	rcv $port, shift \|\| $KILME;
333		418
334	$port	419	$port
335	}	420	}
336		421
337	=item rcv $local_port, $callback->(@msg)	422	=item rcv $local_port, $callback->(@msg)
…		…
342		427
343	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
344	executing the callback. Runtime errors during callback execution will	429	executing the callback. Runtime errors during callback execution will
345	result in the port being C<kil>ed.	430	result in the port being C<kil>ed.
346		431
347	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
348	C<tag> match.	433	C<tag> match.
349		434
350	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	435	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
351		436
352	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
…		…
373	msg1 => sub { ... },	458	msg1 => sub { ... },
374	...	459	...
375	;	460	;
376		461
377	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
378	(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.
379		464
380	rcv $port, $otherport => sub {	465	rcv $port, $otherport => sub {
381	my @reply = @_;	466	my @reply = @_;
382		467
383	rcv $SELF, $otherport;	468	rcv $SELF, $otherport;
…		…
396	if (ref $_[0]) {	481	if (ref $_[0]) {
397	if (my $self = $PORT_DATA{$portid}) {	482	if (my $self = $PORT_DATA{$portid}) {
398	"AnyEvent::MP::Port" eq ref $self	483	"AnyEvent::MP::Port" eq ref $self
399	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";
400		485
401	$self->[2] = shift;	486	$self->[0] = shift;
402	} else {	487	} else {
403	my $cb = shift;	488	my $cb = shift;
404	$PORT{$portid} = sub {	489	$PORT{$portid} = sub {
405	local $SELF = $port;	490	local $SELF = $port;
406	eval { &$cb }; _self_die if $@;	491	eval { &$cb }; _self_die if $@;
407	};	492	};
408	}	493	}
409	} elsif (defined $_[0]) {	494	} elsif (defined $_[0]) {
410	my $self = $PORT_DATA{$portid} \|\|= do {	495	my $self = $PORT_DATA{$portid} \|\|= do {
411	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	496	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
412		497
413	$PORT{$portid} = sub {	498	$PORT{$portid} = sub {
414	local $SELF = $port;	499	local $SELF = $port;
415		500
416	if (my $cb = $self->[1]{$_[0]}) {	501	if (my $cb = $self->[1]{$_[0]}) {
…		…
438	}	523	}
439		524
440	$port	525	$port
441	}	526	}
442		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
443	=item $closure = psub { BLOCK }	565	=item $closure = psub { BLOCK }
444		566
445	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
446	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>
447	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 }, @_ } >>.
448		573
449	This is useful when you register callbacks from C<rcv> callbacks:	574	This is useful when you register callbacks from C<rcv> callbacks:
450		575
451	rcv delayed_reply => sub {	576	rcv delayed_reply => sub {
452	my ($delay, @reply) = @_;	577	my ($delay, @reply) = @_;
…		…
525	delivered again.	650	delivered again.
526		651
527	Inter-host-connection timeouts and monitoring depend on the transport	652	Inter-host-connection timeouts and monitoring depend on the transport
528	used. The only transport currently implemented is TCP, and AnyEvent::MP	653	used. The only transport currently implemented is TCP, and AnyEvent::MP
529	relies on TCP to detect node-downs (this can take 10-15 minutes on a	654	relies on TCP to detect node-downs (this can take 10-15 minutes on a
530	non-idle connection, and usually around two hours for idle conenctions).	655	non-idle connection, and usually around two hours for idle connections).
531		656
532	This means that monitoring is good for program errors and cleaning up	657	This means that monitoring is good for program errors and cleaning up
533	stuff eventually, but they are no replacement for a timeout when you need	658	stuff eventually, but they are no replacement for a timeout when you need
534	to ensure some maximum latency.	659	to ensure some maximum latency.
535		660
…		…
567	}	692	}
568		693
569	$node->monitor ($port, $cb);	694	$node->monitor ($port, $cb);
570		695
571	defined wantarray	696	defined wantarray
572	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	697	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
573	}	698	}
574		699
575	=item $guard = mon_guard $port, $ref, $ref...	700	=item $guard = mon_guard $port, $ref, $ref...
576		701
577	Monitors the given C<$port> and keeps the passed references. When the port	702	Monitors the given C<$port> and keeps the passed references. When the port
…		…
600		725
601	=item kil $port[, @reason]	726	=item kil $port[, @reason]
602		727
603	Kill the specified port with the given C<@reason>.	728	Kill the specified port with the given C<@reason>.
604		729
605	If no C<@reason> is specified, then the port is killed "normally" (ports	730	If no C<@reason> is specified, then the port is killed "normally" -
606	monitoring other ports will not necessarily die because a port dies	731	monitor callback will be invoked, but the kil will not cause linked ports
607	"normally").	732	(C<mon $mport, $lport> form) to get killed.
608		733
609	Otherwise, linked ports get killed with the same reason (second form of	734	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
610	C<mon>, see above).	735	form) get killed with the same reason.
611		736
612	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	737	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
613	will be reported as reason C<< die => $@ >>.	738	will be reported as reason C<< die => $@ >>.
614		739
615	Transport/communication errors are reported as C<< transport_error =>	740	Transport/communication errors are reported as C<< transport_error =>
616	$message >>.	741	$message >>.
617		742
618	=cut	743	Common idioms:
		744
		745	# silently remove yourself, do not kill linked ports
		746	kil $SELF;
		747
		748	# report a failure in some detail
		749	kil $SELF, failure_mode_1 => "it failed with too high temperature";
		750
		751	# do not waste much time with killing, just die when something goes wrong
		752	open my $fh, "<file"
		753	or die "file: $!";
619		754
620	=item $port = spawn $node, $initfunc[, @initdata]	755	=item $port = spawn $node, $initfunc[, @initdata]
621		756
622	Creates a port on the node C<$node> (which can also be a port ID, in which	757	Creates a port on the node C<$node> (which can also be a port ID, in which
623	case it's the node where that port resides).	758	case it's the node where that port resides).
…		…
681	}	816	}
682		817
683	sub spawn(@) {	818	sub spawn(@) {
684	my ($nodeid, undef) = split /#/, shift, 2;	819	my ($nodeid, undef) = split /#/, shift, 2;
685		820
686	my $id = "$RUNIQ." . $ID++;	821	my $id = $RUNIQ . ++$ID;
687		822
688	$_[0] =~ /::/	823	$_[0] =~ /::/
689	or Carp::croak "spawn init function must be a fully-qualified name, caught";	824	or Carp::croak "spawn init function must be a fully-qualified name, caught";
690		825
691	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;	826	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
692		827
693	"$nodeid#$id"	828	"$nodeid#$id"
694	}	829	}
		830
695		831
696	=item after $timeout, @msg	832	=item after $timeout, @msg
697		833
698	=item after $timeout, $callback	834	=item after $timeout, $callback
699		835
…		…
715	? $action[0]()	851	? $action[0]()
716	: snd @action;	852	: snd @action;
717	};	853	};
718	}	854	}
719		855
		856	#=item $cb2 = timeout $seconds, $cb[, @args]
		857
		858	=item cal $port, @msg, $callback[, $timeout]
		859
		860	A simple form of RPC - sends a message to the given C<$port> with the
		861	given contents (C<@msg>), but adds a reply port to the message.
		862
		863	The reply port is created temporarily just for the purpose of receiving
		864	the reply, and will be C<kil>ed when no longer needed.
		865
		866	A reply message sent to the port is passed to the C<$callback> as-is.
		867
		868	If an optional time-out (in seconds) is given and it is not C<undef>,
		869	then the callback will be called without any arguments after the time-out
		870	elapsed and the port is C<kil>ed.
		871
		872	If no time-out is given (or it is C<undef>), then the local port will
		873	monitor the remote port instead, so it eventually gets cleaned-up.
		874
		875	Currently this function returns the temporary port, but this "feature"
		876	might go in future versions unless you can make a convincing case that
		877	this is indeed useful for something.
		878
		879	=cut
		880
		881	sub cal(@) {
		882	my $timeout = ref $_[-1] ? undef : pop;
		883	my $cb = pop;
		884
		885	my $port = port {
		886	undef $timeout;
		887	kil $SELF;
		888	&$cb;
		889	};
		890
		891	if (defined $timeout) {
		892	$timeout = AE::timer $timeout, 0, sub {
		893	undef $timeout;
		894	kil $port;
		895	$cb->();
		896	};
		897	} else {
		898	mon $_[0], sub {
		899	kil $port;
		900	$cb->();
		901	};
		902	}
		903
		904	push @_, $port;
		905	&snd;
		906
		907	$port
		908	}
		909
		910	=back
		911
		912	=head1 DISTRIBUTED DATABASE
		913
		914	AnyEvent::MP comes with a simple distributed database. The database will
		915	be mirrored asynchronously on all global nodes. Other nodes bind to one
		916	of the global nodes for their needs. Every node has a "local database"
		917	which contains all the values that are set locally. All local databases
		918	are merged together to form the global database, which can be queried.
		919
		920	The database structure is that of a two-level hash - the database hash
		921	contains hashes which contain values, similarly to a perl hash of hashes,
		922	i.e.:
		923
		924	$DATABASE{$family}{$subkey} = $value
		925
		926	The top level hash key is called "family", and the second-level hash key
		927	is called "subkey" or simply "key".
		928
		929	The family must be alphanumeric, i.e. start with a letter and consist
		930	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		931	pretty much like Perl module names.
		932
		933	As the family namespace is global, it is recommended to prefix family names
		934	with the name of the application or module using it.
		935
		936	The subkeys must be non-empty strings, with no further restrictions.
		937
		938	The values should preferably be strings, but other perl scalars should
		939	work as well (such as C<undef>, arrays and hashes).
		940
		941	Every database entry is owned by one node - adding the same family/subkey
		942	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		943	but the result might be nondeterministic, i.e. the key might have
		944	different values on different nodes.
		945
		946	Different subkeys in the same family can be owned by different nodes
		947	without problems, and in fact, this is the common method to create worker
		948	pools. For example, a worker port for image scaling might do this:
		949
		950	db_set my_image_scalers => $port;
		951
		952	And clients looking for an image scaler will want to get the
		953	C<my_image_scalers> keys from time to time:
		954
		955	db_keys my_image_scalers => sub {
		956	@ports = @{ $_[0] };
		957	};
		958
		959	Or better yet, they want to monitor the database family, so they always
		960	have a reasonable up-to-date copy:
		961
		962	db_mon my_image_scalers => sub {
		963	@ports = keys %{ $_[0] };
		964	};
		965
		966	In general, you can set or delete single subkeys, but query and monitor
		967	whole families only.
		968
		969	If you feel the need to monitor or query a single subkey, try giving it
		970	it's own family.
		971
		972	=over
		973
		974	=item $guard = db_set $family => $subkey [=> $value]
		975
		976	Sets (or replaces) a key to the database - if C<$value> is omitted,
		977	C<undef> is used instead.
		978
		979	When called in non-void context, C<db_set> returns a guard that
		980	automatically calls C<db_del> when it is destroyed.
		981
		982	=item db_del $family => $subkey...
		983
		984	Deletes one or more subkeys from the database family.
		985
		986	=item $guard = db_reg $family => $port => $value
		987
		988	=item $guard = db_reg $family => $port
		989
		990	=item $guard = db_reg $family
		991
		992	Registers a port in the given family and optionally returns a guard to
		993	remove it.
		994
		995	This function basically does the same as:
		996
		997	db_set $family => $port => $value
		998
		999	Except that the port is monitored and automatically removed from the
		1000	database family when it is kil'ed.
		1001
		1002	If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
		1003	C<$SELF> is used.
		1004
		1005	This function is most useful to register a port in some port group (which
		1006	is just another name for a database family), and have it removed when the
		1007	port is gone. This works best when the port is a local port.
		1008
		1009	=cut
		1010
		1011	sub db_reg($$;$) {
		1012	my $family = shift;
		1013	my $port = @_ ? shift : $SELF;
		1014
		1015	my $clr = sub { db_del $family => $port };
		1016	mon $port, $clr;
		1017
		1018	db_set $family => $port => $_[0];
		1019
		1020	defined wantarray
		1021	and &Guard::guard ($clr)
		1022	}
		1023
		1024	=item db_family $family => $cb->(\%familyhash)
		1025
		1026	Queries the named database C<$family> and call the callback with the
		1027	family represented as a hash. You can keep and freely modify the hash.
		1028
		1029	=item db_keys $family => $cb->(\@keys)
		1030
		1031	Same as C<db_family>, except it only queries the family I<subkeys> and passes
		1032	them as array reference to the callback.
		1033
		1034	=item db_values $family => $cb->(\@values)
		1035
		1036	Same as C<db_family>, except it only queries the family I<values> and passes them
		1037	as array reference to the callback.
		1038
		1039	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
		1040
		1041	Creates a monitor on the given database family. Each time a key is set
		1042	or or is deleted the callback is called with a hash containing the
		1043	database family and three lists of added, changed and deleted subkeys,
		1044	respectively. If no keys have changed then the array reference might be
		1045	C<undef> or even missing.
		1046
		1047	If not called in void context, a guard object is returned that, when
		1048	destroyed, stops the monitor.
		1049
		1050	The family hash reference and the key arrays belong to AnyEvent::MP and
		1051	B<must not be modified or stored> by the callback. When in doubt, make a
		1052	copy.
		1053
		1054	As soon as possible after the monitoring starts, the callback will be
		1055	called with the intiial contents of the family, even if it is empty,
		1056	i.e. there will always be a timely call to the callback with the current
		1057	contents.
		1058
		1059	It is possible that the callback is called with a change event even though
		1060	the subkey is already present and the value has not changed.
		1061
		1062	The monitoring stops when the guard object is destroyed.
		1063
		1064	Example: on every change to the family "mygroup", print out all keys.
		1065
		1066	my $guard = db_mon mygroup => sub {
		1067	my ($family, $a, $c, $d) = @_;
		1068	print "mygroup members: ", (join " ", keys %$family), "\n";
		1069	};
		1070
		1071	Exmaple: wait until the family "My::Module::workers" is non-empty.
		1072
		1073	my $guard; $guard = db_mon My::Module::workers => sub {
		1074	my ($family, $a, $c, $d) = @_;
		1075	return unless %$family;
		1076	undef $guard;
		1077	print "My::Module::workers now nonempty\n";
		1078	};
		1079
		1080	Example: print all changes to the family "AnyRvent::Fantasy::Module".
		1081
		1082	my $guard = db_mon AnyRvent::Fantasy::Module => sub {
		1083	my ($family, $a, $c, $d) = @_;
		1084
		1085	print "+$_=$family->{$_}\n" for @$a;
		1086	print "*$_=$family->{$_}\n" for @$c;
		1087	print "-$_=$family->{$_}\n" for @$d;
		1088	};
		1089
		1090	=cut
		1091
720	=back	1092	=back
721		1093
722	=head1 AnyEvent::MP vs. Distributed Erlang	1094	=head1 AnyEvent::MP vs. Distributed Erlang
723		1095
724	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	1096	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
725	== aemp node, Erlang process == aemp port), so many of the documents and	1097	== aemp node, Erlang process == aemp port), so many of the documents and
726	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	1098	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
727	sample:	1099	sample:
728		1100
729	http://www.Erlang.se/doc/programming_rules.shtml	1101	http://www.erlang.se/doc/programming_rules.shtml
730	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	1102	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
731	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6	1103	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
732	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	1104	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
733		1105
734	Despite the similarities, there are also some important differences:	1106	Despite the similarities, there are also some important differences:
735		1107
736	=over 4	1108	=over 4
737		1109
738	=item * Node IDs are arbitrary strings in AEMP.	1110	=item * Node IDs are arbitrary strings in AEMP.
739		1111
740	Erlang relies on special naming and DNS to work everywhere in the same	1112	Erlang relies on special naming and DNS to work everywhere in the same
741	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by	1113	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
742	configuration or DNS), but will otherwise discover other odes itself.	1114	configuration or DNS), and possibly the addresses of some seed nodes, but
		1115	will otherwise discover other nodes (and their IDs) itself.
743		1116
744	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	1117	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
745	uses "local ports are like remote ports".	1118	uses "local ports are like remote ports".
746		1119
747	The failure modes for local ports are quite different (runtime errors	1120	The failure modes for local ports are quite different (runtime errors
…		…
756	ports being the special case/exception, where transport errors cannot	1129	ports being the special case/exception, where transport errors cannot
757	occur.	1130	occur.
758		1131
759	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1132	=item * Erlang uses processes and a mailbox, AEMP does not queue.
760		1133
761	Erlang uses processes that selectively receive messages, and therefore	1134	Erlang uses processes that selectively receive messages out of order, and
762	needs a queue. AEMP is event based, queuing messages would serve no	1135	therefore needs a queue. AEMP is event based, queuing messages would serve
763	useful purpose. For the same reason the pattern-matching abilities of	1136	no useful purpose. For the same reason the pattern-matching abilities
764	AnyEvent::MP are more limited, as there is little need to be able to	1137	of AnyEvent::MP are more limited, as there is little need to be able to
765	filter messages without dequeuing them.	1138	filter messages without dequeuing them.
766		1139
767	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	1140	This is not a philosophical difference, but simply stems from AnyEvent::MP
		1141	being event-based, while Erlang is process-based.
		1142
		1143	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		1144	top of AEMP and Coro threads.
768		1145
769	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1146	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
770		1147
771	Sending messages in Erlang is synchronous and blocks the process (and	1148	Sending messages in Erlang is synchronous and blocks the process until
		1149	a conenction has been established and the message sent (and so does not
772	so does not need a queue that can overflow). AEMP sends are immediate,	1150	need a queue that can overflow). AEMP sends return immediately, connection
773	connection establishment is handled in the background.	1151	establishment is handled in the background.
774		1152
775	=item * Erlang suffers from silent message loss, AEMP does not.	1153	=item * Erlang suffers from silent message loss, AEMP does not.
776		1154
777	Erlang makes few guarantees on messages delivery - messages can get lost	1155	Erlang implements few guarantees on messages delivery - messages can get
778	without any of the processes realising it (i.e. you send messages a, b,	1156	lost without any of the processes realising it (i.e. you send messages a,
779	and c, and the other side only receives messages a and c).	1157	b, and c, and the other side only receives messages a and c).
780		1158
781	AEMP guarantees correct ordering, and the guarantee that after one message	1159	AEMP guarantees (modulo hardware errors) correct ordering, and the
782	is lost, all following ones sent to the same port are lost as well, until	1160	guarantee that after one message is lost, all following ones sent to the
783	monitoring raises an error, so there are no silent "holes" in the message	1161	same port are lost as well, until monitoring raises an error, so there are
784	sequence.	1162	no silent "holes" in the message sequence.
		1163
		1164	If you want your software to be very reliable, you have to cope with
		1165	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		1166	simply tries to work better in common error cases, such as when a network
		1167	link goes down.
785		1168
786	=item * Erlang can send messages to the wrong port, AEMP does not.	1169	=item * Erlang can send messages to the wrong port, AEMP does not.
787		1170
788	In Erlang it is quite likely that a node that restarts reuses a process ID	1171	In Erlang it is quite likely that a node that restarts reuses an Erlang
789	known to other nodes for a completely different process, causing messages	1172	process ID known to other nodes for a completely different process,
790	destined for that process to end up in an unrelated process.	1173	causing messages destined for that process to end up in an unrelated
		1174	process.
791		1175
792	AEMP never reuses port IDs, so old messages or old port IDs floating	1176	AEMP does not reuse port IDs, so old messages or old port IDs floating
793	around in the network will not be sent to an unrelated port.	1177	around in the network will not be sent to an unrelated port.
794		1178
795	=item * Erlang uses unprotected connections, AEMP uses secure	1179	=item * Erlang uses unprotected connections, AEMP uses secure
796	authentication and can use TLS.	1180	authentication and can use TLS.
797		1181
…		…
800		1184
801	=item * The AEMP protocol is optimised for both text-based and binary	1185	=item * The AEMP protocol is optimised for both text-based and binary
802	communications.	1186	communications.
803		1187
804	The AEMP protocol, unlike the Erlang protocol, supports both programming	1188	The AEMP protocol, unlike the Erlang protocol, supports both programming
805	language independent text-only protocols (good for debugging) and binary,	1189	language independent text-only protocols (good for debugging), and binary,
806	language-specific serialisers (e.g. Storable). By default, unless TLS is	1190	language-specific serialisers (e.g. Storable). By default, unless TLS is
807	used, the protocol is actually completely text-based.	1191	used, the protocol is actually completely text-based.
808		1192
809	It has also been carefully designed to be implementable in other languages	1193	It has also been carefully designed to be implementable in other languages
810	with a minimum of work while gracefully degrading functionality to make the	1194	with a minimum of work while gracefully degrading functionality to make the
811	protocol simple.	1195	protocol simple.
812		1196
813	=item * AEMP has more flexible monitoring options than Erlang.	1197	=item * AEMP has more flexible monitoring options than Erlang.
814		1198
815	In Erlang, you can chose to receive I<all> exit signals as messages	1199	In Erlang, you can chose to receive I<all> exit signals as messages or
816	or I<none>, there is no in-between, so monitoring single processes is	1200	I<none>, there is no in-between, so monitoring single Erlang processes is
817	difficult to implement. Monitoring in AEMP is more flexible than in	1201	difficult to implement.
818	Erlang, as one can choose between automatic kill, exit message or callback	1202
819	on a per-process basis.	1203	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		1204	between automatic kill, exit message or callback on a per-port basis.
820		1205
821	=item * Erlang tries to hide remote/local connections, AEMP does not.	1206	=item * Erlang tries to hide remote/local connections, AEMP does not.
822		1207
823	Monitoring in Erlang is not an indicator of process death/crashes, in the	1208	Monitoring in Erlang is not an indicator of process death/crashes, in the
824	same way as linking is (except linking is unreliable in Erlang).	1209	same way as linking is (except linking is unreliable in Erlang).
…		…
846	overhead, as well as having to keep a proxy object everywhere.	1231	overhead, as well as having to keep a proxy object everywhere.
847		1232
848	Strings can easily be printed, easily serialised etc. and need no special	1233	Strings can easily be printed, easily serialised etc. and need no special
849	procedures to be "valid".	1234	procedures to be "valid".
850		1235
851	And as a result, a miniport consists of a single closure stored in a	1236	And as a result, a port with just a default receiver consists of a single
852	global hash - it can't become much cheaper.	1237	code reference stored in a global hash - it can't become much cheaper.
853		1238
854	=item Why favour JSON, why not a real serialising format such as Storable?	1239	=item Why favour JSON, why not a real serialising format such as Storable?
855		1240
856	In fact, any AnyEvent::MP node will happily accept Storable as framing	1241	In fact, any AnyEvent::MP node will happily accept Storable as framing
857	format, but currently there is no way to make a node use Storable by	1242	format, but currently there is no way to make a node use Storable by
…		…
867	Keeping your messages simple, concentrating on data structures rather than	1252	Keeping your messages simple, concentrating on data structures rather than
868	objects, will keep your messages clean, tidy and efficient.	1253	objects, will keep your messages clean, tidy and efficient.
869		1254
870	=back	1255	=back
871		1256
		1257	=head1 PORTING FROM AnyEvent::MP VERSION 1.X
		1258
		1259	AEMP version 2 has three major incompatible changes compared to version 1:
		1260
		1261	=over 4
		1262
		1263	=item AnyEvent::MP::Global no longer has group management functions.
		1264
		1265	AnyEvent::MP now comes with a distributed database that is more
		1266	powerful. It's database families map closely to ports, but the API has
		1267	minor differences:
		1268
		1269	grp_reg $group, $port # old
		1270	db_reg $group, $port # new
		1271
		1272	$list = grp_get $group # old
		1273	db_keys $group, sub { my $list = shift } # new
		1274
		1275	grp_mon $group, $cb->(\@ports, $add, $del) # old
		1276	db_mon $group, $cb->(\%ports, $add, $change, $del) # new
		1277
		1278	C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get>
		1279	is no longer instant, because the local node might not have a copy of
		1280	the group. This can be partially remedied by using C<db_mon> to keep an
		1281	updated copy of the group:
		1282
		1283	my $local_group_copy;
		1284	db_mon $group => sub { $local_group_copy = shift };
		1285
		1286	# no keys %$local_group_copy always returns the most up-to-date
		1287	# list of ports in the group.
		1288
		1289	C<grp_mon> can almost be replaced by C<db_mon>:
		1290
		1291	db_mon $group => sub {
		1292	my ($ports, $add, $chg, $lde) = @_;
		1293	$ports = [keys %$ports];
		1294
		1295	# now $ports, $add and $del are the same as
		1296	# were originally passed by grp_mon.
		1297	...
		1298	};
		1299
		1300	=item Nodes not longer connect to all other nodes.
		1301
		1302	In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
		1303	module, which in turn would create connections to all other nodes in the
		1304	network (helped by the seed nodes).
		1305
		1306	In version 2.x, global nodes still connect to all other global nodes, but
		1307	other nodes don't - now every node either is a global node itself, or
		1308	attaches itself to another global node.
		1309
		1310	If a node isn't a global node itself, then it attaches itself to one
		1311	of its seed nodes. If that seed node isn't a global node yet, it will
		1312	automatically be upgraded to a global node.
		1313
		1314	So in many cases, nothing needs to be changed - one just has to make sure
		1315	that all seed nodes are meshed together with the other seed nodes (as with
		1316	AEMP 1.x), and other nodes specify them as seed nodes.
		1317
		1318	Not opening a connection to every other node is usually an advantage,
		1319	except when you need the lower latency of an already established
		1320	connection. To ensure a node establishes a connection to another node,
		1321	you can monitor the node port (C<mon $node, ...>), which will attempt to
		1322	create the connection (and notify you when the connection fails).
		1323
		1324	=item Listener-less nodes (nodes without binds) are gone.
		1325
		1326	And are not coming back, at least not in their old form. If no C<binds>
		1327	are specified for a node, AnyEvent::MP now assumes a default of C<:>.
		1328
		1329	There are vague plans to implement some form of routing domains, which
		1330	might or might not bring back listener-less nodes, but don't count on it.
		1331
		1332	The fact that most connections are now optional somewhat mitigates this,
		1333	as a node can be effectively unreachable from the outside without any
		1334	problems, as long as it isn't a global node and only reaches out to other
		1335	nodes (as opposed to being contacted from other nodes).
		1336
		1337	=item $AnyEvent::MP::Kernel::WARN has gone.
		1338
		1339	AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
		1340	uses this, and so should your programs.
		1341
		1342	Every module now documents what kinds of messages it generates, with
		1343	AnyEvent::MP acting as a catch all.
		1344
		1345	On the positive side, this means that instead of setting
		1346	C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE>,
		1347	much less to type.
		1348
		1349	=back
		1350
872	=head1 SEE ALSO	1351	=head1 SEE ALSO
873		1352
874	L<AnyEvent::MP::Intro> - a gentle introduction.	1353	L<AnyEvent::MP::Intro> - a gentle introduction.
875		1354
876	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1355	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
877		1356
878	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1357	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
879	your applications.	1358	your applications.
		1359
		1360	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
880		1361
881	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from	1362	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
882	all nodes.	1363	all nodes.
883		1364
884	L<AnyEvent>.	1365	L<AnyEvent>.

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.86 by root, Wed Sep 9 01:47:01 2009 UTC vs. Revision 1.138 by root, Thu Mar 22 00:48:29 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.86 by root, Wed Sep 9 01:47:01 2009 UTC vs.
Revision 1.138 by root, Thu Mar 22 00:48:29 2012 UTC