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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.134 by root, Mon Mar 12 14:47:23 2012 UTC vs.
Revision 1.145 by root, Tue Oct 2 13:58:07 2012 UTC

…		…
47	# execute callbacks in $SELF port context	47	# execute callbacks in $SELF port context
48	my $timer = AE::timer 1, 0, psub {	48	my $timer = AE::timer 1, 0, psub {
49	die "kill the port, delayed";	49	die "kill the port, delayed";
50	};	50	};
51		51
52	=head1 CURRENT STATUS	52	# distributed database - modification
		53	db_set $family => $subkey [=> $value] # add a subkey
		54	db_del $family => $subkey... # delete one or more subkeys
		55	db_reg $family => $port [=> $value] # register a port
53		56
54	bin/aemp - stable.	57	# distributed database - queries
55	AnyEvent::MP - stable API, should work.	58	db_family $family => $cb->(\%familyhash)
56	AnyEvent::MP::Intro - explains most concepts.	59	db_keys $family => $cb->(\@keys)
57	AnyEvent::MP::Kernel - mostly stable API.	60	db_values $family => $cb->(\@values)
58	AnyEvent::MP::Global - stable API.	61
		62	# distributed database - monitoring a family
		63	db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
59		64
60	=head1 DESCRIPTION	65	=head1 DESCRIPTION
61		66
62	This module (-family) implements a simple message passing framework.	67	This module (-family) implements a simple message passing framework.
63		68
…		…
178		183
179	package AnyEvent::MP;	184	package AnyEvent::MP;
180		185
181	use AnyEvent::MP::Config ();	186	use AnyEvent::MP::Config ();
182	use AnyEvent::MP::Kernel;	187	use AnyEvent::MP::Kernel;
183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);	188	use AnyEvent::MP::Kernel qw(
		189	%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID
		190	add_node load_func
		191
		192	NODE $NODE
		193	configure
		194	node_of port_is_local
		195	snd kil
		196	db_set db_del
		197	db_mon db_family db_keys db_values
		198	);
184		199
185	use common::sense;	200	use common::sense;
186		201
187	use Carp ();	202	use Carp ();
188		203
189	use AE ();	204	use AnyEvent ();
190	use Guard ();	205	use Guard ();
191		206
192	use base "Exporter";	207	use base "Exporter";
193		208
194	our $VERSION = $AnyEvent::MP::Config::VERSION;	209	our $VERSION = $AnyEvent::MP::Config::VERSION;
195		210
196	our @EXPORT = qw(	211	our @EXPORT = qw(
197	NODE $NODE *SELF node_of after	212	NODE $NODE
198	configure	213	configure
		214	node_of port_is_local
		215	snd kil
		216	db_set db_del
		217	db_mon db_family db_keys db_values
		218
		219	*SELF
		220
199	snd rcv mon mon_guard kil psub peval spawn cal	221	port rcv mon mon_guard psub peval spawn cal
200	port
201	db_set db_del db_reg	222	db_set db_del db_reg
202	db_mon db_family db_keys db_values	223	db_mon db_family db_keys db_values
		224
		225	after
203	);	226	);
204		227
205	our $SELF;	228	our $SELF;
206		229
207	sub _self_die() {	230	sub _self_die() {
…		…
218		241
219	=item $nodeid = node_of $port	242	=item $nodeid = node_of $port
220		243
221	Extracts and returns the node ID from a port ID or a node ID.	244	Extracts and returns the node ID from a port ID or a node ID.
222		245
		246	=item $is_local = port_is_local $port
		247
		248	Returns true iff the port is a local port.
		249
223	=item configure $profile, key => value...	250	=item configure $profile, key => value...
224		251
225	=item configure key => value...	252	=item configure key => value...
226		253
227	Before a node can talk to other nodes on the network (i.e. enter	254	Before a node can talk to other nodes on the network (i.e. enter
…		…
238	=over 4	265	=over 4
239		266
240	=item norc => $boolean (default false)	267	=item norc => $boolean (default false)
241		268
242	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>	269	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	270	be consulted - all configuration options must be specified in the
244	C<configure> call.	271	C<configure> call.
245		272
246	=item force => $boolean (default false)	273	=item force => $boolean (default false)
247		274
248	IF true, then the values specified in the C<configure> will take	275	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	276	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.	277	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		278
260	=back	279	=back
261		280
262	=over 4	281	=over 4
263		282
…		…
400		419
401	sub rcv($@);	420	sub rcv($@);
402		421
403	my $KILME = sub {	422	my $KILME = sub {
404	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;	423	(my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
405	kil $SELF, unhandled_message => "missing (tag or fallback) callback for message '$tag'";	424	kil $SELF, unhandled_message => "no callback found for message '$tag'";
406	};	425	};
407		426
408	sub port(;&) {	427	sub port(;&) {
409	my $id = $UNIQ . ++$ID;	428	my $id = $UNIQ . ++$ID;
410	my $port = "$NODE#$id";	429	my $port = "$NODE#$id";
…		…
467		486
468	sub rcv($@) {	487	sub rcv($@) {
469	my $port = shift;	488	my $port = shift;
470	my ($nodeid, $portid) = split /#/, $port, 2;	489	my ($nodeid, $portid) = split /#/, $port, 2;
471		490
472	$NODE{$nodeid} == $NODE{""}	491	$nodeid eq $NODE
473	or Carp::croak "$port: rcv can only be called on local ports, caught";	492	or Carp::croak "$port: rcv can only be called on local ports, caught";
474		493
475	while (@_) {	494	while (@_) {
476	if (ref $_[0]) {	495	if (ref $_[0]) {
477	if (my $self = $PORT_DATA{$portid}) {	496	if (my $self = $PORT_DATA{$portid}) {
…		…
521	}	540	}
522		541
523	=item peval $port, $coderef[, @args]	542	=item peval $port, $coderef[, @args]
524		543
525	Evaluates the given C<$codref> within the contetx of C<$port>, that is,	544	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
526	when the code throews an exception the C<$port> will be killed.	545	when the code throws an exception the C<$port> will be killed.
527		546
528	Any remaining args will be passed to the callback. Any return values will	547	Any remaining args will be passed to the callback. Any return values will
529	be returned to the caller.	548	be returned to the caller.
530		549
531	This is useful when you temporarily want to execute code in the context of	550	This is useful when you temporarily want to execute code in the context of
…		…
596	$res	615	$res
597	}	616	}
598	}	617	}
599	}	618	}
600		619
		620	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
		621
		622	=item $guard = mon $port # kill $SELF when $port dies
		623
601	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies	624	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
602
603	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
604
605	=item $guard = mon $port # kill $SELF when $port dies
606		625
607	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies	626	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
608		627
609	Monitor the given port and do something when the port is killed or	628	Monitor the given port and do something when the port is killed or
610	messages to it were lost, and optionally return a guard that can be used	629	messages to it were lost, and optionally return a guard that can be used
611	to stop monitoring again.	630	to stop monitoring again.
612		631
		632	The first two forms distinguish between "normal" and "abnormal" kil's:
		633
		634	In the first form (another port given), if the C<$port> is C<kil>'ed with
		635	a non-empty reason, the other port (C<$rcvport>) will be kil'ed with the
		636	same reason. That is, on "normal" kil's nothing happens, while under all
		637	other conditions, the other port is killed with the same reason.
		638
		639	The second form (kill self) is the same as the first form, except that
		640	C<$rvport> defaults to C<$SELF>.
		641
		642	The remaining forms don't distinguish between "normal" and "abnormal" kil's
		643	- it's up to the callback or receiver to check whether the C<@reason> is
		644	empty and act accordingly.
		645
613	In the first form (callback), the callback is simply called with any	646	In the third form (callback), the callback is simply called with any
614	number of C<@reason> elements (no @reason means that the port was deleted	647	number of C<@reason> elements (empty @reason means that the port was deleted
615	"normally"). Note also that I<< the callback B<must> never die >>, so use	648	"normally"). Note also that I<< the callback B<must> never die >>, so use
616	C<eval> if unsure.	649	C<eval> if unsure.
617		650
618	In the second form (another port given), the other port (C<$rcvport>)
619	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
620	"normal" kils nothing happens, while under all other conditions, the other
621	port is killed with the same reason.
622
623	The third form (kill self) is the same as the second form, except that
624	C<$rvport> defaults to C<$SELF>.
625
626	In the last form (message), a message of the form C<@msg, @reason> will be	651	In the last form (message), a message of the form C<$rcvport, @msg,
627	C<snd>.	652	@reason> will be C<snd>.
628		653
629	Monitoring-actions are one-shot: once messages are lost (and a monitoring	654	Monitoring-actions are one-shot: once messages are lost (and a monitoring
630	alert was raised), they are removed and will not trigger again.	655	alert was raised), they are removed and will not trigger again, even if it
		656	turns out that the port is still alive.
631		657
632	As a rule of thumb, monitoring requests should always monitor a port from	658	As a rule of thumb, monitoring requests should always monitor a remote
633	a local port (or callback). The reason is that kill messages might get	659	port locally (using a local C<$rcvport> or a callback). The reason is that
634	lost, just like any other message. Another less obvious reason is that	660	kill messages might get lost, just like any other message. Another less
635	even monitoring requests can get lost (for example, when the connection	661	obvious reason is that even monitoring requests can get lost (for example,
636	to the other node goes down permanently). When monitoring a port locally	662	when the connection to the other node goes down permanently). When
637	these problems do not exist.	663	monitoring a port locally these problems do not exist.
638		664
639	C<mon> effectively guarantees that, in the absence of hardware failures,	665	C<mon> effectively guarantees that, in the absence of hardware failures,
640	after starting the monitor, either all messages sent to the port will	666	after starting the monitor, either all messages sent to the port will
641	arrive, or the monitoring action will be invoked after possible message	667	arrive, or the monitoring action will be invoked after possible message
642	loss has been detected. No messages will be lost "in between" (after	668	loss has been detected. No messages will be lost "in between" (after
…		…
964	If you feel the need to monitor or query a single subkey, try giving it	990	If you feel the need to monitor or query a single subkey, try giving it
965	it's own family.	991	it's own family.
966		992
967	=over	993	=over
968		994
969	=item db_set $family => $subkey [=> $value]	995	=item $guard = db_set $family => $subkey [=> $value]
970		996
971	Sets (or replaces) a key to the database - if C<$value> is omitted,	997	Sets (or replaces) a key to the database - if C<$value> is omitted,
972	C<undef> is used instead.	998	C<undef> is used instead.
973		999
		1000	When called in non-void context, C<db_set> returns a guard that
		1001	automatically calls C<db_del> when it is destroyed.
		1002
974	=item db_del $family => $subkey...	1003	=item db_del $family => $subkey...
975		1004
976	Deletes one or more subkeys from the database family.	1005	Deletes one or more subkeys from the database family.
977		1006
978	=item $guard = db_reg $family => $subkey [=> $value]	1007	=item $guard = db_reg $family => $port => $value
979		1008
980	Sets the key on the database and returns a guard. When the guard is	1009	=item $guard = db_reg $family => $port
981	destroyed, the key is deleted from the database. If C<$value> is missing,	1010
982	then C<undef> is used.	1011	=item $guard = db_reg $family
		1012
		1013	Registers a port in the given family and optionally returns a guard to
		1014	remove it.
		1015
		1016	This function basically does the same as:
		1017
		1018	db_set $family => $port => $value
		1019
		1020	Except that the port is monitored and automatically removed from the
		1021	database family when it is kil'ed.
		1022
		1023	If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
		1024	C<$SELF> is used.
		1025
		1026	This function is most useful to register a port in some port group (which
		1027	is just another name for a database family), and have it removed when the
		1028	port is gone. This works best when the port is a local port.
		1029
		1030	=cut
		1031
		1032	sub db_reg($$;$) {
		1033	my $family = shift;
		1034	my $port = @_ ? shift : $SELF;
		1035
		1036	my $clr = sub { db_del $family => $port };
		1037	mon $port, $clr;
		1038
		1039	db_set $family => $port => $_[0];
		1040
		1041	defined wantarray
		1042	and &Guard::guard ($clr)
		1043	}
983		1044
984	=item db_family $family => $cb->(\%familyhash)	1045	=item db_family $family => $cb->(\%familyhash)
985		1046
986	Queries the named database C<$family> and call the callback with the	1047	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.	1048	family represented as a hash. You can keep and freely modify the hash.
…		…
994	=item db_values $family => $cb->(\@values)	1055	=item db_values $family => $cb->(\@values)
995		1056
996	Same as C<db_family>, except it only queries the family I<values> and passes them	1057	Same as C<db_family>, except it only queries the family I<values> and passes them
997	as array reference to the callback.	1058	as array reference to the callback.
998		1059
999	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)	1060	=item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
1000		1061
1001	Creates a monitor on the given database family. Each time a key is set	1062	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	1063	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,	1064	database family and three lists of added, changed and deleted subkeys,
1004	respectively. If no keys have changed then the array reference might be	1065	respectively. If no keys have changed then the array reference might be
…		…
1212	Keeping your messages simple, concentrating on data structures rather than	1273	Keeping your messages simple, concentrating on data structures rather than
1213	objects, will keep your messages clean, tidy and efficient.	1274	objects, will keep your messages clean, tidy and efficient.
1214		1275
1215	=back	1276	=back
1216		1277
		1278	=head1 PORTING FROM AnyEvent::MP VERSION 1.X
		1279
		1280	AEMP version 2 has a few major incompatible changes compared to version 1:
		1281
		1282	=over 4
		1283
		1284	=item AnyEvent::MP::Global no longer has group management functions.
		1285
		1286	At least not officially - the grp_* functions are still exported and might
		1287	work, but they will be removed in some later release.
		1288
		1289	AnyEvent::MP now comes with a distributed database that is more
		1290	powerful. Its database families map closely to port groups, but the API
		1291	has changed (the functions are also now exported by AnyEvent::MP). Here is
		1292	a rough porting guide:
		1293
		1294	grp_reg $group, $port # old
		1295	db_reg $group, $port # new
		1296
		1297	$list = grp_get $group # old
		1298	db_keys $group, sub { my $list = shift } # new
		1299
		1300	grp_mon $group, $cb->(\@ports, $add, $del) # old
		1301	db_mon $group, $cb->(\%ports, $add, $change, $del) # new
		1302
		1303	C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> is
		1304	no longer instant, because the local node might not have a copy of the
		1305	group. You can either modify your code to allow for a callback, or use
		1306	C<db_mon> to keep an updated copy of the group:
		1307
		1308	my $local_group_copy;
		1309	db_mon $group => sub { $local_group_copy = $_[0] };
		1310
		1311	# now "keys %$local_group_copy" always returns the most up-to-date
		1312	# list of ports in the group.
		1313
		1314	C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon>
		1315	passes a hash as first argument, and an extra C<$chg> argument that can be
		1316	ignored:
		1317
		1318	db_mon $group => sub {
		1319	my ($ports, $add, $chg, $lde) = @_;
		1320	$ports = [keys %$ports];
		1321
		1322	# now $ports, $add and $del are the same as
		1323	# were originally passed by grp_mon.
		1324	...
		1325	};
		1326
		1327	=item Nodes not longer connect to all other nodes.
		1328
		1329	In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
		1330	module, which in turn would create connections to all other nodes in the
		1331	network (helped by the seed nodes).
		1332
		1333	In version 2.x, global nodes still connect to all other global nodes, but
		1334	other nodes don't - now every node either is a global node itself, or
		1335	attaches itself to another global node.
		1336
		1337	If a node isn't a global node itself, then it attaches itself to one
		1338	of its seed nodes. If that seed node isn't a global node yet, it will
		1339	automatically be upgraded to a global node.
		1340
		1341	So in many cases, nothing needs to be changed - one just has to make sure
		1342	that all seed nodes are meshed together with the other seed nodes (as with
		1343	AEMP 1.x), and other nodes specify them as seed nodes. This is most easily
		1344	achieved by specifying the same set of seed nodes for all nodes in the
		1345	network.
		1346
		1347	Not opening a connection to every other node is usually an advantage,
		1348	except when you need the lower latency of an already established
		1349	connection. To ensure a node establishes a connection to another node,
		1350	you can monitor the node port (C<mon $node, ...>), which will attempt to
		1351	create the connection (and notify you when the connection fails).
		1352
		1353	=item Listener-less nodes (nodes without binds) are gone.
		1354
		1355	And are not coming back, at least not in their old form. If no C<binds>
		1356	are specified for a node, AnyEvent::MP assumes a default of C<:>.
		1357
		1358	There are vague plans to implement some form of routing domains, which
		1359	might or might not bring back listener-less nodes, but don't count on it.
		1360
		1361	The fact that most connections are now optional somewhat mitigates this,
		1362	as a node can be effectively unreachable from the outside without any
		1363	problems, as long as it isn't a global node and only reaches out to other
		1364	nodes (as opposed to being contacted from other nodes).
		1365
		1366	=item $AnyEvent::MP::Kernel::WARN has gone.
		1367
		1368	AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
		1369	uses this, and so should your programs.
		1370
		1371	Every module now documents what kinds of messages it generates, with
		1372	AnyEvent::MP acting as a catch all.
		1373
		1374	On the positive side, this means that instead of setting
		1375	C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE> -
		1376	much less to type.
		1377
		1378	=back
		1379
		1380	=head1 LOGGING
		1381
		1382	AnyEvent::MP does not normally log anything by itself, but sinc eit is the
		1383	root of the contetx hierarchy for AnyEvent::MP modules, it will receive
		1384	all log messages by submodules.
		1385
1217	=head1 SEE ALSO	1386	=head1 SEE ALSO
1218		1387
1219	L<AnyEvent::MP::Intro> - a gentle introduction.	1388	L<AnyEvent::MP::Intro> - a gentle introduction.
1220		1389
1221	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1390	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.134 by root, Mon Mar 12 14:47:23 2012 UTC vs. Revision 1.145 by root, Tue Oct 2 13:58:07 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.134 by root, Mon Mar 12 14:47:23 2012 UTC vs.
Revision 1.145 by root, Tue Oct 2 13:58:07 2012 UTC