| … | |
… | |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | use AnyEvent::MP; |
7 | use AnyEvent::MP; |
| 8 | |
8 | |
| 9 | $NODE # contains this node's noderef |
9 | $NODE # contains this node's node ID |
| 10 | NODE # returns this node's noderef |
10 | NODE # returns this node's node ID |
| 11 | NODE $port # returns the noderef of the port |
|
|
| 12 | |
11 | |
| 13 | $SELF # receiving/own port id in rcv callbacks |
12 | $SELF # receiving/own port id in rcv callbacks |
| 14 | |
13 | |
| 15 | # initialise the node so it can send/receive messages |
14 | # initialise the node so it can send/receive messages |
| 16 | initialise_node; |
15 | configure; |
| 17 | |
16 | |
| 18 | # ports are message endpoints |
17 | # ports are message destinations |
| 19 | |
18 | |
| 20 | # sending messages |
19 | # sending messages |
| 21 | snd $port, type => data...; |
20 | snd $port, type => data...; |
| 22 | snd $port, @msg; |
21 | snd $port, @msg; |
| 23 | snd @msg_with_first_element_being_a_port; |
22 | snd @msg_with_first_element_being_a_port; |
| 24 | |
23 | |
| 25 | # creating/using ports, the simple way |
24 | # creating/using ports, the simple way |
| 26 | my $simple_port = port { my @msg = @_; 0 }; |
25 | my $simple_port = port { my @msg = @_ }; |
| 27 | |
26 | |
| 28 | # creating/using ports, tagged message matching |
27 | # creating/using ports, tagged message matching |
| 29 | my $port = port; |
28 | my $port = port; |
| 30 | rcv $port, ping => sub { snd $_[0], "pong"; 0 }; |
29 | rcv $port, ping => sub { snd $_[0], "pong" }; |
| 31 | rcv $port, pong => sub { warn "pong received\n"; 0 }; |
30 | rcv $port, pong => sub { warn "pong received\n" }; |
| 32 | |
31 | |
| 33 | # create a port on another node |
32 | # create a port on another node |
| 34 | my $port = spawn $node, $initfunc, @initdata; |
33 | my $port = spawn $node, $initfunc, @initdata; |
| 35 | |
34 | |
| 36 | # monitoring |
35 | # monitoring |
| … | |
… | |
| 38 | mon $port, $otherport # kill otherport on abnormal death |
37 | mon $port, $otherport # kill otherport on abnormal death |
| 39 | mon $port, $otherport, @msg # send message on death |
38 | mon $port, $otherport, @msg # send message on death |
| 40 | |
39 | |
| 41 | =head1 CURRENT STATUS |
40 | =head1 CURRENT STATUS |
| 42 | |
41 | |
|
|
42 | bin/aemp - stable. |
| 43 | AnyEvent::MP - stable API, should work |
43 | AnyEvent::MP - stable API, should work. |
| 44 | AnyEvent::MP::Intro - outdated |
44 | AnyEvent::MP::Intro - epxlains most concepts. |
| 45 | AnyEvent::MP::Kernel - mostly stable |
45 | AnyEvent::MP::Kernel - mostly stable. |
| 46 | AnyEvent::MP::Global - mostly stable |
46 | AnyEvent::MP::Global - stable API, protocol not yet final. |
| 47 | AnyEvent::MP::Node - mostly stable, but internal anyways |
|
|
| 48 | AnyEvent::MP::Transport - mostly stable, but internal anyways |
|
|
| 49 | |
47 | |
| 50 | stay tuned. |
48 | stay tuned. |
| 51 | |
49 | |
| 52 | =head1 DESCRIPTION |
50 | =head1 DESCRIPTION |
| 53 | |
51 | |
| … | |
… | |
| 56 | Despite its simplicity, you can securely message other processes running |
54 | Despite its simplicity, you can securely message other processes running |
| 57 | 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. |
| 58 | |
56 | |
| 59 | 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> |
| 60 | manual page and the examples under F<eg/>. |
58 | manual page and the examples under F<eg/>. |
| 61 | |
|
|
| 62 | At the moment, this module family is a bit underdocumented. |
|
|
| 63 | |
59 | |
| 64 | =head1 CONCEPTS |
60 | =head1 CONCEPTS |
| 65 | |
61 | |
| 66 | =over 4 |
62 | =over 4 |
| 67 | |
63 | |
| … | |
… | |
| 139 | |
135 | |
| 140 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
136 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
| 141 | |
137 | |
| 142 | our @EXPORT = qw( |
138 | our @EXPORT = qw( |
| 143 | NODE $NODE *SELF node_of after |
139 | NODE $NODE *SELF node_of after |
| 144 | initialise_node |
140 | configure |
| 145 | snd rcv mon mon_guard kil reg psub spawn |
141 | snd rcv mon mon_guard kil reg psub spawn |
| 146 | port |
142 | port |
| 147 | ); |
143 | ); |
| 148 | |
144 | |
| 149 | our $SELF; |
145 | our $SELF; |
| … | |
… | |
| 156 | |
152 | |
| 157 | =item $thisnode = NODE / $NODE |
153 | =item $thisnode = NODE / $NODE |
| 158 | |
154 | |
| 159 | The C<NODE> function returns, and the C<$NODE> variable contains, the node |
155 | The C<NODE> function returns, and the C<$NODE> variable contains, the node |
| 160 | ID of the node running in the current process. This value is initialised by |
156 | ID of the node running in the current process. This value is initialised by |
| 161 | a call to C<initialise_node>. |
157 | a call to C<configure>. |
| 162 | |
158 | |
| 163 | =item $nodeid = node_of $port |
159 | =item $nodeid = node_of $port |
| 164 | |
160 | |
| 165 | Extracts and returns the node ID from a port ID or a node ID. |
161 | Extracts and returns the node ID from a port ID or a node ID. |
| 166 | |
162 | |
| 167 | =item initialise_node $profile_name, key => value... |
163 | =item configure key => value... |
| 168 | |
164 | |
| 169 | Before a node can talk to other nodes on the network (i.e. enter |
165 | Before a node can talk to other nodes on the network (i.e. enter |
| 170 | "distributed mode") it has to initialise itself - the minimum a node needs |
166 | "distributed mode") it has to configure itself - the minimum a node needs |
| 171 | to know is its own name, and optionally it should know the addresses of |
167 | to know is its own name, and optionally it should know the addresses of |
| 172 | some other nodes in the network to discover other nodes. |
168 | some other nodes in the network to discover other nodes. |
| 173 | |
169 | |
| 174 | This function initialises a node - it must be called exactly once (or |
170 | This function configures a node - it must be called exactly once (or |
| 175 | never) before calling other AnyEvent::MP functions. |
171 | never) before calling other AnyEvent::MP functions. |
| 176 | |
172 | |
| 177 | The first argument is a profile name. If it is C<undef> or missing, then |
173 | =over 4 |
| 178 | the current nodename will be used instead (i.e. F<uname -n>). |
|
|
| 179 | |
174 | |
|
|
175 | =item step 1, gathering configuration from profiles |
|
|
176 | |
| 180 | The function first looks up the profile in the aemp configuration (see the |
177 | The function first looks up a profile in the aemp configuration (see the |
| 181 | L<aemp> commandline utility). the profile is calculated as follows: |
178 | L<aemp> commandline utility). The profile name can be specified via the |
|
|
179 | named C<profile> parameter. If it is missing, then the nodename (F<uname |
|
|
180 | -n>) will be used as profile name. |
| 182 | |
181 | |
| 183 | First, all remaining key => value pairs will be used. Then they will be |
182 | The profile data is then gathered as follows: |
| 184 | overwritten by any values specified in the global default configuration |
183 | |
| 185 | (see the F<aemp> utility), then the chain of profiles selected, if |
184 | First, all remaining key => value pairs (all of which are conviniently |
|
|
185 | undocumented at the moment) will be interpreted as configuration |
|
|
186 | data. Then they will be overwritten by any values specified in the global |
|
|
187 | default configuration (see the F<aemp> utility), then the chain of |
|
|
188 | profiles chosen by the profile name (and any C<parent> attributes). |
|
|
189 | |
| 186 | any. That means that the values specified in the profile have highest |
190 | That means that the values specified in the profile have highest priority |
| 187 | priority and the values specified via C<initialise_node> have lowest |
191 | and the values specified directly via C<configure> have lowest priority, |
| 188 | priority. |
192 | and can only be used to specify defaults. |
| 189 | |
193 | |
| 190 | If the profile specifies a node ID, then this will become the node ID of |
194 | If the profile specifies a node ID, then this will become the node ID of |
| 191 | this process. If not, then the profile name will be used as node ID. The |
195 | this process. If not, then the profile name will be used as node ID. The |
| 192 | special node ID of C<anon/> will be replaced by a random node ID. |
196 | special node ID of C<anon/> will be replaced by a random node ID. |
|
|
197 | |
|
|
198 | =item step 2, bind listener sockets |
| 193 | |
199 | |
| 194 | The next step is to look up the binds in the profile, followed by binding |
200 | The next step is to look up the binds in the profile, followed by binding |
| 195 | aemp protocol listeners on all binds specified (it is possible and valid |
201 | aemp protocol listeners on all binds specified (it is possible and valid |
| 196 | to have no binds, meaning that the node cannot be contacted form the |
202 | to have no binds, meaning that the node cannot be contacted form the |
| 197 | outside. This means the node cannot talk to other nodes that also have no |
203 | outside. This means the node cannot talk to other nodes that also have no |
| 198 | binds, but it can still talk to all "normal" nodes). |
204 | binds, but it can still talk to all "normal" nodes). |
| 199 | |
205 | |
| 200 | If the profile does not specify a binds list, then the node ID will be |
206 | If the profile does not specify a binds list, then a default of C<*> is |
| 201 | treated as if it were of the form C<host:port>, which will be resolved and |
207 | used, meaning the node will bind on a dynamically-assigned port on every |
| 202 | used as binds list. |
208 | local IP address it finds. |
| 203 | |
209 | |
|
|
210 | =item step 3, connect to seed nodes |
|
|
211 | |
| 204 | Lastly, the seeds list from the profile is passed to the |
212 | As the last step, the seeds list from the profile is passed to the |
| 205 | L<AnyEvent::MP::Global> module, which will then use it to keep |
213 | L<AnyEvent::MP::Global> module, which will then use it to keep |
| 206 | connectivity with at least on of those seed nodes at any point in time. |
214 | connectivity with at least one node at any point in time. |
| 207 | |
215 | |
| 208 | Example: become a distributed node listening on the guessed noderef, or |
216 | =back |
| 209 | the one specified via C<aemp> for the current node. This should be the |
217 | |
|
|
218 | Example: become a distributed node using the locla node name as profile. |
| 210 | most common form of invocation for "daemon"-type nodes. |
219 | This should be the most common form of invocation for "daemon"-type nodes. |
| 211 | |
220 | |
| 212 | initialise_node; |
221 | configure |
| 213 | |
222 | |
| 214 | Example: become an anonymous node. This form is often used for commandline |
223 | Example: become an anonymous node. This form is often used for commandline |
| 215 | clients. |
224 | clients. |
| 216 | |
225 | |
| 217 | initialise_node "anon/"; |
226 | configure nodeid => "anon/"; |
| 218 | |
227 | |
| 219 | Example: become a distributed node. If there is no profile of the given |
228 | Example: configure a node using a profile called seed, which si suitable |
| 220 | name, or no binds list was specified, resolve C<localhost:4044> and bind |
229 | for a seed node as it binds on all local addresses on a fixed port (4040, |
| 221 | on the resulting addresses. |
230 | customary for aemp). |
| 222 | |
231 | |
| 223 | initialise_node "localhost:4044"; |
232 | # use the aemp commandline utility |
|
|
233 | # aemp profile seed nodeid anon/ binds '*:4040' |
|
|
234 | |
|
|
235 | # then use it |
|
|
236 | configure profile => "seed"; |
|
|
237 | |
|
|
238 | # or simply use aemp from the shell again: |
|
|
239 | # aemp run profile seed |
|
|
240 | |
|
|
241 | # or provide a nicer-to-remember nodeid |
|
|
242 | # aemp run profile seed nodeid "$(hostname)" |
| 224 | |
243 | |
| 225 | =item $SELF |
244 | =item $SELF |
| 226 | |
245 | |
| 227 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
246 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
| 228 | blocks. |
247 | blocks. |
| … | |
… | |
| 350 | |
369 | |
| 351 | =cut |
370 | =cut |
| 352 | |
371 | |
| 353 | sub rcv($@) { |
372 | sub rcv($@) { |
| 354 | my $port = shift; |
373 | my $port = shift; |
| 355 | my ($noderef, $portid) = split /#/, $port, 2; |
374 | my ($nodeid, $portid) = split /#/, $port, 2; |
| 356 | |
375 | |
| 357 | $NODE{$noderef} == $NODE{""} |
376 | $NODE{$nodeid} == $NODE{""} |
| 358 | or Carp::croak "$port: rcv can only be called on local ports, caught"; |
377 | or Carp::croak "$port: rcv can only be called on local ports, caught"; |
| 359 | |
378 | |
| 360 | while (@_) { |
379 | while (@_) { |
| 361 | if (ref $_[0]) { |
380 | if (ref $_[0]) { |
| 362 | if (my $self = $PORT_DATA{$portid}) { |
381 | if (my $self = $PORT_DATA{$portid}) { |
| … | |
… | |
| 502 | mon $port, $self => "restart"; |
521 | mon $port, $self => "restart"; |
| 503 | |
522 | |
| 504 | =cut |
523 | =cut |
| 505 | |
524 | |
| 506 | sub mon { |
525 | sub mon { |
| 507 | my ($noderef, $port) = split /#/, shift, 2; |
526 | my ($nodeid, $port) = split /#/, shift, 2; |
| 508 | |
527 | |
| 509 | my $node = $NODE{$noderef} || add_node $noderef; |
528 | my $node = $NODE{$nodeid} || add_node $nodeid; |
| 510 | |
529 | |
| 511 | my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,'; |
530 | my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,'; |
| 512 | |
531 | |
| 513 | unless (ref $cb) { |
532 | unless (ref $cb) { |
| 514 | if (@_) { |
533 | if (@_) { |
| … | |
… | |
| 628 | }; |
647 | }; |
| 629 | _self_die if $@; |
648 | _self_die if $@; |
| 630 | } |
649 | } |
| 631 | |
650 | |
| 632 | sub spawn(@) { |
651 | sub spawn(@) { |
| 633 | my ($noderef, undef) = split /#/, shift, 2; |
652 | my ($nodeid, undef) = split /#/, shift, 2; |
| 634 | |
653 | |
| 635 | my $id = "$RUNIQ." . $ID++; |
654 | my $id = "$RUNIQ." . $ID++; |
| 636 | |
655 | |
| 637 | $_[0] =~ /::/ |
656 | $_[0] =~ /::/ |
| 638 | or Carp::croak "spawn init function must be a fully-qualified name, caught"; |
657 | or Carp::croak "spawn init function must be a fully-qualified name, caught"; |
| 639 | |
658 | |
| 640 | snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_; |
659 | snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_; |
| 641 | |
660 | |
| 642 | "$noderef#$id" |
661 | "$nodeid#$id" |
| 643 | } |
662 | } |
| 644 | |
663 | |
| 645 | =item after $timeout, @msg |
664 | =item after $timeout, @msg |
| 646 | |
665 | |
| 647 | =item after $timeout, $callback |
666 | =item after $timeout, $callback |
