ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-MP/MP.pm
(Generate patch)

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.134 by root, Mon Mar 12 14:47:23 2012 UTC vs.
Revision 1.138 by root, Thu Mar 22 00:48:29 2012 UTC

247 247
248IF true, then the values specified in the C<configure> will take 248IF true, then the values specified in the C<configure> will take
249precedence over any values configured via the rc file. The default is for 249precedence over any values configured via the rc file. The default is for
250the rc file to override any options specified in the program. 250the rc file to override any options specified in the program.
251 251
252=item secure => $pass->($nodeid) 252=item secure => $pass->(@msg)
253 253
254In addition to specifying a boolean, you can specify a code reference that 254In addition to specifying a boolean, you can specify a code reference that
255is called for every remote execution attempt - the execution request is 255is called for every code execution attempt - the execution request is
256granted iff the callback returns a true value. 256granted iff the callback returns a true value.
257
258Most of the time the callback should look only at
259C<$AnyEvent::MP::Kernel::SRCNODE> to make a decision, and not at the
260actual message (which can be about anything, and is mostly provided for
261diagnostic purposes).
257 262
258See F<semp setsecure> for more info. 263See F<semp setsecure> for more info.
259 264
260=back 265=back
261 266
400 405
401sub rcv($@); 406sub rcv($@);
402 407
403my $KILME = sub { 408my $KILME = sub {
404 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g; 409 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
405 kil $SELF, unhandled_message => "missing (tag or fallback) callback for message '$tag'"; 410 kil $SELF, unhandled_message => "no callback found for message '$tag'";
406}; 411};
407 412
408sub port(;&) { 413sub port(;&) {
409 my $id = $UNIQ . ++$ID; 414 my $id = $UNIQ . ++$ID;
410 my $port = "$NODE#$id"; 415 my $port = "$NODE#$id";
964If you feel the need to monitor or query a single subkey, try giving it 969If you feel the need to monitor or query a single subkey, try giving it
965it's own family. 970it's own family.
966 971
967=over 972=over
968 973
969=item db_set $family => $subkey [=> $value] 974=item $guard = db_set $family => $subkey [=> $value]
970 975
971Sets (or replaces) a key to the database - if C<$value> is omitted, 976Sets (or replaces) a key to the database - if C<$value> is omitted,
972C<undef> is used instead. 977C<undef> is used instead.
973 978
979When called in non-void context, C<db_set> returns a guard that
980automatically calls C<db_del> when it is destroyed.
981
974=item db_del $family => $subkey... 982=item db_del $family => $subkey...
975 983
976Deletes one or more subkeys from the database family. 984Deletes one or more subkeys from the database family.
977 985
978=item $guard = db_reg $family => $subkey [=> $value] 986=item $guard = db_reg $family => $port => $value
979 987
980Sets the key on the database and returns a guard. When the guard is 988=item $guard = db_reg $family => $port
981destroyed, the key is deleted from the database. If C<$value> is missing, 989
982then C<undef> is used. 990=item $guard = db_reg $family
991
992Registers a port in the given family and optionally returns a guard to
993remove it.
994
995This function basically does the same as:
996
997 db_set $family => $port => $value
998
999Except that the port is monitored and automatically removed from the
1000database family when it is kil'ed.
1001
1002If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
1003C<$SELF> is used.
1004
1005This function is most useful to register a port in some port group (which
1006is just another name for a database family), and have it removed when the
1007port is gone. This works best when the port is a local port.
1008
1009=cut
1010
1011sub db_reg($$;$) {
1012 my $family = shift;
1013 my $port = @_ ? shift : $SELF;
1014
1015 my $clr = sub { db_del $family => $port };
1016 mon $port, $clr;
1017
1018 db_set $family => $port => $_[0];
1019
1020 defined wantarray
1021 and &Guard::guard ($clr)
1022}
983 1023
984=item db_family $family => $cb->(\%familyhash) 1024=item db_family $family => $cb->(\%familyhash)
985 1025
986Queries the named database C<$family> and call the callback with the 1026Queries the named database C<$family> and call the callback with the
987family represented as a hash. You can keep and freely modify the hash. 1027family represented as a hash. You can keep and freely modify the hash.
1212Keeping your messages simple, concentrating on data structures rather than 1252Keeping your messages simple, concentrating on data structures rather than
1213objects, will keep your messages clean, tidy and efficient. 1253objects, will keep your messages clean, tidy and efficient.
1214 1254
1215=back 1255=back
1216 1256
1257=head1 PORTING FROM AnyEvent::MP VERSION 1.X
1258
1259AEMP version 2 has three major incompatible changes compared to version 1:
1260
1261=over 4
1262
1263=item AnyEvent::MP::Global no longer has group management functions.
1264
1265AnyEvent::MP now comes with a distributed database that is more
1266powerful. It's database families map closely to ports, but the API has
1267minor differences:
1268
1269 grp_reg $group, $port # old
1270 db_reg $group, $port # new
1271
1272 $list = grp_get $group # old
1273 db_keys $group, sub { my $list = shift } # new
1274
1275 grp_mon $group, $cb->(\@ports, $add, $del) # old
1276 db_mon $group, $cb->(\%ports, $add, $change, $del) # new
1277
1278C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get>
1279is no longer instant, because the local node might not have a copy of
1280the group. This can be partially remedied by using C<db_mon> to keep an
1281updated copy of the group:
1282
1283 my $local_group_copy;
1284 db_mon $group => sub { $local_group_copy = shift };
1285
1286 # no keys %$local_group_copy always returns the most up-to-date
1287 # list of ports in the group.
1288
1289C<grp_mon> can almost be replaced by C<db_mon>:
1290
1291 db_mon $group => sub {
1292 my ($ports, $add, $chg, $lde) = @_;
1293 $ports = [keys %$ports];
1294
1295 # now $ports, $add and $del are the same as
1296 # were originally passed by grp_mon.
1297 ...
1298 };
1299
1300=item Nodes not longer connect to all other nodes.
1301
1302In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
1303module, which in turn would create connections to all other nodes in the
1304network (helped by the seed nodes).
1305
1306In version 2.x, global nodes still connect to all other global nodes, but
1307other nodes don't - now every node either is a global node itself, or
1308attaches itself to another global node.
1309
1310If a node isn't a global node itself, then it attaches itself to one
1311of its seed nodes. If that seed node isn't a global node yet, it will
1312automatically be upgraded to a global node.
1313
1314So in many cases, nothing needs to be changed - one just has to make sure
1315that all seed nodes are meshed together with the other seed nodes (as with
1316AEMP 1.x), and other nodes specify them as seed nodes.
1317
1318Not opening a connection to every other node is usually an advantage,
1319except when you need the lower latency of an already established
1320connection. To ensure a node establishes a connection to another node,
1321you can monitor the node port (C<mon $node, ...>), which will attempt to
1322create the connection (and notify you when the connection fails).
1323
1324=item Listener-less nodes (nodes without binds) are gone.
1325
1326And are not coming back, at least not in their old form. If no C<binds>
1327are specified for a node, AnyEvent::MP now assumes a default of C<*:*>.
1328
1329There are vague plans to implement some form of routing domains, which
1330might or might not bring back listener-less nodes, but don't count on it.
1331
1332The fact that most connections are now optional somewhat mitigates this,
1333as a node can be effectively unreachable from the outside without any
1334problems, as long as it isn't a global node and only reaches out to other
1335nodes (as opposed to being contacted from other nodes).
1336
1337=item $AnyEvent::MP::Kernel::WARN has gone.
1338
1339AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
1340uses this, and so should your programs.
1341
1342Every module now documents what kinds of messages it generates, with
1343AnyEvent::MP acting as a catch all.
1344
1345On the positive side, this means that instead of setting
1346C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE>,
1347much less to type.
1348
1349=back
1350
1217=head1 SEE ALSO 1351=head1 SEE ALSO
1218 1352
1219L<AnyEvent::MP::Intro> - a gentle introduction. 1353L<AnyEvent::MP::Intro> - a gentle introduction.
1220 1354
1221L<AnyEvent::MP::Kernel> - more, lower-level, stuff. 1355L<AnyEvent::MP::Kernel> - more, lower-level, stuff.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines