… | |
… | |
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 | |
… | |
… | |
184 | |
189 | |
185 | use common::sense; |
190 | use common::sense; |
186 | |
191 | |
187 | use Carp (); |
192 | use Carp (); |
188 | |
193 | |
189 | use AE (); |
194 | use AnyEvent (); |
190 | use Guard (); |
195 | use Guard (); |
191 | |
196 | |
192 | use base "Exporter"; |
197 | use base "Exporter"; |
193 | |
198 | |
194 | our $VERSION = $AnyEvent::MP::Config::VERSION; |
199 | our $VERSION = $AnyEvent::MP::Config::VERSION; |
… | |
… | |
246 | =item force => $boolean (default false) |
251 | =item force => $boolean (default false) |
247 | |
252 | |
248 | IF true, then the values specified in the C<configure> will take |
253 | 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 |
254 | 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. |
255 | 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 | |
256 | |
265 | =back |
257 | =back |
266 | |
258 | |
267 | =over 4 |
259 | =over 4 |
268 | |
260 | |
… | |
… | |
601 | $res |
593 | $res |
602 | } |
594 | } |
603 | } |
595 | } |
604 | } |
596 | } |
605 | |
597 | |
|
|
598 | =item $guard = mon $port, $rcvport # kill $rcvport when $port dies |
|
|
599 | |
|
|
600 | =item $guard = mon $port # kill $SELF when $port dies |
|
|
601 | |
606 | =item $guard = mon $port, $cb->(@reason) # call $cb when $port dies |
602 | =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 | |
603 | |
612 | =item $guard = mon $port, $rcvport, @msg # send a message when $port dies |
604 | =item $guard = mon $port, $rcvport, @msg # send a message when $port dies |
613 | |
605 | |
614 | Monitor the given port and do something when the port is killed or |
606 | 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 |
607 | messages to it were lost, and optionally return a guard that can be used |
616 | to stop monitoring again. |
608 | to stop monitoring again. |
617 | |
609 | |
|
|
610 | The first two forms distinguish between "normal" and "abnormal" kil's: |
|
|
611 | |
|
|
612 | In the first form (another port given), if the C<$port> is C<kil>'ed with |
|
|
613 | a non-empty reason, the other port (C<$rcvport>) will be kil'ed with the |
|
|
614 | same reason. That is, on "normal" kil's nothing happens, while under all |
|
|
615 | other conditions, the other port is killed with the same reason. |
|
|
616 | |
|
|
617 | The second form (kill self) is the same as the first form, except that |
|
|
618 | C<$rvport> defaults to C<$SELF>. |
|
|
619 | |
|
|
620 | The remaining forms don't distinguish between "normal" and "abnormal" kil's |
|
|
621 | - it's up to the callback or receiver to check whether the C<@reason> is |
|
|
622 | empty and act accordingly. |
|
|
623 | |
618 | In the first form (callback), the callback is simply called with any |
624 | 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 |
625 | 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 |
626 | "normally"). Note also that I<< the callback B<must> never die >>, so use |
621 | C<eval> if unsure. |
627 | C<eval> if unsure. |
622 | |
628 | |
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 |
629 | In the last form (message), a message of the form C<$rcvport, @msg, |
632 | C<snd>. |
630 | @reason> will be C<snd>. |
633 | |
631 | |
634 | Monitoring-actions are one-shot: once messages are lost (and a monitoring |
632 | Monitoring-actions are one-shot: once messages are lost (and a monitoring |
635 | alert was raised), they are removed and will not trigger again. |
633 | alert was raised), they are removed and will not trigger again, even if it |
|
|
634 | turns out that the port is still alive. |
636 | |
635 | |
637 | As a rule of thumb, monitoring requests should always monitor a port from |
636 | 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 |
637 | 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 |
638 | kill messages might get lost, just like any other message. Another less |
640 | even monitoring requests can get lost (for example, when the connection |
639 | 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 |
640 | when the connection to the other node goes down permanently). When |
642 | these problems do not exist. |
641 | monitoring a port locally these problems do not exist. |
643 | |
642 | |
644 | C<mon> effectively guarantees that, in the absence of hardware failures, |
643 | C<mon> effectively guarantees that, in the absence of hardware failures, |
645 | after starting the monitor, either all messages sent to the port will |
644 | after starting the monitor, either all messages sent to the port will |
646 | arrive, or the monitoring action will be invoked after possible message |
645 | arrive, or the monitoring action will be invoked after possible message |
647 | loss has been detected. No messages will be lost "in between" (after |
646 | loss has been detected. No messages will be lost "in between" (after |
… | |
… | |
1034 | =item db_values $family => $cb->(\@values) |
1033 | =item db_values $family => $cb->(\@values) |
1035 | |
1034 | |
1036 | Same as C<db_family>, except it only queries the family I<values> and passes them |
1035 | Same as C<db_family>, except it only queries the family I<values> and passes them |
1037 | as array reference to the callback. |
1036 | as array reference to the callback. |
1038 | |
1037 | |
1039 | =item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted) |
1038 | =item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted) |
1040 | |
1039 | |
1041 | Creates a monitor on the given database family. Each time a key is set |
1040 | 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 |
1041 | 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, |
1042 | database family and three lists of added, changed and deleted subkeys, |
1044 | respectively. If no keys have changed then the array reference might be |
1043 | respectively. If no keys have changed then the array reference might be |
… | |
… | |
1254 | |
1253 | |
1255 | =back |
1254 | =back |
1256 | |
1255 | |
1257 | =head1 PORTING FROM AnyEvent::MP VERSION 1.X |
1256 | =head1 PORTING FROM AnyEvent::MP VERSION 1.X |
1258 | |
1257 | |
1259 | AEMP version 2 has three major incompatible changes compared to version 1: |
1258 | AEMP version 2 has a few major incompatible changes compared to version 1: |
1260 | |
1259 | |
1261 | =over 4 |
1260 | =over 4 |
1262 | |
1261 | |
1263 | =item AnyEvent::MP::Global no longer has group management functions. |
1262 | =item AnyEvent::MP::Global no longer has group management functions. |
1264 | |
1263 | |
|
|
1264 | At least not officially - the grp_* functions are still exported and might |
|
|
1265 | work, but they will be removed in some later release. |
|
|
1266 | |
1265 | AnyEvent::MP now comes with a distributed database that is more |
1267 | 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 |
1268 | powerful. Its database families map closely to port groups, but the API |
1267 | minor differences: |
1269 | has changed (the functions are also now exported by AnyEvent::MP). Here is |
|
|
1270 | a rough porting guide: |
1268 | |
1271 | |
1269 | grp_reg $group, $port # old |
1272 | grp_reg $group, $port # old |
1270 | db_reg $group, $port # new |
1273 | db_reg $group, $port # new |
1271 | |
1274 | |
1272 | $list = grp_get $group # old |
1275 | $list = grp_get $group # old |
1273 | db_keys $group, sub { my $list = shift } # new |
1276 | db_keys $group, sub { my $list = shift } # new |
1274 | |
1277 | |
1275 | grp_mon $group, $cb->(\@ports, $add, $del) # old |
1278 | grp_mon $group, $cb->(\@ports, $add, $del) # old |
1276 | db_mon $group, $cb->(\%ports, $add, $change, $del) # new |
1279 | db_mon $group, $cb->(\%ports, $add, $change, $del) # new |
1277 | |
1280 | |
1278 | C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> |
1281 | 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 |
1282 | 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 |
1283 | group. You can either modify your code to allow for a callback, or use |
1281 | updated copy of the group: |
1284 | C<db_mon> to keep an updated copy of the group: |
1282 | |
1285 | |
1283 | my $local_group_copy; |
1286 | my $local_group_copy; |
1284 | db_mon $group => sub { $local_group_copy = shift }; |
1287 | db_mon $group => sub { $local_group_copy = $_[0] }; |
1285 | |
1288 | |
1286 | # no keys %$local_group_copy always returns the most up-to-date |
1289 | # now "keys %$local_group_copy" always returns the most up-to-date |
1287 | # list of ports in the group. |
1290 | # list of ports in the group. |
1288 | |
1291 | |
1289 | C<grp_mon> can almost be replaced by C<db_mon>: |
1292 | C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon> |
|
|
1293 | passes a hash as first argument, and an extra C<$chg> argument that can be |
|
|
1294 | ignored: |
1290 | |
1295 | |
1291 | db_mon $group => sub { |
1296 | db_mon $group => sub { |
1292 | my ($ports, $add, $chg, $lde) = @_; |
1297 | my ($ports, $add, $chg, $lde) = @_; |
1293 | $ports = [keys %$ports]; |
1298 | $ports = [keys %$ports]; |
1294 | |
1299 | |
… | |
… | |
1311 | of its seed nodes. If that seed node isn't a global node yet, it will |
1316 | of its seed nodes. If that seed node isn't a global node yet, it will |
1312 | automatically be upgraded to a global node. |
1317 | automatically be upgraded to a global node. |
1313 | |
1318 | |
1314 | So in many cases, nothing needs to be changed - one just has to make sure |
1319 | 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 |
1320 | 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. |
1321 | AEMP 1.x), and other nodes specify them as seed nodes. This is most easily |
|
|
1322 | achieved by specifying the same set of seed nodes for all nodes in the |
|
|
1323 | network. |
1317 | |
1324 | |
1318 | Not opening a connection to every other node is usually an advantage, |
1325 | Not opening a connection to every other node is usually an advantage, |
1319 | except when you need the lower latency of an already established |
1326 | except when you need the lower latency of an already established |
1320 | connection. To ensure a node establishes a connection to another node, |
1327 | 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 |
1328 | you can monitor the node port (C<mon $node, ...>), which will attempt to |
1322 | create the connection (and notify you when the connection fails). |
1329 | create the connection (and notify you when the connection fails). |
1323 | |
1330 | |
1324 | =item Listener-less nodes (nodes without binds) are gone. |
1331 | =item Listener-less nodes (nodes without binds) are gone. |
1325 | |
1332 | |
1326 | And are not coming back, at least not in their old form. If no C<binds> |
1333 | And are not coming back, at least not in their old form. If no C<binds> |
1327 | are specified for a node, AnyEvent::MP now assumes a default of C<*:*>. |
1334 | are specified for a node, AnyEvent::MP assumes a default of C<*:*>. |
1328 | |
1335 | |
1329 | There are vague plans to implement some form of routing domains, which |
1336 | There are vague plans to implement some form of routing domains, which |
1330 | might or might not bring back listener-less nodes, but don't count on it. |
1337 | might or might not bring back listener-less nodes, but don't count on it. |
1331 | |
1338 | |
1332 | The fact that most connections are now optional somewhat mitigates this, |
1339 | The fact that most connections are now optional somewhat mitigates this, |
… | |
… | |
1341 | |
1348 | |
1342 | Every module now documents what kinds of messages it generates, with |
1349 | Every module now documents what kinds of messages it generates, with |
1343 | AnyEvent::MP acting as a catch all. |
1350 | AnyEvent::MP acting as a catch all. |
1344 | |
1351 | |
1345 | On the positive side, this means that instead of setting |
1352 | On the positive side, this means that instead of setting |
1346 | C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE>, |
1353 | C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE> - |
1347 | much less to type. |
1354 | much less to type. |
1348 | |
1355 | |
1349 | =back |
1356 | =back |
|
|
1357 | |
|
|
1358 | =head1 LOGGING |
|
|
1359 | |
|
|
1360 | AnyEvent::MP does not normally log anything by itself, but sinc eit is the |
|
|
1361 | root of the contetx hierarchy for AnyEvent::MP modules, it will receive |
|
|
1362 | all log messages by submodules. |
1350 | |
1363 | |
1351 | =head1 SEE ALSO |
1364 | =head1 SEE ALSO |
1352 | |
1365 | |
1353 | L<AnyEvent::MP::Intro> - a gentle introduction. |
1366 | L<AnyEvent::MP::Intro> - a gentle introduction. |
1354 | |
1367 | |