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.136 by root, Wed Mar 21 15:22:16 2012 UTC vs.
Revision 1.137 by root, Wed Mar 21 23:48:39 2012 UTC

969If 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
970it's own family. 970it's own family.
971 971
972=over 972=over
973 973
974=item db_set $family => $subkey [=> $value] 974=item $guard = db_set $family => $subkey [=> $value]
975 975
976Sets (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,
977C<undef> is used instead. 977C<undef> is used instead.
978 978
979When called in non-void context, C<db_set> returns a guard that
980automatically calls C<db_del> when it is destroyed.
981
979=item db_del $family => $subkey... 982=item db_del $family => $subkey...
980 983
981Deletes one or more subkeys from the database family. 984Deletes one or more subkeys from the database family.
982 985
983=item $guard = db_reg $family => $subkey [=> $value] 986=item $guard = db_reg $family => $port => $value
984 987
985Sets the key on the database and returns a guard. When the guard is 988=item $guard = db_reg $family => $port
986destroyed, the key is deleted from the database. If C<$value> is missing, 989
987then 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}
988 1023
989=item db_family $family => $cb->(\%familyhash) 1024=item db_family $family => $cb->(\%familyhash)
990 1025
991Queries the named database C<$family> and call the callback with the 1026Queries the named database C<$family> and call the callback with the
992family 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.
1217Keeping your messages simple, concentrating on data structures rather than 1252Keeping your messages simple, concentrating on data structures rather than
1218objects, will keep your messages clean, tidy and efficient. 1253objects, will keep your messages clean, tidy and efficient.
1219 1254
1220=back 1255=back
1221 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 are gone.
1325
1326And are not coming back, at least not in their old form.
1327
1328There are vague plans to implement some form of routing domains, which
1329might or might not bring back listener-less nodes, but don't count on it.
1330
1331The fact that most connections are now optional somewhat mitigates this,
1332as a node can be effectively unreachable from the outside without any
1333problems, as long as it isn't a global node and only reaches out to other
1334nodes (as opposed to being contacted from other nodes).
1335
1336=back
1337
1222=head1 SEE ALSO 1338=head1 SEE ALSO
1223 1339
1224L<AnyEvent::MP::Intro> - a gentle introduction. 1340L<AnyEvent::MP::Intro> - a gentle introduction.
1225 1341
1226L<AnyEvent::MP::Kernel> - more, lower-level, stuff. 1342L<AnyEvent::MP::Kernel> - more, lower-level, stuff.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines