… | |
… | |
247 | |
247 | |
248 | IF true, then the values specified in the C<configure> will take |
248 | 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 |
249 | 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. |
250 | the rc file to override any options specified in the program. |
251 | |
251 | |
252 | =item secure => $pass->($nodeid) |
252 | =item secure => $pass->(@msg) |
253 | |
253 | |
254 | In addition to specifying a boolean, you can specify a code reference that |
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 |
255 | is called for every code execution attempt - the execution request is |
256 | granted iff the callback returns a true value. |
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). |
257 | |
262 | |
258 | See F<semp setsecure> for more info. |
263 | See F<semp setsecure> for more info. |
259 | |
264 | |
260 | =back |
265 | =back |
261 | |
266 | |
… | |
… | |
398 | |
403 | |
399 | =cut |
404 | =cut |
400 | |
405 | |
401 | sub rcv($@); |
406 | sub rcv($@); |
402 | |
407 | |
403 | sub _kilme { |
408 | my $KILME = sub { |
404 | die "received message on port without callback"; |
409 | (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g; |
405 | } |
410 | kil $SELF, unhandled_message => "no callback found for message '$tag'"; |
|
|
411 | }; |
406 | |
412 | |
407 | sub port(;&) { |
413 | sub port(;&) { |
408 | my $id = $UNIQ . ++$ID; |
414 | my $id = $UNIQ . ++$ID; |
409 | my $port = "$NODE#$id"; |
415 | my $port = "$NODE#$id"; |
410 | |
416 | |
411 | rcv $port, shift || \&_kilme; |
417 | rcv $port, shift || $KILME; |
412 | |
418 | |
413 | $port |
419 | $port |
414 | } |
420 | } |
415 | |
421 | |
416 | =item rcv $local_port, $callback->(@msg) |
422 | =item rcv $local_port, $callback->(@msg) |
… | |
… | |
421 | |
427 | |
422 | The global C<$SELF> (exported by this module) contains C<$port> while |
428 | The global C<$SELF> (exported by this module) contains C<$port> while |
423 | executing the callback. Runtime errors during callback execution will |
429 | executing the callback. Runtime errors during callback execution will |
424 | result in the port being C<kil>ed. |
430 | result in the port being C<kil>ed. |
425 | |
431 | |
426 | The default callback received all messages not matched by a more specific |
432 | The default callback receives all messages not matched by a more specific |
427 | C<tag> match. |
433 | C<tag> match. |
428 | |
434 | |
429 | =item rcv $local_port, tag => $callback->(@msg_without_tag), ... |
435 | =item rcv $local_port, tag => $callback->(@msg_without_tag), ... |
430 | |
436 | |
431 | Register (or replace) callbacks to be called on messages starting with the |
437 | Register (or replace) callbacks to be called on messages starting with the |
… | |
… | |
732 | will be reported as reason C<< die => $@ >>. |
738 | will be reported as reason C<< die => $@ >>. |
733 | |
739 | |
734 | Transport/communication errors are reported as C<< transport_error => |
740 | Transport/communication errors are reported as C<< transport_error => |
735 | $message >>. |
741 | $message >>. |
736 | |
742 | |
737 | =cut |
743 | Common idioms: |
|
|
744 | |
|
|
745 | # silently remove yourself, do not kill linked ports |
|
|
746 | kil $SELF; |
|
|
747 | |
|
|
748 | # report a failure in some detail |
|
|
749 | kil $SELF, failure_mode_1 => "it failed with too high temperature"; |
|
|
750 | |
|
|
751 | # do not waste much time with killing, just die when something goes wrong |
|
|
752 | open my $fh, "<file" |
|
|
753 | or die "file: $!"; |
738 | |
754 | |
739 | =item $port = spawn $node, $initfunc[, @initdata] |
755 | =item $port = spawn $node, $initfunc[, @initdata] |
740 | |
756 | |
741 | Creates a port on the node C<$node> (which can also be a port ID, in which |
757 | Creates a port on the node C<$node> (which can also be a port ID, in which |
742 | case it's the node where that port resides). |
758 | case it's the node where that port resides). |
… | |
… | |
894 | =back |
910 | =back |
895 | |
911 | |
896 | =head1 DISTRIBUTED DATABASE |
912 | =head1 DISTRIBUTED DATABASE |
897 | |
913 | |
898 | AnyEvent::MP comes with a simple distributed database. The database will |
914 | AnyEvent::MP comes with a simple distributed database. The database will |
899 | be mirrored asynchronously at all global nodes. Other nodes bind to one of |
915 | be mirrored asynchronously on all global nodes. Other nodes bind to one |
900 | the global nodes for their needs. |
916 | of the global nodes for their needs. Every node has a "local database" |
|
|
917 | which contains all the values that are set locally. All local databases |
|
|
918 | are merged together to form the global database, which can be queried. |
901 | |
919 | |
902 | The database consists of a two-level hash - a hash contains a hash which |
920 | The database structure is that of a two-level hash - the database hash |
903 | contains values. |
921 | contains hashes which contain values, similarly to a perl hash of hashes, |
|
|
922 | i.e.: |
|
|
923 | |
|
|
924 | $DATABASE{$family}{$subkey} = $value |
904 | |
925 | |
905 | The top level hash key is called "family", and the second-level hash key |
926 | The top level hash key is called "family", and the second-level hash key |
906 | is called "subkey" or simply "key". |
927 | is called "subkey" or simply "key". |
907 | |
928 | |
908 | The family must be alphanumeric, i.e. start with a letter and consist |
929 | The family must be alphanumeric, i.e. start with a letter and consist |
… | |
… | |
913 | with the name of the application or module using it. |
934 | with the name of the application or module using it. |
914 | |
935 | |
915 | The subkeys must be non-empty strings, with no further restrictions. |
936 | The subkeys must be non-empty strings, with no further restrictions. |
916 | |
937 | |
917 | The values should preferably be strings, but other perl scalars should |
938 | The values should preferably be strings, but other perl scalars should |
918 | work as well (such as undef, arrays and hashes). |
939 | work as well (such as C<undef>, arrays and hashes). |
919 | |
940 | |
920 | Every database entry is owned by one node - adding the same family/subkey |
941 | Every database entry is owned by one node - adding the same family/subkey |
921 | combination on multiple nodes will not cause discomfort for AnyEvent::MP, |
942 | combination on multiple nodes will not cause discomfort for AnyEvent::MP, |
922 | but the result might be nondeterministic, i.e. the key might have |
943 | but the result might be nondeterministic, i.e. the key might have |
923 | different values on different nodes. |
944 | different values on different nodes. |
… | |
… | |
953 | =item db_set $family => $subkey [=> $value] |
974 | =item db_set $family => $subkey [=> $value] |
954 | |
975 | |
955 | Sets (or replaces) a key to the database - if C<$value> is omitted, |
976 | Sets (or replaces) a key to the database - if C<$value> is omitted, |
956 | C<undef> is used instead. |
977 | C<undef> is used instead. |
957 | |
978 | |
958 | =item db_del $family => $subkey |
979 | =item db_del $family => $subkey... |
959 | |
980 | |
960 | Deletes a key from the database. |
981 | Deletes one or more subkeys from the database family. |
961 | |
982 | |
962 | =item $guard = db_reg $family => $subkey [=> $value] |
983 | =item $guard = db_reg $family => $subkey [=> $value] |
963 | |
984 | |
964 | Sets the key on the database and returns a guard. When the guard is |
985 | Sets the key on the database and returns a guard. When the guard is |
965 | destroyed, the key is deleted from the database. If C<$value> is missing, |
986 | destroyed, the key is deleted from the database. If C<$value> is missing, |
… | |
… | |
978 | =item db_values $family => $cb->(\@values) |
999 | =item db_values $family => $cb->(\@values) |
979 | |
1000 | |
980 | Same as C<db_family>, except it only queries the family I<values> and passes them |
1001 | Same as C<db_family>, except it only queries the family I<values> and passes them |
981 | as array reference to the callback. |
1002 | as array reference to the callback. |
982 | |
1003 | |
983 | =item $guard = db_mon $family => $cb->($familyhash, \@subkeys...) |
1004 | =item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted) |
984 | |
1005 | |
985 | Creates a monitor on the given database family. Each time a key is set or |
1006 | Creates a monitor on the given database family. Each time a key is set |
986 | or is deleted the callback is called with a hash containing the database |
1007 | or or is deleted the callback is called with a hash containing the |
987 | family and an arrayref with subkeys that have changed. |
1008 | database family and three lists of added, changed and deleted subkeys, |
|
|
1009 | respectively. If no keys have changed then the array reference might be |
|
|
1010 | C<undef> or even missing. |
988 | |
1011 | |
989 | Specifically, if one of the passed subkeys exists in the $familyhash, then |
1012 | If not called in void context, a guard object is returned that, when |
990 | it is currently set to the value in the $familyhash. Otherwise, it has |
1013 | destroyed, stops the monitor. |
991 | been deleted. |
|
|
992 | |
1014 | |
993 | The family hash reference belongs to AnyEvent::MP and B<must not be |
1015 | The family hash reference and the key arrays belong to AnyEvent::MP and |
994 | modified or stored> by the callback. When in doubt, make a copy. |
1016 | B<must not be modified or stored> by the callback. When in doubt, make a |
|
|
1017 | copy. |
995 | |
1018 | |
996 | The first call will be with the current contents of the family and all |
1019 | As soon as possible after the monitoring starts, the callback will be |
997 | keys, as if they were just added. |
1020 | called with the intiial contents of the family, even if it is empty, |
|
|
1021 | i.e. there will always be a timely call to the callback with the current |
|
|
1022 | contents. |
998 | |
1023 | |
999 | It is possible that the callback is called with a change event even though |
1024 | It is possible that the callback is called with a change event even though |
1000 | the subkey is already present and the value has not changed. |
1025 | the subkey is already present and the value has not changed. |
1001 | |
1026 | |
1002 | The monitoring stops when the guard object is destroyed. |
1027 | The monitoring stops when the guard object is destroyed. |
1003 | |
1028 | |
1004 | Example: on every change to the family "mygroup", print out all keys. |
1029 | Example: on every change to the family "mygroup", print out all keys. |
1005 | |
1030 | |
1006 | my $guard = db_mon mygroup => sub { |
1031 | my $guard = db_mon mygroup => sub { |
1007 | my ($family, $keys) = @_; |
1032 | my ($family, $a, $c, $d) = @_; |
1008 | print "mygroup members: ", (join " ", keys %$family), "\n"; |
1033 | print "mygroup members: ", (join " ", keys %$family), "\n"; |
1009 | }; |
1034 | }; |
1010 | |
1035 | |
1011 | Exmaple: wait until the family "My::Module::workers" is non-empty. |
1036 | Exmaple: wait until the family "My::Module::workers" is non-empty. |
1012 | |
1037 | |
1013 | my $guard; $guard = db_mon My::Module::workers => sub { |
1038 | my $guard; $guard = db_mon My::Module::workers => sub { |
1014 | my ($family, $keys) = @_; |
1039 | my ($family, $a, $c, $d) = @_; |
1015 | return unless %$family; |
1040 | return unless %$family; |
1016 | undef $guard; |
1041 | undef $guard; |
1017 | print "My::Module::workers now nonempty\n"; |
1042 | print "My::Module::workers now nonempty\n"; |
1018 | }; |
1043 | }; |
1019 | |
1044 | |
1020 | Example: print all changes to the family "AnyRvent::Fantasy::Module". |
1045 | Example: print all changes to the family "AnyRvent::Fantasy::Module". |
1021 | |
1046 | |
1022 | my $guard = db_mon AnyRvent::Fantasy::Module => sub { |
1047 | my $guard = db_mon AnyRvent::Fantasy::Module => sub { |
1023 | my ($family, $keys) = @_; |
1048 | my ($family, $a, $c, $d) = @_; |
1024 | |
1049 | |
1025 | for (@$keys) { |
1050 | print "+$_=$family->{$_}\n" for @$a; |
1026 | print "$_: ", |
1051 | print "*$_=$family->{$_}\n" for @$c; |
1027 | (exists $family->{$_} |
1052 | print "-$_=$family->{$_}\n" for @$d; |
1028 | ? $family->{$_} |
|
|
1029 | : "(deleted)"), |
|
|
1030 | "\n"; |
|
|
1031 | } |
|
|
1032 | }; |
1053 | }; |
1033 | |
1054 | |
1034 | =cut |
1055 | =cut |
1035 | |
1056 | |
1036 | =back |
1057 | =back |