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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.137 by root, Wed Mar 21 23:48:39 2012 UTC vs.
Revision 1.144 by root, Fri Mar 23 21:16:25 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
…		…
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->(@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		278
265	=back	279	=back
266		280
267	=over 4	281	=over 4
268		282
…		…
472		486
473	sub rcv($@) {	487	sub rcv($@) {
474	my $port = shift;	488	my $port = shift;
475	my ($nodeid, $portid) = split /#/, $port, 2;	489	my ($nodeid, $portid) = split /#/, $port, 2;
476		490
477	$NODE{$nodeid} == $NODE{""}	491	$nodeid eq $NODE
478	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";
479		493
480	while (@_) {	494	while (@_) {
481	if (ref $_[0]) {	495	if (ref $_[0]) {
482	if (my $self = $PORT_DATA{$portid}) {	496	if (my $self = $PORT_DATA{$portid}) {
…		…
601	$res	615	$res
602	}	616	}
603	}	617	}
604	}	618	}
605		619
		620	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
		621
		622	=item $guard = mon $port # kill $SELF when $port dies
		623
606	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies	624	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
607
608	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
609
610	=item $guard = mon $port # kill $SELF when $port dies
611		625
612	=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
613		627
614	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
615	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
616	to stop monitoring again.	630	to stop monitoring again.
617		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
618	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
619	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
620	"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
621	C<eval> if unsure.	649	C<eval> if unsure.
622		650
623	In the second form (another port given), the other port (C<$rcvport>)
624	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
625	"normal" kils nothing happens, while under all other conditions, the other
626	port is killed with the same reason.
627
628	The third form (kill self) is the same as the second form, except that
629	C<$rvport> defaults to C<$SELF>.
630
631	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,
632	C<snd>.	652	@reason> will be C<snd>.
633		653
634	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
635	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.
636		657
637	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
638	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
639	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
640	even monitoring requests can get lost (for example, when the connection	661	obvious reason is that even monitoring requests can get lost (for example,
641	to the other node goes down permanently). When monitoring a port locally	662	when the connection to the other node goes down permanently). When
642	these problems do not exist.	663	monitoring a port locally these problems do not exist.
643		664
644	C<mon> effectively guarantees that, in the absence of hardware failures,	665	C<mon> effectively guarantees that, in the absence of hardware failures,
645	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
646	arrive, or the monitoring action will be invoked after possible message	667	arrive, or the monitoring action will be invoked after possible message
647	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
…		…
1034	=item db_values $family => $cb->(\@values)	1055	=item db_values $family => $cb->(\@values)
1035		1056
1036	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
1037	as array reference to the callback.	1058	as array reference to the callback.
1038		1059
1039	=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)	1060	=item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
1040		1061
1041	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
1042	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
1043	database family and three lists of added, changed and deleted subkeys,	1064	database family and three lists of added, changed and deleted subkeys,
1044	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
…		…
1254		1275
1255	=back	1276	=back
1256		1277
1257	=head1 PORTING FROM AnyEvent::MP VERSION 1.X	1278	=head1 PORTING FROM AnyEvent::MP VERSION 1.X
1258		1279
1259	AEMP version 2 has three major incompatible changes compared to version 1:	1280	AEMP version 2 has a few major incompatible changes compared to version 1:
1260		1281
1261	=over 4	1282	=over 4
1262		1283
1263	=item AnyEvent::MP::Global no longer has group management functions.	1284	=item AnyEvent::MP::Global no longer has group management functions.
1264		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
1265	AnyEvent::MP now comes with a distributed database that is more	1289	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	1290	powerful. Its database families map closely to port groups, but the API
1267	minor differences:	1291	has changed (the functions are also now exported by AnyEvent::MP). Here is
		1292	a rough porting guide:
1268		1293
1269	grp_reg $group, $port # old	1294	grp_reg $group, $port # old
1270	db_reg $group, $port # new	1295	db_reg $group, $port # new
1271		1296
1272	$list = grp_get $group # old	1297	$list = grp_get $group # old
1273	db_keys $group, sub { my $list = shift } # new	1298	db_keys $group, sub { my $list = shift } # new
1274		1299
1275	grp_mon $group, $cb->(\@ports, $add, $del) # old	1300	grp_mon $group, $cb->(\@ports, $add, $del) # old
1276	db_mon $group, $cb->(\%ports, $add, $change, $del) # new	1301	db_mon $group, $cb->(\%ports, $add, $change, $del) # new
1277		1302
1278	C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get>	1303	C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> is
1279	is no longer instant, because the local node might not have a copy of	1304	no longer instant, because the local node might not have a copy of the
1280	the group. This can be partially remedied by using C<db_mon> to keep an	1305	group. You can either modify your code to allow for a callback, or use
1281	updated copy of the group:	1306	C<db_mon> to keep an updated copy of the group:
1282		1307
1283	my $local_group_copy;	1308	my $local_group_copy;
1284	db_mon $group => sub { $local_group_copy = shift };	1309	db_mon $group => sub { $local_group_copy = $_[0] };
1285		1310
1286	# no keys %$local_group_copy always returns the most up-to-date	1311	# now "keys %$local_group_copy" always returns the most up-to-date
1287	# list of ports in the group.	1312	# list of ports in the group.
1288		1313
1289	C<grp_mon> can almost be replaced by C<db_mon>:	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:
1290		1317
1291	db_mon $group => sub {	1318	db_mon $group => sub {
1292	my ($ports, $add, $chg, $lde) = @_;	1319	my ($ports, $add, $chg, $lde) = @_;
1293	$ports = [keys %$ports];	1320	$ports = [keys %$ports];
1294		1321
…		…
1311	of its seed nodes. If that seed node isn't a global node yet, it will	1338	of its seed nodes. If that seed node isn't a global node yet, it will
1312	automatically be upgraded to a global node.	1339	automatically be upgraded to a global node.
1313		1340
1314	So in many cases, nothing needs to be changed - one just has to make sure	1341	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	1342	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.	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.
1317		1346
1318	Not opening a connection to every other node is usually an advantage,	1347	Not opening a connection to every other node is usually an advantage,
1319	except when you need the lower latency of an already established	1348	except when you need the lower latency of an already established
1320	connection. To ensure a node establishes a connection to another node,	1349	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	1350	you can monitor the node port (C<mon $node, ...>), which will attempt to
1322	create the connection (And notify you when the connection fails).	1351	create the connection (and notify you when the connection fails).
1323		1352
1324	=item Listener-less nodes are gone.	1353	=item Listener-less nodes (nodes without binds) are gone.
1325		1354
1326	And are not coming back, at least not in their old form.	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<:>.
1327		1357
1328	There are vague plans to implement some form of routing domains, which	1358	There are vague plans to implement some form of routing domains, which
1329	might or might not bring back listener-less nodes, but don't count on it.	1359	might or might not bring back listener-less nodes, but don't count on it.
1330		1360
1331	The fact that most connections are now optional somewhat mitigates this,	1361	The fact that most connections are now optional somewhat mitigates this,
1332	as a node can be effectively unreachable from the outside without any	1362	as a node can be effectively unreachable from the outside without any
1333	problems, as long as it isn't a global node and only reaches out to other	1363	problems, as long as it isn't a global node and only reaches out to other
1334	nodes (as opposed to being contacted from other nodes).	1364	nodes (as opposed to being contacted from other nodes).
1335		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
1336	=back	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.
1337		1385
1338	=head1 SEE ALSO	1386	=head1 SEE ALSO
1339		1387
1340	L<AnyEvent::MP::Intro> - a gentle introduction.	1388	L<AnyEvent::MP::Intro> - a gentle introduction.
1341		1389

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.137 by root, Wed Mar 21 23:48:39 2012 UTC vs. Revision 1.144 by root, Fri Mar 23 21:16:25 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.137 by root, Wed Mar 21 23:48:39 2012 UTC vs.
Revision 1.144 by root, Fri Mar 23 21:16:25 2012 UTC