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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.81 by root, Mon Sep 7 18:33:44 2009 UTC vs.
Revision 1.131 by root, Fri Mar 9 19:07:53 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-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
		120	=item seed nodes
		121
		122	When a node starts, it knows nothing about the network it is in - it
		123	needs to connect to at least one other node that is already in the
		124	network. These other nodes are called "seed nodes".
		125
		126	Seed nodes themselves are not special - they are seed nodes only because
		127	some other node I<uses> them as such, but any node can be used as seed
		128	node for other nodes, and eahc node cna use a different set of seed nodes.
		129
		130	In addition to discovering the network, seed nodes are also used to
		131	maintain the network - all nodes using the same seed node form are part of
		132	the same network. If a network is split into multiple subnets because e.g.
		133	the network link between the parts goes down, then using the same seed
		134	nodes for all nodes ensures that eventually the subnets get merged again.
		135
		136	Seed nodes are expected to be long-running, and at least one seed node
		137	should always be available. They should also be relatively responsive - a
		138	seed node that blocks for long periods will slow down everybody else.
		139
		140	For small networks, it's best if every node uses the same set of seed
		141	nodes. For large networks, it can be useful to specify "regional" seed
		142	nodes for most nodes in an area, and use all seed nodes as seed nodes for
		143	each other. What's important is that all seed nodes connections form a
		144	complete graph, so that the network cannot split into separate subnets
		145	forever.
		146
		147	Seed nodes are represented by seed IDs.
		148
102	=item seeds - C<host:port>	149	=item seed IDs - C<host:port>
103		150
104	When a node starts, it knows nothing about the network. To teach the node	151	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
105	about the network it first has to contact some other node within the	152	TCP port) of nodes that should be used as seed nodes.
106	network. This node is called a seed.
107		153
108	Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes	154	=item global nodes
109	are expected to be long-running, and at least one of those should always
110	be available. When nodes run out of connections (e.g. due to a network
111	error), they try to re-establish connections to some seednodes again to
112	join the network.
113		155
114	Apart from being sued for seeding, seednodes are not special in any way -	156	An AEMP network needs a discovery service - nodes need to know how to
115	every public node can be a seednode.	157	connect to other nodes they only know by name. In addition, AEMP offers a
		158	distributed "group database", which maps group names to a list of strings
		159	- for example, to register worker ports.
		160
		161	A network needs at least one global node to work, and allows every node to
		162	be a global node.
		163
		164	Any node that loads the L<AnyEvent::MP::Global> module becomes a global
		165	node and tries to keep connections to all other nodes. So while it can
		166	make sense to make every node "global" in small networks, it usually makes
		167	sense to only make seed nodes into global nodes in large networks (nodes
		168	keep connections to seed nodes and global nodes, so makign them the same
		169	reduces overhead).
116		170
117	=back	171	=back
118		172
119	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
120		174
…		…
122		176
123	=cut	177	=cut
124		178
125	package AnyEvent::MP;	179	package AnyEvent::MP;
126		180
		181	use AnyEvent::MP::Config ();
127	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
128		184
129	use common::sense;	185	use common::sense;
130		186
131	use Carp ();	187	use Carp ();
132		188
133	use AE ();	189	use AE ();
		190	use Guard ();
134		191
135	use base "Exporter";	192	use base "Exporter";
136		193
137	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
138		195
139	our @EXPORT = qw(	196	our @EXPORT = qw(
140	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
141	configure	198	configure
142	snd rcv mon mon_guard kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
143	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
144	);	203	);
145		204
146	our $SELF;	205	our $SELF;
147		206
148	sub _self_die() {	207	sub _self_die() {
…		…
171	some other nodes in the network to discover other nodes.	230	some other nodes in the network to discover other nodes.
172		231
173	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
174	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
175		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->($nodeid)
		253
		254	In addition to specifying a boolean, you can specify a code reference that
		255	is called for every remote execution attempt - the execution request is
		256	granted iff the callback returns a true value.
		257
		258	See F<semp setsecure> for more info.
		259
		260	=back
		261
176	=over 4	262	=over 4
177		263
178	=item step 1, gathering configuration from profiles	264	=item step 1, gathering configuration from profiles
179		265
180	The function first looks up a profile in the aemp configuration (see the	266	The function first looks up a profile in the aemp configuration (see the
…		…
193	That means that the values specified in the profile have highest priority	279	That means that the values specified in the profile have highest priority
194	and the values specified directly via C<configure> have lowest priority,	280	and the values specified directly via C<configure> have lowest priority,
195	and can only be used to specify defaults.	281	and can only be used to specify defaults.
196		282
197	If the profile specifies a node ID, then this will become the node ID of	283	If the profile specifies a node ID, then this will become the node ID of
198	this process. If not, then the profile name will be used as node ID. The	284	this process. If not, then the profile name will be used as node ID, with
199	special node ID of C<anon/> will be replaced by a random node ID.	285	a unique randoms tring (C</%u>) appended.
		286
		287	The node ID can contain some C<%> sequences that are expanded: C<%n>
		288	is expanded to the local nodename, C<%u> is replaced by a random
		289	strign to make the node unique. For example, the F<aemp> commandline
		290	utility uses C<aemp/%n/%u> as nodename, which might expand to
		291	C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
200		292
201	=item step 2, bind listener sockets	293	=item step 2, bind listener sockets
202		294
203	The next step is to look up the binds in the profile, followed by binding	295	The next step is to look up the binds in the profile, followed by binding
204	aemp protocol listeners on all binds specified (it is possible and valid	296	aemp protocol listeners on all binds specified (it is possible and valid
…		…
210	used, meaning the node will bind on a dynamically-assigned port on every	302	used, meaning the node will bind on a dynamically-assigned port on every
211	local IP address it finds.	303	local IP address it finds.
212		304
213	=item step 3, connect to seed nodes	305	=item step 3, connect to seed nodes
214		306
215	As the last step, the seeds list from the profile is passed to the	307	As the last step, the seed ID list from the profile is passed to the
216	L<AnyEvent::MP::Global> module, which will then use it to keep	308	L<AnyEvent::MP::Global> module, which will then use it to keep
217	connectivity with at least one node at any point in time.	309	connectivity with at least one node at any point in time.
218		310
219	=back	311	=back
220		312
221	Example: become a distributed node using the locla node name as profile.	313	Example: become a distributed node using the local node name as profile.
222	This should be the most common form of invocation for "daemon"-type nodes.	314	This should be the most common form of invocation for "daemon"-type nodes.
223		315
224	configure	316	configure
225		317
226	Example: become an anonymous node. This form is often used for commandline	318	Example: become a semi-anonymous node. This form is often used for
227	clients.	319	commandline clients.
228		320
229	configure nodeid => "anon/";	321	configure nodeid => "myscript/%n/%u";
230		322
231	Example: configure a node using a profile called seed, which si suitable	323	Example: configure a node using a profile called seed, which is suitable
232	for a seed node as it binds on all local addresses on a fixed port (4040,	324	for a seed node as it binds on all local addresses on a fixed port (4040,
233	customary for aemp).	325	customary for aemp).
234		326
235	# use the aemp commandline utility	327	# use the aemp commandline utility
236	# aemp profile seed nodeid anon/ binds '*:4040'	328	# aemp profile seed binds '*:4040'
237		329
238	# then use it	330	# then use it
239	configure profile => "seed";	331	configure profile => "seed";
240		332
241	# or simply use aemp from the shell again:	333	# or simply use aemp from the shell again:
…		…
311	sub _kilme {	403	sub _kilme {
312	die "received message on port without callback";	404	die "received message on port without callback";
313	}	405	}
314		406
315	sub port(;&) {	407	sub port(;&) {
316	my $id = "$UNIQ." . $ID++;	408	my $id = $UNIQ . ++$ID;
317	my $port = "$NODE#$id";	409	my $port = "$NODE#$id";
318		410
319	rcv $port, shift \|\| \&_kilme;	411	rcv $port, shift \|\| \&_kilme;
320		412
321	$port	413	$port
…		…
360	msg1 => sub { ... },	452	msg1 => sub { ... },
361	...	453	...
362	;	454	;
363		455
364	Example: temporarily register a rcv callback for a tag matching some port	456	Example: temporarily register a rcv callback for a tag matching some port
365	(e.g. for a rpc reply) and unregister it after a message was received.	457	(e.g. for an rpc reply) and unregister it after a message was received.
366		458
367	rcv $port, $otherport => sub {	459	rcv $port, $otherport => sub {
368	my @reply = @_;	460	my @reply = @_;
369		461
370	rcv $SELF, $otherport;	462	rcv $SELF, $otherport;
…		…
383	if (ref $_[0]) {	475	if (ref $_[0]) {
384	if (my $self = $PORT_DATA{$portid}) {	476	if (my $self = $PORT_DATA{$portid}) {
385	"AnyEvent::MP::Port" eq ref $self	477	"AnyEvent::MP::Port" eq ref $self
386	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	478	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
387		479
388	$self->[2] = shift;	480	$self->[0] = shift;
389	} else {	481	} else {
390	my $cb = shift;	482	my $cb = shift;
391	$PORT{$portid} = sub {	483	$PORT{$portid} = sub {
392	local $SELF = $port;	484	local $SELF = $port;
393	eval { &$cb }; _self_die if $@;	485	eval { &$cb }; _self_die if $@;
394	};	486	};
395	}	487	}
396	} elsif (defined $_[0]) {	488	} elsif (defined $_[0]) {
397	my $self = $PORT_DATA{$portid} \|\|= do {	489	my $self = $PORT_DATA{$portid} \|\|= do {
398	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	490	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
399		491
400	$PORT{$portid} = sub {	492	$PORT{$portid} = sub {
401	local $SELF = $port;	493	local $SELF = $port;
402		494
403	if (my $cb = $self->[1]{$_[0]}) {	495	if (my $cb = $self->[1]{$_[0]}) {
…		…
425	}	517	}
426		518
427	$port	519	$port
428	}	520	}
429		521
		522	=item peval $port, $coderef[, @args]
		523
		524	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		525	when the code throews an exception the C<$port> will be killed.
		526
		527	Any remaining args will be passed to the callback. Any return values will
		528	be returned to the caller.
		529
		530	This is useful when you temporarily want to execute code in the context of
		531	a port.
		532
		533	Example: create a port and run some initialisation code in it's context.
		534
		535	my $port = port { ... };
		536
		537	peval $port, sub {
		538	init
		539	or die "unable to init";
		540	};
		541
		542	=cut
		543
		544	sub peval($$) {
		545	local $SELF = shift;
		546	my $cb = shift;
		547
		548	if (wantarray) {
		549	my @res = eval { &$cb };
		550	_self_die if $@;
		551	@res
		552	} else {
		553	my $res = eval { &$cb };
		554	_self_die if $@;
		555	$res
		556	}
		557	}
		558
430	=item $closure = psub { BLOCK }	559	=item $closure = psub { BLOCK }
431		560
432	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	561	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
433	closure is executed, sets up the environment in the same way as in C<rcv>	562	closure is executed, sets up the environment in the same way as in C<rcv>
434	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.	563	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		564
		565	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		566	BLOCK }, @_ } >>.
435		567
436	This is useful when you register callbacks from C<rcv> callbacks:	568	This is useful when you register callbacks from C<rcv> callbacks:
437		569
438	rcv delayed_reply => sub {	570	rcv delayed_reply => sub {
439	my ($delay, @reply) = @_;	571	my ($delay, @reply) = @_;
…		…
512	delivered again.	644	delivered again.
513		645
514	Inter-host-connection timeouts and monitoring depend on the transport	646	Inter-host-connection timeouts and monitoring depend on the transport
515	used. The only transport currently implemented is TCP, and AnyEvent::MP	647	used. The only transport currently implemented is TCP, and AnyEvent::MP
516	relies on TCP to detect node-downs (this can take 10-15 minutes on a	648	relies on TCP to detect node-downs (this can take 10-15 minutes on a
517	non-idle connection, and usually around two hours for idle conenctions).	649	non-idle connection, and usually around two hours for idle connections).
518		650
519	This means that monitoring is good for program errors and cleaning up	651	This means that monitoring is good for program errors and cleaning up
520	stuff eventually, but they are no replacement for a timeout when you need	652	stuff eventually, but they are no replacement for a timeout when you need
521	to ensure some maximum latency.	653	to ensure some maximum latency.
522		654
…		…
554	}	686	}
555		687
556	$node->monitor ($port, $cb);	688	$node->monitor ($port, $cb);
557		689
558	defined wantarray	690	defined wantarray
559	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	691	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
560	}	692	}
561		693
562	=item $guard = mon_guard $port, $ref, $ref...	694	=item $guard = mon_guard $port, $ref, $ref...
563		695
564	Monitors the given C<$port> and keeps the passed references. When the port	696	Monitors the given C<$port> and keeps the passed references. When the port
…		…
587		719
588	=item kil $port[, @reason]	720	=item kil $port[, @reason]
589		721
590	Kill the specified port with the given C<@reason>.	722	Kill the specified port with the given C<@reason>.
591		723
592	If no C<@reason> is specified, then the port is killed "normally" (ports	724	If no C<@reason> is specified, then the port is killed "normally" -
593	monitoring other ports will not necessarily die because a port dies	725	monitor callback will be invoked, but the kil will not cause linked ports
594	"normally").	726	(C<mon $mport, $lport> form) to get killed.
595		727
596	Otherwise, linked ports get killed with the same reason (second form of	728	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
597	C<mon>, see above).	729	form) get killed with the same reason.
598		730
599	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	731	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
600	will be reported as reason C<< die => $@ >>.	732	will be reported as reason C<< die => $@ >>.
601		733
602	Transport/communication errors are reported as C<< transport_error =>	734	Transport/communication errors are reported as C<< transport_error =>
…		…
621	the package, then the package above the package and so on (e.g.	753	the package, then the package above the package and so on (e.g.
622	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	754	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
623	exists or it runs out of package names.	755	exists or it runs out of package names.
624		756
625	The init function is then called with the newly-created port as context	757	The init function is then called with the newly-created port as context
626	object (C<$SELF>) and the C<@initdata> values as arguments.	758	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		759	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		760	the port might not get created.
627		761
628	A common idiom is to pass a local port, immediately monitor the spawned	762	A common idiom is to pass a local port, immediately monitor the spawned
629	port, and in the remote init function, immediately monitor the passed	763	port, and in the remote init function, immediately monitor the passed
630	local port. This two-way monitoring ensures that both ports get cleaned up	764	local port. This two-way monitoring ensures that both ports get cleaned up
631	when there is a problem.	765	when there is a problem.
…		…
655		789
656	sub _spawn {	790	sub _spawn {
657	my $port = shift;	791	my $port = shift;
658	my $init = shift;	792	my $init = shift;
659		793
		794	# rcv will create the actual port
660	local $SELF = "$NODE#$port";	795	local $SELF = "$NODE#$port";
661	eval {	796	eval {
662	&{ load_func $init }	797	&{ load_func $init }
663	};	798	};
664	_self_die if $@;	799	_self_die if $@;
665	}	800	}
666		801
667	sub spawn(@) {	802	sub spawn(@) {
668	my ($nodeid, undef) = split /#/, shift, 2;	803	my ($nodeid, undef) = split /#/, shift, 2;
669		804
670	my $id = "$RUNIQ." . $ID++;	805	my $id = $RUNIQ . ++$ID;
671		806
672	$_[0] =~ /::/	807	$_[0] =~ /::/
673	or Carp::croak "spawn init function must be a fully-qualified name, caught";	808	or Carp::croak "spawn init function must be a fully-qualified name, caught";
674		809
675	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;	810	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
676		811
677	"$nodeid#$id"	812	"$nodeid#$id"
678	}	813	}
		814
679		815
680	=item after $timeout, @msg	816	=item after $timeout, @msg
681		817
682	=item after $timeout, $callback	818	=item after $timeout, $callback
683		819
…		…
699	? $action[0]()	835	? $action[0]()
700	: snd @action;	836	: snd @action;
701	};	837	};
702	}	838	}
703		839
		840	#=item $cb2 = timeout $seconds, $cb[, @args]
		841
		842	=item cal $port, @msg, $callback[, $timeout]
		843
		844	A simple form of RPC - sends a message to the given C<$port> with the
		845	given contents (C<@msg>), but adds a reply port to the message.
		846
		847	The reply port is created temporarily just for the purpose of receiving
		848	the reply, and will be C<kil>ed when no longer needed.
		849
		850	A reply message sent to the port is passed to the C<$callback> as-is.
		851
		852	If an optional time-out (in seconds) is given and it is not C<undef>,
		853	then the callback will be called without any arguments after the time-out
		854	elapsed and the port is C<kil>ed.
		855
		856	If no time-out is given (or it is C<undef>), then the local port will
		857	monitor the remote port instead, so it eventually gets cleaned-up.
		858
		859	Currently this function returns the temporary port, but this "feature"
		860	might go in future versions unless you can make a convincing case that
		861	this is indeed useful for something.
		862
		863	=cut
		864
		865	sub cal(@) {
		866	my $timeout = ref $_[-1] ? undef : pop;
		867	my $cb = pop;
		868
		869	my $port = port {
		870	undef $timeout;
		871	kil $SELF;
		872	&$cb;
		873	};
		874
		875	if (defined $timeout) {
		876	$timeout = AE::timer $timeout, 0, sub {
		877	undef $timeout;
		878	kil $port;
		879	$cb->();
		880	};
		881	} else {
		882	mon $_[0], sub {
		883	kil $port;
		884	$cb->();
		885	};
		886	}
		887
		888	push @_, $port;
		889	&snd;
		890
		891	$port
		892	}
		893
		894	=back
		895
		896	=head1 DISTRIBUTED DATABASE
		897
		898	AnyEvent::MP comes with a simple distributed database. The database will
		899	be mirrored asynchronously on all global nodes. Other nodes bind to one
		900	of the global nodes for their needs. Every node has a "local database"
		901	which contains all the values that are set locally. All local databases
		902	are merged together to form the global database, which can be queried.
		903
		904	The database structure is that of a two-level hash - the database hash
		905	contains hashes which contain values, similarly to a perl hash of hashes,
		906	i.e.:
		907
		908	$DATABASE{$family}{$subkey} = $value
		909
		910	The top level hash key is called "family", and the second-level hash key
		911	is called "subkey" or simply "key".
		912
		913	The family must be alphanumeric, i.e. start with a letter and consist
		914	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		915	pretty much like Perl module names.
		916
		917	As the family namespace is global, it is recommended to prefix family names
		918	with the name of the application or module using it.
		919
		920	The subkeys must be non-empty strings, with no further restrictions.
		921
		922	The values should preferably be strings, but other perl scalars should
		923	work as well (such as C<undef>, arrays and hashes).
		924
		925	Every database entry is owned by one node - adding the same family/subkey
		926	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		927	but the result might be nondeterministic, i.e. the key might have
		928	different values on different nodes.
		929
		930	Different subkeys in the same family can be owned by different nodes
		931	without problems, and in fact, this is the common method to create worker
		932	pools. For example, a worker port for image scaling might do this:
		933
		934	db_set my_image_scalers => $port;
		935
		936	And clients looking for an image scaler will want to get the
		937	C<my_image_scalers> keys from time to time:
		938
		939	db_keys my_image_scalers => sub {
		940	@ports = @{ $_[0] };
		941	};
		942
		943	Or better yet, they want to monitor the database family, so they always
		944	have a reasonable up-to-date copy:
		945
		946	db_mon my_image_scalers => sub {
		947	@ports = keys %{ $_[0] };
		948	};
		949
		950	In general, you can set or delete single subkeys, but query and monitor
		951	whole families only.
		952
		953	If you feel the need to monitor or query a single subkey, try giving it
		954	it's own family.
		955
		956	=over
		957
		958	=item db_set $family => $subkey [=> $value]
		959
		960	Sets (or replaces) a key to the database - if C<$value> is omitted,
		961	C<undef> is used instead.
		962
		963	=item db_del $family => $subkey...
		964
		965	Deletes one or more subkeys from the database family.
		966
		967	=item $guard = db_reg $family => $subkey [=> $value]
		968
		969	Sets the key on the database and returns a guard. When the guard is
		970	destroyed, the key is deleted from the database. If C<$value> is missing,
		971	then C<undef> is used.
		972
		973	=item db_family $family => $cb->(\%familyhash)
		974
		975	Queries the named database C<$family> and call the callback with the
		976	family represented as a hash. You can keep and freely modify the hash.
		977
		978	=item db_keys $family => $cb->(\@keys)
		979
		980	Same as C<db_family>, except it only queries the family I<subkeys> and passes
		981	them as array reference to the callback.
		982
		983	=item db_values $family => $cb->(\@values)
		984
		985	Same as C<db_family>, except it only queries the family I<values> and passes them
		986	as array reference to the callback.
		987
		988	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
		989
		990	Creates a monitor on the given database family. Each time a key is set
		991	or or is deleted the callback is called with a hash containing the
		992	database family and three lists of added, changed and deleted subkeys,
		993	respectively. If no keys have changed then the array reference might be
		994	C<undef> or even missing.
		995
		996	The family hash reference and the key arrays belong to AnyEvent::MP and
		997	B<must not be modified or stored> by the callback. When in doubt, make a
		998	copy.
		999
		1000	As soon as possible after the monitoring starts, the callback will be
		1001	called with the intiial contents of the family, even if it is empty,
		1002	i.e. there will always be a timely call to the callback with the current
		1003	contents.
		1004
		1005	It is possible that the callback is called with a change event even though
		1006	the subkey is already present and the value has not changed.
		1007
		1008	The monitoring stops when the guard object is destroyed.
		1009
		1010	Example: on every change to the family "mygroup", print out all keys.
		1011
		1012	my $guard = db_mon mygroup => sub {
		1013	my ($family, $a, $c, $d) = @_;
		1014	print "mygroup members: ", (join " ", keys %$family), "\n";
		1015	};
		1016
		1017	Exmaple: wait until the family "My::Module::workers" is non-empty.
		1018
		1019	my $guard; $guard = db_mon My::Module::workers => sub {
		1020	my ($family, $a, $c, $d) = @_;
		1021	return unless %$family;
		1022	undef $guard;
		1023	print "My::Module::workers now nonempty\n";
		1024	};
		1025
		1026	Example: print all changes to the family "AnyRvent::Fantasy::Module".
		1027
		1028	my $guard = db_mon AnyRvent::Fantasy::Module => sub {
		1029	my ($family, $a, $c, $d) = @_;
		1030
		1031	print "+$_=$family->{$_}\n" for @$a;
		1032	print "*$_=$family->{$_}\n" for @$c;
		1033	print "-$_=$family->{$_}\n" for @$d;
		1034	};
		1035
		1036	=cut
		1037
704	=back	1038	=back
705		1039
706	=head1 AnyEvent::MP vs. Distributed Erlang	1040	=head1 AnyEvent::MP vs. Distributed Erlang
707		1041
708	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	1042	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
709	== aemp node, Erlang process == aemp port), so many of the documents and	1043	== aemp node, Erlang process == aemp port), so many of the documents and
710	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	1044	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
711	sample:	1045	sample:
712		1046
713	http://www.Erlang.se/doc/programming_rules.shtml	1047	http://www.erlang.se/doc/programming_rules.shtml
714	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	1048	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
715	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6	1049	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
716	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	1050	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
717		1051
718	Despite the similarities, there are also some important differences:	1052	Despite the similarities, there are also some important differences:
719		1053
720	=over 4	1054	=over 4
721		1055
722	=item * Node IDs are arbitrary strings in AEMP.	1056	=item * Node IDs are arbitrary strings in AEMP.
723		1057
724	Erlang relies on special naming and DNS to work everywhere in the same	1058	Erlang relies on special naming and DNS to work everywhere in the same
725	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by	1059	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
726	configuration or DNS), but will otherwise discover other odes itself.	1060	configuration or DNS), and possibly the addresses of some seed nodes, but
		1061	will otherwise discover other nodes (and their IDs) itself.
727		1062
728	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	1063	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
729	uses "local ports are like remote ports".	1064	uses "local ports are like remote ports".
730		1065
731	The failure modes for local ports are quite different (runtime errors	1066	The failure modes for local ports are quite different (runtime errors
…		…
740	ports being the special case/exception, where transport errors cannot	1075	ports being the special case/exception, where transport errors cannot
741	occur.	1076	occur.
742		1077
743	=item * Erlang uses processes and a mailbox, AEMP does not queue.	1078	=item * Erlang uses processes and a mailbox, AEMP does not queue.
744		1079
745	Erlang uses processes that selectively receive messages, and therefore	1080	Erlang uses processes that selectively receive messages out of order, and
746	needs a queue. AEMP is event based, queuing messages would serve no	1081	therefore needs a queue. AEMP is event based, queuing messages would serve
747	useful purpose. For the same reason the pattern-matching abilities of	1082	no useful purpose. For the same reason the pattern-matching abilities
748	AnyEvent::MP are more limited, as there is little need to be able to	1083	of AnyEvent::MP are more limited, as there is little need to be able to
749	filter messages without dequeuing them.	1084	filter messages without dequeuing them.
750		1085
751	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	1086	This is not a philosophical difference, but simply stems from AnyEvent::MP
		1087	being event-based, while Erlang is process-based.
		1088
		1089	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		1090	top of AEMP and Coro threads.
752		1091
753	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1092	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
754		1093
755	Sending messages in Erlang is synchronous and blocks the process (and	1094	Sending messages in Erlang is synchronous and blocks the process until
		1095	a conenction has been established and the message sent (and so does not
756	so does not need a queue that can overflow). AEMP sends are immediate,	1096	need a queue that can overflow). AEMP sends return immediately, connection
757	connection establishment is handled in the background.	1097	establishment is handled in the background.
758		1098
759	=item * Erlang suffers from silent message loss, AEMP does not.	1099	=item * Erlang suffers from silent message loss, AEMP does not.
760		1100
761	Erlang makes few guarantees on messages delivery - messages can get lost	1101	Erlang implements few guarantees on messages delivery - messages can get
762	without any of the processes realising it (i.e. you send messages a, b,	1102	lost without any of the processes realising it (i.e. you send messages a,
763	and c, and the other side only receives messages a and c).	1103	b, and c, and the other side only receives messages a and c).
764		1104
765	AEMP guarantees correct ordering, and the guarantee that after one message	1105	AEMP guarantees (modulo hardware errors) correct ordering, and the
766	is lost, all following ones sent to the same port are lost as well, until	1106	guarantee that after one message is lost, all following ones sent to the
767	monitoring raises an error, so there are no silent "holes" in the message	1107	same port are lost as well, until monitoring raises an error, so there are
768	sequence.	1108	no silent "holes" in the message sequence.
		1109
		1110	If you want your software to be very reliable, you have to cope with
		1111	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		1112	simply tries to work better in common error cases, such as when a network
		1113	link goes down.
769		1114
770	=item * Erlang can send messages to the wrong port, AEMP does not.	1115	=item * Erlang can send messages to the wrong port, AEMP does not.
771		1116
772	In Erlang it is quite likely that a node that restarts reuses a process ID	1117	In Erlang it is quite likely that a node that restarts reuses an Erlang
773	known to other nodes for a completely different process, causing messages	1118	process ID known to other nodes for a completely different process,
774	destined for that process to end up in an unrelated process.	1119	causing messages destined for that process to end up in an unrelated
		1120	process.
775		1121
776	AEMP never reuses port IDs, so old messages or old port IDs floating	1122	AEMP does not reuse port IDs, so old messages or old port IDs floating
777	around in the network will not be sent to an unrelated port.	1123	around in the network will not be sent to an unrelated port.
778		1124
779	=item * Erlang uses unprotected connections, AEMP uses secure	1125	=item * Erlang uses unprotected connections, AEMP uses secure
780	authentication and can use TLS.	1126	authentication and can use TLS.
781		1127
…		…
784		1130
785	=item * The AEMP protocol is optimised for both text-based and binary	1131	=item * The AEMP protocol is optimised for both text-based and binary
786	communications.	1132	communications.
787		1133
788	The AEMP protocol, unlike the Erlang protocol, supports both programming	1134	The AEMP protocol, unlike the Erlang protocol, supports both programming
789	language independent text-only protocols (good for debugging) and binary,	1135	language independent text-only protocols (good for debugging), and binary,
790	language-specific serialisers (e.g. Storable). By default, unless TLS is	1136	language-specific serialisers (e.g. Storable). By default, unless TLS is
791	used, the protocol is actually completely text-based.	1137	used, the protocol is actually completely text-based.
792		1138
793	It has also been carefully designed to be implementable in other languages	1139	It has also been carefully designed to be implementable in other languages
794	with a minimum of work while gracefully degrading functionality to make the	1140	with a minimum of work while gracefully degrading functionality to make the
795	protocol simple.	1141	protocol simple.
796		1142
797	=item * AEMP has more flexible monitoring options than Erlang.	1143	=item * AEMP has more flexible monitoring options than Erlang.
798		1144
799	In Erlang, you can chose to receive I<all> exit signals as messages	1145	In Erlang, you can chose to receive I<all> exit signals as messages or
800	or I<none>, there is no in-between, so monitoring single processes is	1146	I<none>, there is no in-between, so monitoring single Erlang processes is
801	difficult to implement. Monitoring in AEMP is more flexible than in	1147	difficult to implement.
802	Erlang, as one can choose between automatic kill, exit message or callback	1148
803	on a per-process basis.	1149	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		1150	between automatic kill, exit message or callback on a per-port basis.
804		1151
805	=item * Erlang tries to hide remote/local connections, AEMP does not.	1152	=item * Erlang tries to hide remote/local connections, AEMP does not.
806		1153
807	Monitoring in Erlang is not an indicator of process death/crashes, in the	1154	Monitoring in Erlang is not an indicator of process death/crashes, in the
808	same way as linking is (except linking is unreliable in Erlang).	1155	same way as linking is (except linking is unreliable in Erlang).
…		…
830	overhead, as well as having to keep a proxy object everywhere.	1177	overhead, as well as having to keep a proxy object everywhere.
831		1178
832	Strings can easily be printed, easily serialised etc. and need no special	1179	Strings can easily be printed, easily serialised etc. and need no special
833	procedures to be "valid".	1180	procedures to be "valid".
834		1181
835	And as a result, a miniport consists of a single closure stored in a	1182	And as a result, a port with just a default receiver consists of a single
836	global hash - it can't become much cheaper.	1183	code reference stored in a global hash - it can't become much cheaper.
837		1184
838	=item Why favour JSON, why not a real serialising format such as Storable?	1185	=item Why favour JSON, why not a real serialising format such as Storable?
839		1186
840	In fact, any AnyEvent::MP node will happily accept Storable as framing	1187	In fact, any AnyEvent::MP node will happily accept Storable as framing
841	format, but currently there is no way to make a node use Storable by	1188	format, but currently there is no way to make a node use Storable by
…		…
857		1204
858	L<AnyEvent::MP::Intro> - a gentle introduction.	1205	L<AnyEvent::MP::Intro> - a gentle introduction.
859		1206
860	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1207	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
861		1208
862	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1209	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
863	your applications.	1210	your applications.
		1211
		1212	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
864		1213
865	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from	1214	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
866	all nodes.	1215	all nodes.
867		1216
868	L<AnyEvent>.	1217	L<AnyEvent>.

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.81 by root, Mon Sep 7 18:33:44 2009 UTC vs. Revision 1.131 by root, Fri Mar 9 19:07:53 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.81 by root, Mon Sep 7 18:33:44 2009 UTC vs.
Revision 1.131 by root, Fri Mar 9 19:07:53 2012 UTC