… | |
… | |
39 | |
39 | |
40 | =head1 CURRENT STATUS |
40 | =head1 CURRENT STATUS |
41 | |
41 | |
42 | bin/aemp - stable. |
42 | bin/aemp - stable. |
43 | AnyEvent::MP - stable API, should work. |
43 | AnyEvent::MP - stable API, should work. |
44 | AnyEvent::MP::Intro - uptodate, but incomplete. |
44 | AnyEvent::MP::Intro - explains most concepts. |
45 | AnyEvent::MP::Kernel - mostly stable. |
45 | AnyEvent::MP::Kernel - mostly stable. |
46 | AnyEvent::MP::Global - stable API, protocol not yet final. |
46 | AnyEvent::MP::Global - stable but incomplete, protocol not yet final. |
47 | |
47 | |
48 | stay tuned. |
48 | stay tuned. |
49 | |
49 | |
50 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
51 | |
51 | |
52 | This module (-family) implements a simple message passing framework. |
52 | This module (-family) implements a simple message passing framework. |
53 | |
53 | |
… | |
… | |
55 | on the same or other hosts, and you can supervise entities remotely. |
55 | on the same or other hosts, and you can supervise entities remotely. |
56 | |
56 | |
57 | For an introduction to this module family, see the L<AnyEvent::MP::Intro> |
57 | For an introduction to this module family, see the L<AnyEvent::MP::Intro> |
58 | manual page and the examples under F<eg/>. |
58 | manual page and the examples under F<eg/>. |
59 | |
59 | |
60 | At the moment, this module family is a bit underdocumented. |
|
|
61 | |
|
|
62 | =head1 CONCEPTS |
60 | =head1 CONCEPTS |
63 | |
61 | |
64 | =over 4 |
62 | =over 4 |
65 | |
63 | |
66 | =item port |
64 | =item port |
67 | |
65 | |
68 | A port is something you can send messages to (with the C<snd> function). |
66 | Not to be confused with a TCP port, a "port" is something you can send |
|
|
67 | messages to (with the C<snd> function). |
69 | |
68 | |
70 | Ports allow you to register C<rcv> handlers that can match all or just |
69 | Ports allow you to register C<rcv> handlers that can match all or just |
71 | some messages. Messages send to ports will not be queued, regardless of |
70 | some messages. Messages send to ports will not be queued, regardless of |
72 | anything was listening for them or not. |
71 | anything was listening for them or not. |
73 | |
72 | |
… | |
… | |
160 | |
159 | |
161 | =item $nodeid = node_of $port |
160 | =item $nodeid = node_of $port |
162 | |
161 | |
163 | Extracts and returns the node ID from a port ID or a node ID. |
162 | Extracts and returns the node ID from a port ID or a node ID. |
164 | |
163 | |
|
|
164 | =item configure $profile, key => value... |
|
|
165 | |
165 | =item configure key => value... |
166 | =item configure key => value... |
166 | |
167 | |
167 | Before a node can talk to other nodes on the network (i.e. enter |
168 | Before a node can talk to other nodes on the network (i.e. enter |
168 | "distributed mode") it has to configure itself - the minimum a node needs |
169 | "distributed mode") it has to configure itself - the minimum a node needs |
169 | to know is its own name, and optionally it should know the addresses of |
170 | to know is its own name, and optionally it should know the addresses of |
… | |
… | |
176 | |
177 | |
177 | =item step 1, gathering configuration from profiles |
178 | =item step 1, gathering configuration from profiles |
178 | |
179 | |
179 | The function first looks up a profile in the aemp configuration (see the |
180 | The function first looks up a profile in the aemp configuration (see the |
180 | L<aemp> commandline utility). The profile name can be specified via the |
181 | L<aemp> commandline utility). The profile name can be specified via the |
181 | named C<profile> parameter. If it is missing, then the nodename (F<uname |
182 | named C<profile> parameter or can simply be the first parameter). If it is |
182 | -n>) will be used as profile name. |
183 | missing, then the nodename (F<uname -n>) will be used as profile name. |
183 | |
184 | |
184 | The profile data is then gathered as follows: |
185 | The profile data is then gathered as follows: |
185 | |
186 | |
186 | First, all remaining key => value pairs (all of which are conviniently |
187 | First, all remaining key => value pairs (all of which are conveniently |
187 | undocumented at the moment) will be interpreted as configuration |
188 | undocumented at the moment) will be interpreted as configuration |
188 | data. Then they will be overwritten by any values specified in the global |
189 | data. Then they will be overwritten by any values specified in the global |
189 | default configuration (see the F<aemp> utility), then the chain of |
190 | default configuration (see the F<aemp> utility), then the chain of |
190 | profiles chosen by the profile name (and any C<parent> attributes). |
191 | profiles chosen by the profile name (and any C<parent> attributes). |
191 | |
192 | |
… | |
… | |
474 | |
475 | |
475 | Monitor the given port and do something when the port is killed or |
476 | Monitor the given port and do something when the port is killed or |
476 | messages to it were lost, and optionally return a guard that can be used |
477 | messages to it were lost, and optionally return a guard that can be used |
477 | to stop monitoring again. |
478 | to stop monitoring again. |
478 | |
479 | |
|
|
480 | In the first form (callback), the callback is simply called with any |
|
|
481 | number of C<@reason> elements (no @reason means that the port was deleted |
|
|
482 | "normally"). Note also that I<< the callback B<must> never die >>, so use |
|
|
483 | C<eval> if unsure. |
|
|
484 | |
|
|
485 | In the second form (another port given), the other port (C<$rcvport>) |
|
|
486 | will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on |
|
|
487 | "normal" kils nothing happens, while under all other conditions, the other |
|
|
488 | port is killed with the same reason. |
|
|
489 | |
|
|
490 | The third form (kill self) is the same as the second form, except that |
|
|
491 | C<$rvport> defaults to C<$SELF>. |
|
|
492 | |
|
|
493 | In the last form (message), a message of the form C<@msg, @reason> will be |
|
|
494 | C<snd>. |
|
|
495 | |
|
|
496 | Monitoring-actions are one-shot: once messages are lost (and a monitoring |
|
|
497 | alert was raised), they are removed and will not trigger again. |
|
|
498 | |
|
|
499 | As a rule of thumb, monitoring requests should always monitor a port from |
|
|
500 | a local port (or callback). The reason is that kill messages might get |
|
|
501 | lost, just like any other message. Another less obvious reason is that |
|
|
502 | even monitoring requests can get lost (for example, when the connection |
|
|
503 | to the other node goes down permanently). When monitoring a port locally |
|
|
504 | these problems do not exist. |
|
|
505 | |
479 | C<mon> effectively guarantees that, in the absence of hardware failures, |
506 | C<mon> effectively guarantees that, in the absence of hardware failures, |
480 | after starting the monitor, either all messages sent to the port will |
507 | after starting the monitor, either all messages sent to the port will |
481 | arrive, or the monitoring action will be invoked after possible message |
508 | arrive, or the monitoring action will be invoked after possible message |
482 | loss has been detected. No messages will be lost "in between" (after |
509 | loss has been detected. No messages will be lost "in between" (after |
483 | the first lost message no further messages will be received by the |
510 | the first lost message no further messages will be received by the |
484 | port). After the monitoring action was invoked, further messages might get |
511 | port). After the monitoring action was invoked, further messages might get |
485 | delivered again. |
512 | delivered again. |
486 | |
513 | |
487 | Note that monitoring-actions are one-shot: once messages are lost (and a |
514 | Inter-host-connection timeouts and monitoring depend on the transport |
488 | monitoring alert was raised), they are removed and will not trigger again. |
515 | used. The only transport currently implemented is TCP, and AnyEvent::MP |
|
|
516 | relies on TCP to detect node-downs (this can take 10-15 minutes on a |
|
|
517 | non-idle connection, and usually around two hours for idle conenctions). |
489 | |
518 | |
490 | In the first form (callback), the callback is simply called with any |
519 | This means that monitoring is good for program errors and cleaning up |
491 | number of C<@reason> elements (no @reason means that the port was deleted |
520 | stuff eventually, but they are no replacement for a timeout when you need |
492 | "normally"). Note also that I<< the callback B<must> never die >>, so use |
521 | to ensure some maximum latency. |
493 | C<eval> if unsure. |
|
|
494 | |
|
|
495 | In the second form (another port given), the other port (C<$rcvport>) |
|
|
496 | will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on |
|
|
497 | "normal" kils nothing happens, while under all other conditions, the other |
|
|
498 | port is killed with the same reason. |
|
|
499 | |
|
|
500 | The third form (kill self) is the same as the second form, except that |
|
|
501 | C<$rvport> defaults to C<$SELF>. |
|
|
502 | |
|
|
503 | In the last form (message), a message of the form C<@msg, @reason> will be |
|
|
504 | C<snd>. |
|
|
505 | |
|
|
506 | As a rule of thumb, monitoring requests should always monitor a port from |
|
|
507 | a local port (or callback). The reason is that kill messages might get |
|
|
508 | lost, just like any other message. Another less obvious reason is that |
|
|
509 | even monitoring requests can get lost (for exmaple, when the connection |
|
|
510 | to the other node goes down permanently). When monitoring a port locally |
|
|
511 | these problems do not exist. |
|
|
512 | |
522 | |
513 | Example: call a given callback when C<$port> is killed. |
523 | Example: call a given callback when C<$port> is killed. |
514 | |
524 | |
515 | mon $port, sub { warn "port died because of <@_>\n" }; |
525 | mon $port, sub { warn "port died because of <@_>\n" }; |
516 | |
526 | |
… | |
… | |
611 | the package, then the package above the package and so on (e.g. |
621 | the package, then the package above the package and so on (e.g. |
612 | C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function |
622 | C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function |
613 | exists or it runs out of package names. |
623 | exists or it runs out of package names. |
614 | |
624 | |
615 | The init function is then called with the newly-created port as context |
625 | The init function is then called with the newly-created port as context |
616 | object (C<$SELF>) and the C<@initdata> values as arguments. |
626 | object (C<$SELF>) and the C<@initdata> values as arguments. It I<must> |
|
|
627 | call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise |
|
|
628 | the port might not get created. |
617 | |
629 | |
618 | A common idiom is to pass a local port, immediately monitor the spawned |
630 | A common idiom is to pass a local port, immediately monitor the spawned |
619 | port, and in the remote init function, immediately monitor the passed |
631 | port, and in the remote init function, immediately monitor the passed |
620 | local port. This two-way monitoring ensures that both ports get cleaned up |
632 | local port. This two-way monitoring ensures that both ports get cleaned up |
621 | when there is a problem. |
633 | when there is a problem. |
622 | |
634 | |
|
|
635 | C<spawn> guarantees that the C<$initfunc> has no visible effects on the |
|
|
636 | caller before C<spawn> returns (by delaying invocation when spawn is |
|
|
637 | called for the local node). |
|
|
638 | |
623 | Example: spawn a chat server port on C<$othernode>. |
639 | Example: spawn a chat server port on C<$othernode>. |
624 | |
640 | |
625 | # this node, executed from within a port context: |
641 | # this node, executed from within a port context: |
626 | my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; |
642 | my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; |
627 | mon $server; |
643 | mon $server; |
… | |
… | |
641 | |
657 | |
642 | sub _spawn { |
658 | sub _spawn { |
643 | my $port = shift; |
659 | my $port = shift; |
644 | my $init = shift; |
660 | my $init = shift; |
645 | |
661 | |
|
|
662 | # rcv will create the actual port |
646 | local $SELF = "$NODE#$port"; |
663 | local $SELF = "$NODE#$port"; |
647 | eval { |
664 | eval { |
648 | &{ load_func $init } |
665 | &{ load_func $init } |
649 | }; |
666 | }; |
650 | _self_die if $@; |
667 | _self_die if $@; |
… | |
… | |
707 | |
724 | |
708 | =item * Node IDs are arbitrary strings in AEMP. |
725 | =item * Node IDs are arbitrary strings in AEMP. |
709 | |
726 | |
710 | Erlang relies on special naming and DNS to work everywhere in the same |
727 | Erlang relies on special naming and DNS to work everywhere in the same |
711 | way. AEMP relies on each node somehow knowing its own address(es) (e.g. by |
728 | way. AEMP relies on each node somehow knowing its own address(es) (e.g. by |
712 | configuraiton or DNS), but will otherwise discover other odes itself. |
729 | configuration or DNS), but will otherwise discover other odes itself. |
713 | |
730 | |
714 | =item * Erlang has a "remote ports are like local ports" philosophy, AEMP |
731 | =item * Erlang has a "remote ports are like local ports" philosophy, AEMP |
715 | uses "local ports are like remote ports". |
732 | uses "local ports are like remote ports". |
716 | |
733 | |
717 | The failure modes for local ports are quite different (runtime errors |
734 | The failure modes for local ports are quite different (runtime errors |
… | |
… | |
730 | |
747 | |
731 | Erlang uses processes that selectively receive messages, and therefore |
748 | Erlang uses processes that selectively receive messages, and therefore |
732 | needs a queue. AEMP is event based, queuing messages would serve no |
749 | needs a queue. AEMP is event based, queuing messages would serve no |
733 | useful purpose. For the same reason the pattern-matching abilities of |
750 | useful purpose. For the same reason the pattern-matching abilities of |
734 | AnyEvent::MP are more limited, as there is little need to be able to |
751 | AnyEvent::MP are more limited, as there is little need to be able to |
735 | filter messages without dequeing them. |
752 | filter messages without dequeuing them. |
736 | |
753 | |
737 | (But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). |
754 | (But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). |
738 | |
755 | |
739 | =item * Erlang sends are synchronous, AEMP sends are asynchronous. |
756 | =item * Erlang sends are synchronous, AEMP sends are asynchronous. |
740 | |
757 | |
… | |
… | |
846 | L<AnyEvent::MP::Kernel> - more, lower-level, stuff. |
863 | L<AnyEvent::MP::Kernel> - more, lower-level, stuff. |
847 | |
864 | |
848 | L<AnyEvent::MP::Global> - network maintainance and port groups, to find |
865 | L<AnyEvent::MP::Global> - network maintainance and port groups, to find |
849 | your applications. |
866 | your applications. |
850 | |
867 | |
|
|
868 | L<AnyEvent::MP::LogCatcher> - simple service to display log messages from |
|
|
869 | all nodes. |
|
|
870 | |
851 | L<AnyEvent>. |
871 | L<AnyEvent>. |
852 | |
872 | |
853 | =head1 AUTHOR |
873 | =head1 AUTHOR |
854 | |
874 | |
855 | Marc Lehmann <schmorp@schmorp.de> |
875 | Marc Lehmann <schmorp@schmorp.de> |