… | |
… | |
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 - explains most concepts. |
44 | AnyEvent::MP::Intro - explains most concepts. |
45 | AnyEvent::MP::Kernel - mostly stable. |
45 | AnyEvent::MP::Kernel - mostly stable API. |
46 | AnyEvent::MP::Global - stable but incomplete, protocol not yet final. |
46 | AnyEvent::MP::Global - stable API. |
47 | |
|
|
48 | stay tuned. |
|
|
49 | |
47 | |
50 | =head1 DESCRIPTION |
48 | =head1 DESCRIPTION |
51 | |
49 | |
52 | This module (-family) implements a simple message passing framework. |
50 | This module (-family) implements a simple message passing framework. |
53 | |
51 | |
… | |
… | |
83 | |
81 | |
84 | Nodes are either public (have one or more listening ports) or private |
82 | Nodes are either public (have one or more listening ports) or private |
85 | (no listening ports). Private nodes cannot talk to other private nodes |
83 | (no listening ports). Private nodes cannot talk to other private nodes |
86 | currently. |
84 | currently. |
87 | |
85 | |
88 | =item node ID - C<[a-za-Z0-9_\-.:]+> |
86 | =item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*> |
89 | |
87 | |
90 | A node ID is a string that uniquely identifies the node within a |
88 | A node ID is a string that uniquely identifies the node within a |
91 | network. Depending on the configuration used, node IDs can look like a |
89 | network. Depending on the configuration used, node IDs can look like a |
92 | hostname, a hostname and a port, or a random string. AnyEvent::MP itself |
90 | hostname, a hostname and a port, or a random string. AnyEvent::MP itself |
93 | doesn't interpret node IDs in any way. |
91 | doesn't interpret node IDs in any way. |
… | |
… | |
109 | to have fixed listening addresses, seed nodes are perfectly normal nodes - |
107 | to have fixed listening addresses, seed nodes are perfectly normal nodes - |
110 | any node can function as a seed node for others. |
108 | any node can function as a seed node for others. |
111 | |
109 | |
112 | In addition to discovering the network, seed nodes are also used to |
110 | In addition to discovering the network, seed nodes are also used to |
113 | maintain the network and to connect nodes that otherwise would have |
111 | maintain the network and to connect nodes that otherwise would have |
114 | trouble connecting. They form the backbone of the AnyEvent::MP network. |
112 | trouble connecting. They form the backbone of an AnyEvent::MP network. |
115 | |
113 | |
116 | Seed nodes are expected to be long-running, and at least one seed node |
114 | Seed nodes are expected to be long-running, and at least one seed node |
117 | should always be available. |
115 | should always be available. They should also be relatively responsive - a |
|
|
116 | seed node that blocks for long periods will slow down everybody else. |
118 | |
117 | |
119 | =item seeds - C<host:port> |
118 | =item seeds - C<host:port> |
120 | |
119 | |
121 | Seeds are transport endpoint(s) (usually a hostname/IP address and a |
120 | Seeds are transport endpoint(s) (usually a hostname/IP address and a |
122 | TCP port) of nodes thta should be used as seed nodes. |
121 | TCP port) of nodes thta should be used as seed nodes. |
… | |
… | |
149 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
148 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
150 | |
149 | |
151 | our @EXPORT = qw( |
150 | our @EXPORT = qw( |
152 | NODE $NODE *SELF node_of after |
151 | NODE $NODE *SELF node_of after |
153 | configure |
152 | configure |
154 | snd rcv mon mon_guard kil reg psub spawn |
153 | snd rcv mon mon_guard kil reg psub spawn cal |
155 | port |
154 | port |
156 | ); |
155 | ); |
157 | |
156 | |
158 | our $SELF; |
157 | our $SELF; |
159 | |
158 | |
… | |
… | |
228 | L<AnyEvent::MP::Global> module, which will then use it to keep |
227 | L<AnyEvent::MP::Global> module, which will then use it to keep |
229 | connectivity with at least one node at any point in time. |
228 | connectivity with at least one node at any point in time. |
230 | |
229 | |
231 | =back |
230 | =back |
232 | |
231 | |
233 | Example: become a distributed node using the locla node name as profile. |
232 | Example: become a distributed node using the local node name as profile. |
234 | This should be the most common form of invocation for "daemon"-type nodes. |
233 | This should be the most common form of invocation for "daemon"-type nodes. |
235 | |
234 | |
236 | configure |
235 | configure |
237 | |
236 | |
238 | Example: become an anonymous node. This form is often used for commandline |
237 | Example: become an anonymous node. This form is often used for commandline |
… | |
… | |
714 | ? $action[0]() |
713 | ? $action[0]() |
715 | : snd @action; |
714 | : snd @action; |
716 | }; |
715 | }; |
717 | } |
716 | } |
718 | |
717 | |
|
|
718 | =item cal $port, @msg, $callback[, $timeout] |
|
|
719 | |
|
|
720 | A simple form of RPC - sends a message to the given C<$port> with the |
|
|
721 | given contents (C<@msg>), but adds a reply port to the message. |
|
|
722 | |
|
|
723 | The reply port is created temporarily just for the purpose of receiving |
|
|
724 | the reply, and will be C<kil>ed when no longer needed. |
|
|
725 | |
|
|
726 | A reply message sent to the port is passed to the C<$callback> as-is. |
|
|
727 | |
|
|
728 | If an optional time-out (in seconds) is given and it is not C<undef>, |
|
|
729 | then the callback will be called without any arguments after the time-out |
|
|
730 | elapsed and the port is C<kil>ed. |
|
|
731 | |
|
|
732 | If no time-out is given, then the local port will monitor the remote port |
|
|
733 | instead, so it eventually gets cleaned-up. |
|
|
734 | |
|
|
735 | Currently this function returns the temporary port, but this "feature" |
|
|
736 | might go in future versions unless you can make a convincing case that |
|
|
737 | this is indeed useful for something. |
|
|
738 | |
|
|
739 | =cut |
|
|
740 | |
|
|
741 | sub cal(@) { |
|
|
742 | my $timeout = ref $_[-1] ? undef : pop; |
|
|
743 | my $cb = pop; |
|
|
744 | |
|
|
745 | my $port = port { |
|
|
746 | undef $timeout; |
|
|
747 | kil $SELF; |
|
|
748 | &$cb; |
|
|
749 | }; |
|
|
750 | |
|
|
751 | if (defined $timeout) { |
|
|
752 | $timeout = AE::timer $timeout, 0, sub { |
|
|
753 | undef $timeout; |
|
|
754 | kil $port; |
|
|
755 | $cb->(); |
|
|
756 | }; |
|
|
757 | } else { |
|
|
758 | mon $_[0], sub { |
|
|
759 | kil $port; |
|
|
760 | $cb->(); |
|
|
761 | }; |
|
|
762 | } |
|
|
763 | |
|
|
764 | push @_, $port; |
|
|
765 | &snd; |
|
|
766 | |
|
|
767 | $port |
|
|
768 | } |
|
|
769 | |
719 | =back |
770 | =back |
720 | |
771 | |
721 | =head1 AnyEvent::MP vs. Distributed Erlang |
772 | =head1 AnyEvent::MP vs. Distributed Erlang |
722 | |
773 | |
723 | AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node |
774 | AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node |