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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.119 by root, Sun Feb 26 10:29:59 2012 UTC vs.
Revision 1.133 by root, Mon Mar 12 10:34:06 2012 UTC

…		…
35	# destroy a port again	35	# destroy a port again
36	kil $port; # "normal" kill	36	kil $port; # "normal" kill
37	kil $port, my_error => "everything is broken"; # error kill	37	kil $port, my_error => "everything is broken"; # error kill
38		38
39	# monitoring	39	# monitoring
40	mon $localport, $cb->(@msg) # callback is invoked on death	40	mon $port, $cb->(@msg) # callback is invoked on death
41	mon $localport, $otherport # kill otherport on abnormal death	41	mon $port, $localport # kill localport on abnormal death
42	mon $localport, $otherport, @msg # send message on death	42	mon $port, $localport, @msg # send message on death
43		43
44	# temporarily execute code in port context	44	# temporarily execute code in port context
45	peval $port, sub { die "kill the port!" };	45	peval $port, sub { die "kill the port!" };
46		46
47	# execute callbacks in $SELF port context	47	# execute callbacks in $SELF port context
…		…
82		82
83	Ports are represented by (printable) strings called "port IDs".	83	Ports are represented by (printable) strings called "port IDs".
84		84
85	=item port ID - C<nodeid#portname>	85	=item port ID - C<nodeid#portname>
86		86
87	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<#>)
88	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).
89		90
90	=item node	91	=item node
91		92
92	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,
93	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
…		…
175		176
176	=cut	177	=cut
177		178
178	package AnyEvent::MP;	179	package AnyEvent::MP;
179		180
		181	use AnyEvent::MP::Config ();
180	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
181		184
182	use common::sense;	185	use common::sense;
183		186
184	use Carp ();	187	use Carp ();
185		188
186	use AE ();	189	use AE ();
		190	use Guard ();
187		191
188	use base "Exporter";	192	use base "Exporter";
189		193
190	our $VERSION = '1.30';	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
191		195
192	our @EXPORT = qw(	196	our @EXPORT = qw(
193	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
194	configure	198	configure
195	snd rcv mon mon_guard kil psub peval spawn cal	199	snd rcv mon mon_guard kil psub peval spawn cal
196	port	200	port
		201	db_set db_del db_reg
		202	db_mon db_family db_keys db_values
197	);	203	);
198		204
199	our $SELF;	205	our $SELF;
200		206
201	sub _self_die() {	207	sub _self_die() {
…		…
221	Before a node can talk to other nodes on the network (i.e. enter	227	Before a node can talk to other nodes on the network (i.e. enter
222	"distributed mode") it has to configure itself - the minimum a node needs	228	"distributed mode") it has to configure itself - the minimum a node needs
223	to know is its own name, and optionally it should know the addresses of	229	to know is its own name, and optionally it should know the addresses of
224	some other nodes in the network to discover other nodes.	230	some other nodes in the network to discover other nodes.
225		231
226	The key/value pairs are basically the same ones as documented for the
227	F<aemp> command line utility (sans the set/del prefix).
228
229	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
230	never) before calling other AnyEvent::MP functions.	233	never) before calling other AnyEvent::MP functions.
		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
231		261
232	=over 4	262	=over 4
233		263
234	=item step 1, gathering configuration from profiles	264	=item step 1, gathering configuration from profiles
235		265
…		…
249	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
250	and the values specified directly via C<configure> have lowest priority,	280	and the values specified directly via C<configure> have lowest priority,
251	and can only be used to specify defaults.	281	and can only be used to specify defaults.
252		282
253	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
254	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
255	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>.
256		292
257	=item step 2, bind listener sockets	293	=item step 2, bind listener sockets
258		294
259	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
260	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
…		…
277	Example: become a distributed node using the local node name as profile.	313	Example: become a distributed node using the local node name as profile.
278	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.
279		315
280	configure	316	configure
281		317
282	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
283	clients.	319	commandline clients.
284		320
285	configure nodeid => "anon/";	321	configure nodeid => "myscript/%n/%u";
286		322
287	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
288	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,
289	customary for aemp).	325	customary for aemp).
290		326
291	# use the aemp commandline utility	327	# use the aemp commandline utility
292	# aemp profile seed nodeid anon/ binds '*:4040'	328	# aemp profile seed binds '*:4040'
293		329
294	# then use it	330	# then use it
295	configure profile => "seed";	331	configure profile => "seed";
296		332
297	# or simply use aemp from the shell again:	333	# or simply use aemp from the shell again:
…		…
362		398
363	=cut	399	=cut
364		400
365	sub rcv($@);	401	sub rcv($@);
366		402
367	sub _kilme {	403	my $KILME = sub {
368	die "received message on port without callback";	404	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
369	}	405	kil $SELF, unhandled_message => "no callback set for message (first element $tag)";
		406	};
370		407
371	sub port(;&) {	408	sub port(;&) {
372	my $id = "$UNIQ." . $ID++;	409	my $id = $UNIQ . ++$ID;
373	my $port = "$NODE#$id";	410	my $port = "$NODE#$id";
374		411
375	rcv $port, shift \|\| \&_kilme;	412	rcv $port, shift \|\| $KILME;
376		413
377	$port	414	$port
378	}	415	}
379		416
380	=item rcv $local_port, $callback->(@msg)	417	=item rcv $local_port, $callback->(@msg)
…		…
385		422
386	The global C<$SELF> (exported by this module) contains C<$port> while	423	The global C<$SELF> (exported by this module) contains C<$port> while
387	executing the callback. Runtime errors during callback execution will	424	executing the callback. Runtime errors during callback execution will
388	result in the port being C<kil>ed.	425	result in the port being C<kil>ed.
389		426
390	The default callback received all messages not matched by a more specific	427	The default callback receives all messages not matched by a more specific
391	C<tag> match.	428	C<tag> match.
392		429
393	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	430	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
394		431
395	Register (or replace) callbacks to be called on messages starting with the	432	Register (or replace) callbacks to be called on messages starting with the
…		…
650	}	687	}
651		688
652	$node->monitor ($port, $cb);	689	$node->monitor ($port, $cb);
653		690
654	defined wantarray	691	defined wantarray
655	and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })	692	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
656	}	693	}
657		694
658	=item $guard = mon_guard $port, $ref, $ref...	695	=item $guard = mon_guard $port, $ref, $ref...
659		696
660	Monitors the given C<$port> and keeps the passed references. When the port	697	Monitors the given C<$port> and keeps the passed references. When the port
…		…
696	will be reported as reason C<< die => $@ >>.	733	will be reported as reason C<< die => $@ >>.
697		734
698	Transport/communication errors are reported as C<< transport_error =>	735	Transport/communication errors are reported as C<< transport_error =>
699	$message >>.	736	$message >>.
700		737
701	=cut	738	Common idioms:
		739
		740	# silently remove yourself, do not kill linked ports
		741	kil $SELF;
		742
		743	# report a failure in some detail
		744	kil $SELF, failure_mode_1 => "it failed with too high temperature";
		745
		746	# do not waste much time with killing, just die when something goes wrong
		747	open my $fh, "<file"
		748	or die "file: $!";
702		749
703	=item $port = spawn $node, $initfunc[, @initdata]	750	=item $port = spawn $node, $initfunc[, @initdata]
704		751
705	Creates a port on the node C<$node> (which can also be a port ID, in which	752	Creates a port on the node C<$node> (which can also be a port ID, in which
706	case it's the node where that port resides).	753	case it's the node where that port resides).
…		…
764	}	811	}
765		812
766	sub spawn(@) {	813	sub spawn(@) {
767	my ($nodeid, undef) = split /#/, shift, 2;	814	my ($nodeid, undef) = split /#/, shift, 2;
768		815
769	my $id = "$RUNIQ." . $ID++;	816	my $id = $RUNIQ . ++$ID;
770		817
771	$_[0] =~ /::/	818	$_[0] =~ /::/
772	or Carp::croak "spawn init function must be a fully-qualified name, caught";	819	or Carp::croak "spawn init function must be a fully-qualified name, caught";
773		820
774	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;	821	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
775		822
776	"$nodeid#$id"	823	"$nodeid#$id"
777	}	824	}
		825
778		826
779	=item after $timeout, @msg	827	=item after $timeout, @msg
780		828
781	=item after $timeout, $callback	829	=item after $timeout, $callback
782		830
…		…
797	ref $action[0]	845	ref $action[0]
798	? $action[0]()	846	? $action[0]()
799	: snd @action;	847	: snd @action;
800	};	848	};
801	}	849	}
		850
		851	#=item $cb2 = timeout $seconds, $cb[, @args]
802		852
803	=item cal $port, @msg, $callback[, $timeout]	853	=item cal $port, @msg, $callback[, $timeout]
804		854
805	A simple form of RPC - sends a message to the given C<$port> with the	855	A simple form of RPC - sends a message to the given C<$port> with the
806	given contents (C<@msg>), but adds a reply port to the message.	856	given contents (C<@msg>), but adds a reply port to the message.
…		…
852	$port	902	$port
853	}	903	}
854		904
855	=back	905	=back
856		906
		907	=head1 DISTRIBUTED DATABASE
		908
		909	AnyEvent::MP comes with a simple distributed database. The database will
		910	be mirrored asynchronously on all global nodes. Other nodes bind to one
		911	of the global nodes for their needs. Every node has a "local database"
		912	which contains all the values that are set locally. All local databases
		913	are merged together to form the global database, which can be queried.
		914
		915	The database structure is that of a two-level hash - the database hash
		916	contains hashes which contain values, similarly to a perl hash of hashes,
		917	i.e.:
		918
		919	$DATABASE{$family}{$subkey} = $value
		920
		921	The top level hash key is called "family", and the second-level hash key
		922	is called "subkey" or simply "key".
		923
		924	The family must be alphanumeric, i.e. start with a letter and consist
		925	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		926	pretty much like Perl module names.
		927
		928	As the family namespace is global, it is recommended to prefix family names
		929	with the name of the application or module using it.
		930
		931	The subkeys must be non-empty strings, with no further restrictions.
		932
		933	The values should preferably be strings, but other perl scalars should
		934	work as well (such as C<undef>, arrays and hashes).
		935
		936	Every database entry is owned by one node - adding the same family/subkey
		937	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		938	but the result might be nondeterministic, i.e. the key might have
		939	different values on different nodes.
		940
		941	Different subkeys in the same family can be owned by different nodes
		942	without problems, and in fact, this is the common method to create worker
		943	pools. For example, a worker port for image scaling might do this:
		944
		945	db_set my_image_scalers => $port;
		946
		947	And clients looking for an image scaler will want to get the
		948	C<my_image_scalers> keys from time to time:
		949
		950	db_keys my_image_scalers => sub {
		951	@ports = @{ $_[0] };
		952	};
		953
		954	Or better yet, they want to monitor the database family, so they always
		955	have a reasonable up-to-date copy:
		956
		957	db_mon my_image_scalers => sub {
		958	@ports = keys %{ $_[0] };
		959	};
		960
		961	In general, you can set or delete single subkeys, but query and monitor
		962	whole families only.
		963
		964	If you feel the need to monitor or query a single subkey, try giving it
		965	it's own family.
		966
		967	=over
		968
		969	=item db_set $family => $subkey [=> $value]
		970
		971	Sets (or replaces) a key to the database - if C<$value> is omitted,
		972	C<undef> is used instead.
		973
		974	=item db_del $family => $subkey...
		975
		976	Deletes one or more subkeys from the database family.
		977
		978	=item $guard = db_reg $family => $subkey [=> $value]
		979
		980	Sets the key on the database and returns a guard. When the guard is
		981	destroyed, the key is deleted from the database. If C<$value> is missing,
		982	then C<undef> is used.
		983
		984	=item db_family $family => $cb->(\%familyhash)
		985
		986	Queries the named database C<$family> and call the callback with the
		987	family represented as a hash. You can keep and freely modify the hash.
		988
		989	=item db_keys $family => $cb->(\@keys)
		990
		991	Same as C<db_family>, except it only queries the family I<subkeys> and passes
		992	them as array reference to the callback.
		993
		994	=item db_values $family => $cb->(\@values)
		995
		996	Same as C<db_family>, except it only queries the family I<values> and passes them
		997	as array reference to the callback.
		998
		999	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
		1000
		1001	Creates a monitor on the given database family. Each time a key is set
		1002	or or is deleted the callback is called with a hash containing the
		1003	database family and three lists of added, changed and deleted subkeys,
		1004	respectively. If no keys have changed then the array reference might be
		1005	C<undef> or even missing.
		1006
		1007	If not called in void context, a guard object is returned that, when
		1008	destroyed, stops the monitor.
		1009
		1010	The family hash reference and the key arrays belong to AnyEvent::MP and
		1011	B<must not be modified or stored> by the callback. When in doubt, make a
		1012	copy.
		1013
		1014	As soon as possible after the monitoring starts, the callback will be
		1015	called with the intiial contents of the family, even if it is empty,
		1016	i.e. there will always be a timely call to the callback with the current
		1017	contents.
		1018
		1019	It is possible that the callback is called with a change event even though
		1020	the subkey is already present and the value has not changed.
		1021
		1022	The monitoring stops when the guard object is destroyed.
		1023
		1024	Example: on every change to the family "mygroup", print out all keys.
		1025
		1026	my $guard = db_mon mygroup => sub {
		1027	my ($family, $a, $c, $d) = @_;
		1028	print "mygroup members: ", (join " ", keys %$family), "\n";
		1029	};
		1030
		1031	Exmaple: wait until the family "My::Module::workers" is non-empty.
		1032
		1033	my $guard; $guard = db_mon My::Module::workers => sub {
		1034	my ($family, $a, $c, $d) = @_;
		1035	return unless %$family;
		1036	undef $guard;
		1037	print "My::Module::workers now nonempty\n";
		1038	};
		1039
		1040	Example: print all changes to the family "AnyRvent::Fantasy::Module".
		1041
		1042	my $guard = db_mon AnyRvent::Fantasy::Module => sub {
		1043	my ($family, $a, $c, $d) = @_;
		1044
		1045	print "+$_=$family->{$_}\n" for @$a;
		1046	print "*$_=$family->{$_}\n" for @$c;
		1047	print "-$_=$family->{$_}\n" for @$d;
		1048	};
		1049
		1050	=cut
		1051
		1052	=back
		1053
857	=head1 AnyEvent::MP vs. Distributed Erlang	1054	=head1 AnyEvent::MP vs. Distributed Erlang
858		1055
859	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	1056	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
860	== aemp node, Erlang process == aemp port), so many of the documents and	1057	== aemp node, Erlang process == aemp port), so many of the documents and
861	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	1058	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.119 by root, Sun Feb 26 10:29:59 2012 UTC vs. Revision 1.133 by root, Mon Mar 12 10:34:06 2012 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.119 by root, Sun Feb 26 10:29:59 2012 UTC vs.
Revision 1.133 by root, Mon Mar 12 10:34:06 2012 UTC