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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.129 by root, Thu Mar 8 21:37:51 2012 UTC vs.
Revision 1.133 by root, Mon Mar 12 10:34:06 2012 UTC

 =cut
 sub rcv($@);
-sub _kilme {
+my $KILME = sub {
-   die "received message on port without callback";
+   (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
-}
+   kil $SELF, unhandled_message => "no callback set for message (first element $tag)";
+};
 sub port(;&) {
    my $id = $UNIQ . ++$ID;
    my $port = "$NODE#$id";
-   rcv $port, shift || \&_kilme;
+   rcv $port, shift || $KILME;
    $port
 }
 =item rcv $local_port, $callback->(@msg)
 The global C<$SELF> (exported by this module) contains C<$port> while
 executing the callback. Runtime errors during callback execution will
 result in the port being C<kil>ed.
-The default callback received all messages not matched by a more specific
+The default callback receives all messages not matched by a more specific
 C<tag> match.
 =item rcv $local_port, tag => $callback->(@msg_without_tag), ...
 Register (or replace) callbacks to be called on messages starting with the
 will be reported as reason C<< die => $@ >>.
 Transport/communication errors are reported as C<< transport_error =>
 $message >>.
-=cut
+Common idioms:
+   # silently remove yourself, do not kill linked ports
+   kil $SELF;
+   # report a failure in some detail
+   kil $SELF, failure_mode_1 => "it failed with too high temperature";
+   # do not waste much time with killing, just die when something goes wrong
+   open my $fh, "<file"
+      or die "file: $!";
 =item $port = spawn $node, $initfunc[, @initdata]
 Creates a port on the node C<$node> (which can also be a port ID, in which
 case it's the node where that port resides).
 =back
 =head1 DISTRIBUTED DATABASE
 AnyEvent::MP comes with a simple distributed database. The database will
-be mirrored asynchronously at all global nodes. Other nodes bind to one of
+be mirrored asynchronously on all global nodes. Other nodes bind to one
-the global nodes for their needs.
+of the global nodes for their needs. Every node has a "local database"
+which contains all the values that are set locally. All local databases
+are merged together to form the global database, which can be queried.
-The database consists of a two-level hash - a hash contains a hash which
+The database structure is that of a two-level hash - the database hash
-contains values.
+contains hashes which contain values, similarly to a perl hash of hashes,
+i.e.:
+  $DATABASE{$family}{$subkey} = $value
 The top level hash key is called "family", and the second-level hash key
 is called "subkey" or simply "key".
 The family must be alphanumeric, i.e. start with a letter and consist
 with the name of the application or module using it.
 The subkeys must be non-empty strings, with no further restrictions.
 The values should preferably be strings, but other perl scalars should
-work as well (such as undef, arrays and hashes).
+work as well (such as C<undef>, arrays and hashes).
 Every database entry is owned by one node - adding the same family/subkey
 combination on multiple nodes will not cause discomfort for AnyEvent::MP,
 but the result might be nondeterministic, i.e. the key might have
 different values on different nodes.
 =item db_set $family => $subkey [=> $value]
 Sets (or replaces) a key to the database - if C<$value> is omitted,
 C<undef> is used instead.
-=item db_del $family => $subkey
+=item db_del $family => $subkey...
-Deletes a key from the database.
+Deletes one or more subkeys from the database family.
 =item $guard = db_reg $family => $subkey [=> $value]
 Sets the key on the database and returns a guard. When the guard is
 destroyed, the key is deleted from the database. If C<$value> is missing,
 =item db_values $family => $cb->(\@values)
 Same as C<db_family>, except it only queries the family I<values> and passes them
 as array reference to the callback.
-=item $guard = db_mon $family => $cb->($familyhash, \@subkeys...)
+=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
-Creates a monitor on the given database family. Each time a key is set or
+Creates a monitor on the given database family. Each time a key is set
-or is deleted the callback is called with a hash containing the database
+or or is deleted the callback is called with a hash containing the
-family and an arrayref with subkeys that have changed.
+database family and three lists of added, changed and deleted subkeys,
+respectively. If no keys have changed then the array reference might be
+C<undef> or even missing.
-Specifically, if one of the passed subkeys exists in the $familyhash, then
+If not called in void context, a guard object is returned that, when
-it is currently set to the value in the $familyhash. Otherwise, it has
+destroyed, stops the monitor.
-been deleted.
-The family hash reference belongs to AnyEvent::MP and B<must not be
+The family hash reference and the key arrays belong to AnyEvent::MP and
-modified or stored> by the callback. When in doubt, make a copy.
+B<must not be modified or stored> by the callback. When in doubt, make a
+copy.
-The first call will be with the current contents of the family and all
+As soon as possible after the monitoring starts, the callback will be
-keys, as if they were just added.
+called with the intiial contents of the family, even if it is empty,
+i.e. there will always be a timely call to the callback with the current
+contents.
 It is possible that the callback is called with a change event even though
 the subkey is already present and the value has not changed.
 The monitoring stops when the guard object is destroyed.
 Example: on every change to the family "mygroup", print out all keys.
    my $guard = db_mon mygroup => sub {
-      my ($family, $keys) = @_;
+      my ($family, $a, $c, $d) = @_;
       print "mygroup members: ", (join " ", keys %$family), "\n";
    };
 Exmaple: wait until the family "My::Module::workers" is non-empty.
    my $guard; $guard = db_mon My::Module::workers => sub {
-      my ($family, $keys) = @_;
+      my ($family, $a, $c, $d) = @_;
       return unless %$family;
       undef $guard;
       print "My::Module::workers now nonempty\n";
    };
 Example: print all changes to the family "AnyRvent::Fantasy::Module".
    my $guard = db_mon AnyRvent::Fantasy::Module => sub {
-      my ($family, $keys) = @_;
+      my ($family, $a, $c, $d) = @_;
-      for (@$keys) {
+      print "+$_=$family->{$_}\n" for @$a;
-         print "$_: ",
+      print "*$_=$family->{$_}\n" for @$c;
-               (exists $family->{$_}
+      print "-$_=$family->{$_}\n" for @$d;
-                  ? $family->{$_}
-                  : "(deleted)"),
-               "\n";
-      }
    };
 =cut
 =back

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.129 by root, Thu Mar 8 21:37:51 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.129 by root, Thu Mar 8 21:37:51 2012 UTC vs.
Revision 1.133 by root, Mon Mar 12 10:34:06 2012 UTC