… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent::MP; |
7 | use AnyEvent::MP; |
8 | |
8 | |
9 | NODE # returns this node identifier |
|
|
10 | $NODE # contains this node identifier |
9 | $NODE # contains this node's noderef |
|
|
10 | NODE # returns this node's noderef |
|
|
11 | NODE $port # returns the noderef of the port |
11 | |
12 | |
12 | snd $port, type => data...; |
13 | snd $port, type => data...; |
|
|
14 | |
|
|
15 | $SELF # receiving/own port id in rcv callbacks |
13 | |
16 | |
14 | rcv $port, smartmatch => $cb->($port, @msg); |
17 | rcv $port, smartmatch => $cb->($port, @msg); |
15 | |
18 | |
16 | # examples: |
19 | # examples: |
17 | rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; |
20 | rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; |
… | |
… | |
27 | This module (-family) implements a simple message passing framework. |
30 | This module (-family) implements a simple message passing framework. |
28 | |
31 | |
29 | Despite its simplicity, you can securely message other processes running |
32 | Despite its simplicity, you can securely message other processes running |
30 | on the same or other hosts. |
33 | on the same or other hosts. |
31 | |
34 | |
|
|
35 | For an introduction to this module family, see the L<AnyEvent::MP::Intro> |
|
|
36 | manual page. |
|
|
37 | |
32 | At the moment, this module family is severly brokena nd underdocumented, |
38 | At the moment, this module family is severly broken and underdocumented, |
33 | so do not use. This was uploaded mainly to resreve the CPAN namespace - |
39 | so do not use. This was uploaded mainly to reserve the CPAN namespace - |
34 | stay tuned! |
40 | stay tuned! The basic API should be finished, however. |
35 | |
41 | |
36 | =head1 CONCEPTS |
42 | =head1 CONCEPTS |
37 | |
43 | |
38 | =over 4 |
44 | =over 4 |
39 | |
45 | |
40 | =item port |
46 | =item port |
41 | |
47 | |
42 | A port is something you can send messages to with the C<snd> function, and |
48 | A port is something you can send messages to (with the C<snd> function). |
43 | you can register C<rcv> handlers with. All C<rcv> handlers will receive |
49 | |
44 | messages they match, messages will not be queued. |
50 | Some ports allow you to register C<rcv> handlers that can match specific |
|
|
51 | messages. All C<rcv> handlers will receive messages they match, messages |
|
|
52 | will not be queued. |
45 | |
53 | |
46 | =item port id - C<noderef#portname> |
54 | =item port id - C<noderef#portname> |
47 | |
55 | |
48 | A port id is always the noderef, a hash-mark (C<#>) as separator, followed |
56 | A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as |
49 | by a port name (a printable string of unspecified format). |
57 | separator, and a port name (a printable string of unspecified format). An |
|
|
58 | exception is the the node port, whose ID is identical to it's node |
|
|
59 | reference. |
50 | |
60 | |
51 | =item node |
61 | =item node |
52 | |
62 | |
53 | A node is a single process containing at least one port - the node |
63 | A node is a single process containing at least one port - the node |
54 | port. You can send messages to node ports to let them create new ports, |
64 | port. You can send messages to node ports to find existing ports or to |
55 | among other things. |
65 | create new ports, among other things. |
56 | |
66 | |
57 | Initially, nodes are either private (single-process only) or hidden |
67 | Nodes are either private (single-process only), slaves (connected to a |
58 | (connected to a master node only). Only when they epxlicitly "become |
68 | master node only) or public nodes (connectable from unrelated nodes). |
59 | public" can you send them messages from unrelated other nodes. |
|
|
60 | |
69 | |
61 | =item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> |
70 | =item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> |
62 | |
71 | |
63 | A noderef is a string that either uniquely identifies a given node (for |
72 | A node reference is a string that either simply identifies the node (for |
64 | private and hidden nodes), or contains a recipe on how to reach a given |
73 | private and slave nodes), or contains a recipe on how to reach a given |
65 | node (for public nodes). |
74 | node (for public nodes). |
66 | |
75 | |
|
|
76 | This recipe is simply a comma-separated list of C<address:port> pairs (for |
|
|
77 | TCP/IP, other protocols might look different). |
|
|
78 | |
|
|
79 | Node references come in two flavours: resolved (containing only numerical |
|
|
80 | addresses) or unresolved (where hostnames are used instead of addresses). |
|
|
81 | |
|
|
82 | Before using an unresolved node reference in a message you first have to |
|
|
83 | resolve it. |
|
|
84 | |
67 | =back |
85 | =back |
68 | |
86 | |
69 | =head1 VARIABLES/FUNCTIONS |
87 | =head1 VARIABLES/FUNCTIONS |
70 | |
88 | |
71 | =over 4 |
89 | =over 4 |
72 | |
90 | |
73 | =cut |
91 | =cut |
74 | |
92 | |
75 | package AnyEvent::MP; |
93 | package AnyEvent::MP; |
76 | |
94 | |
77 | use AnyEvent::MP::Util (); |
|
|
78 | use AnyEvent::MP::Node; |
95 | use AnyEvent::MP::Base; |
79 | use AnyEvent::MP::Transport; |
|
|
80 | |
96 | |
81 | use utf8; |
|
|
82 | use common::sense; |
97 | use common::sense; |
83 | |
98 | |
84 | use Carp (); |
99 | use Carp (); |
85 | |
100 | |
86 | use AE (); |
101 | use AE (); |
87 | |
102 | |
88 | use base "Exporter"; |
103 | use base "Exporter"; |
89 | |
104 | |
90 | our $VERSION = '0.01'; |
105 | our $VERSION = '0.1'; |
91 | our @EXPORT = qw(NODE $NODE $PORT snd rcv _any_); |
106 | our @EXPORT = qw( |
|
|
107 | NODE $NODE *SELF node_of _any_ |
|
|
108 | resolve_node |
|
|
109 | become_slave become_public |
|
|
110 | snd rcv mon kil reg psub |
|
|
111 | port |
|
|
112 | ); |
92 | |
113 | |
93 | our $DEFAULT_SECRET; |
114 | our $SELF; |
94 | our $DEFAULT_PORT = "4040"; |
|
|
95 | |
115 | |
96 | our $CONNECT_INTERVAL = 5; # new connect every 5s, at least |
116 | sub _self_die() { |
97 | our $CONNECT_TIMEOUT = 30; # includes handshake |
117 | my $msg = $@; |
98 | |
118 | $msg =~ s/\n+$// unless ref $msg; |
99 | sub default_secret { |
119 | kil $SELF, die => $msg; |
100 | unless (defined $DEFAULT_SECRET) { |
|
|
101 | if (open my $fh, "<$ENV{HOME}/.aemp-secret") { |
|
|
102 | sysread $fh, $DEFAULT_SECRET, -s $fh; |
|
|
103 | } else { |
|
|
104 | $DEFAULT_SECRET = AnyEvent::MP::Util::nonce 32; |
|
|
105 | } |
|
|
106 | } |
|
|
107 | |
|
|
108 | $DEFAULT_SECRET |
|
|
109 | } |
120 | } |
110 | |
121 | |
111 | =item NODE / $NODE |
122 | =item $thisnode = NODE / $NODE |
112 | |
123 | |
113 | The C<NODE ()> function and the C<$NODE> variable contain the noderef of |
124 | The C<NODE> function returns, and the C<$NODE> variable contains |
114 | the local node. The value is initialised by a call to C<become_public> or |
125 | the noderef of the local node. The value is initialised by a call |
115 | C<become_slave>, after which all local port identifiers become invalid. |
126 | to C<become_public> or C<become_slave>, after which all local port |
|
|
127 | identifiers become invalid. |
116 | |
128 | |
117 | =cut |
129 | =item $noderef = node_of $portid |
118 | |
130 | |
119 | our $UNIQ = sprintf "%x.%x", $$, time; # per-process/node unique cookie |
131 | Extracts and returns the noderef from a portid or a noderef. |
120 | our $ID = "a0"; |
|
|
121 | our $PUBLIC = 0; |
|
|
122 | our $NODE; |
|
|
123 | our $PORT; |
|
|
124 | |
132 | |
125 | our %NODE; # node id to transport mapping, or "undef", for local node |
133 | =item $cv = resolve_node $noderef |
126 | our %PORT; # local ports |
|
|
127 | our %LISTENER; # local transports |
|
|
128 | |
134 | |
129 | sub NODE() { $NODE } |
135 | Takes an unresolved node reference that may contain hostnames and |
|
|
136 | abbreviated IDs, resolves all of them and returns a resolved node |
|
|
137 | reference. |
130 | |
138 | |
131 | { |
139 | In addition to C<address:port> pairs allowed in resolved noderefs, the |
132 | use POSIX (); |
140 | following forms are supported: |
133 | my $nodename = (POSIX::uname)[1]; |
|
|
134 | $NODE = "$$\@$nodename"; |
|
|
135 | } |
|
|
136 | |
141 | |
137 | sub _ANY_() { 1 } |
142 | =over 4 |
138 | sub _any_() { \&_ANY_ } |
|
|
139 | |
143 | |
140 | sub add_node { |
144 | =item the empty string |
141 | my ($noderef) = @_; |
|
|
142 | |
145 | |
143 | return $NODE{$noderef} |
146 | An empty-string component gets resolved as if the default port (4040) was |
144 | if exists $NODE{$noderef}; |
147 | specified. |
145 | |
148 | |
146 | for (split /,/, $noderef) { |
149 | =item naked port numbers (e.g. C<1234>) |
147 | return $NODE{$noderef} = $NODE{$_} |
|
|
148 | if exists $NODE{$_}; |
|
|
149 | } |
|
|
150 | |
150 | |
151 | # for indirect sends, use a different class |
151 | These are resolved by prepending the local nodename and a colon, to be |
152 | my $node = new AnyEvent::MP::Node::Direct $noderef; |
152 | further resolved. |
153 | |
153 | |
154 | $NODE{$_} = $node |
154 | =item hostnames (e.g. C<localhost:1234>, C<localhost>) |
155 | for $noderef, split /,/, $noderef; |
|
|
156 | |
155 | |
157 | $node |
156 | These are resolved by using AnyEvent::DNS to resolve them, optionally |
158 | } |
157 | looking up SRV records for the C<aemp=4040> port, if no port was |
|
|
158 | specified. |
|
|
159 | |
|
|
160 | =back |
|
|
161 | |
|
|
162 | =item $SELF |
|
|
163 | |
|
|
164 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
|
|
165 | blocks. |
|
|
166 | |
|
|
167 | =item SELF, %SELF, @SELF... |
|
|
168 | |
|
|
169 | Due to some quirks in how perl exports variables, it is impossible to |
|
|
170 | just export C<$SELF>, all the symbols called C<SELF> are exported by this |
|
|
171 | module, but only C<$SELF> is currently used. |
159 | |
172 | |
160 | =item snd $portid, type => @data |
173 | =item snd $portid, type => @data |
161 | |
174 | |
162 | =item snd $portid, @msg |
175 | =item snd $portid, @msg |
163 | |
176 | |
164 | Send the given message to the given port ID, which can identify either a |
177 | Send the given message to the given port ID, which can identify either |
165 | local or a remote port. |
178 | a local or a remote port, and can be either a string or soemthignt hat |
|
|
179 | stringifies a sa port ID (such as a port object :). |
166 | |
180 | |
167 | While the message can be about anything, it is highly recommended to use |
181 | While the message can be about anything, it is highly recommended to use a |
168 | a constant string as first element. |
182 | string as first element (a portid, or some word that indicates a request |
|
|
183 | type etc.). |
169 | |
184 | |
170 | The message data effectively becomes read-only after a call to this |
185 | The message data effectively becomes read-only after a call to this |
171 | function: modifying any argument is not allowed and can cause many |
186 | function: modifying any argument is not allowed and can cause many |
172 | problems. |
187 | problems. |
173 | |
188 | |
… | |
… | |
175 | JSON is used, then only strings, numbers and arrays and hashes consisting |
190 | JSON is used, then only strings, numbers and arrays and hashes consisting |
176 | of those are allowed (no objects). When Storable is used, then anything |
191 | of those are allowed (no objects). When Storable is used, then anything |
177 | that Storable can serialise and deserialise is allowed, and for the local |
192 | that Storable can serialise and deserialise is allowed, and for the local |
178 | node, anything can be passed. |
193 | node, anything can be passed. |
179 | |
194 | |
180 | =cut |
195 | =item kil $portid[, @reason] |
181 | |
196 | |
182 | sub snd(@) { |
197 | Kill the specified port with the given C<@reason>. |
|
|
198 | |
|
|
199 | If no C<@reason> is specified, then the port is killed "normally" (linked |
|
|
200 | ports will not be kileld, or even notified). |
|
|
201 | |
|
|
202 | Otherwise, linked ports get killed with the same reason (second form of |
|
|
203 | C<mon>, see below). |
|
|
204 | |
|
|
205 | Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks |
|
|
206 | will be reported as reason C<< die => $@ >>. |
|
|
207 | |
|
|
208 | Transport/communication errors are reported as C<< transport_error => |
|
|
209 | $message >>. |
|
|
210 | |
|
|
211 | =item $guard = mon $portid, $cb->(@reason) |
|
|
212 | |
|
|
213 | =item $guard = mon $portid, $otherport |
|
|
214 | |
|
|
215 | =item $guard = mon $portid, $otherport, @msg |
|
|
216 | |
|
|
217 | Monitor the given port and do something when the port is killed. |
|
|
218 | |
|
|
219 | In the first form, the callback is simply called with any number |
|
|
220 | of C<@reason> elements (no @reason means that the port was deleted |
|
|
221 | "normally"). Note also that I<< the callback B<must> never die >>, so use |
|
|
222 | C<eval> if unsure. |
|
|
223 | |
|
|
224 | In the second form, the other port will be C<kil>'ed with C<@reason>, iff |
|
|
225 | a @reason was specified, i.e. on "normal" kils nothing happens, while |
|
|
226 | under all other conditions, the other port is killed with the same reason. |
|
|
227 | |
|
|
228 | In the last form, a message of the form C<@msg, @reason> will be C<snd>. |
|
|
229 | |
|
|
230 | Example: call a given callback when C<$port> is killed. |
|
|
231 | |
|
|
232 | mon $port, sub { warn "port died because of <@_>\n" }; |
|
|
233 | |
|
|
234 | Example: kill ourselves when C<$port> is killed abnormally. |
|
|
235 | |
|
|
236 | mon $port, $self; |
|
|
237 | |
|
|
238 | Example: send us a restart message another C<$port> is killed. |
|
|
239 | |
|
|
240 | mon $port, $self => "restart"; |
|
|
241 | |
|
|
242 | =cut |
|
|
243 | |
|
|
244 | sub mon { |
183 | my ($noderef, $port) = split /#/, shift, 2; |
245 | my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift); |
184 | |
246 | |
185 | add_node $noderef |
247 | my $node = $NODE{$noderef} || add_node $noderef; |
186 | unless exists $NODE{$noderef}; |
|
|
187 | |
248 | |
188 | $NODE{$noderef}->send (["$port", [@_]]); |
249 | #TODO: ports must not be references |
|
|
250 | if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) { |
|
|
251 | if (@_) { |
|
|
252 | # send a kill info message |
|
|
253 | my (@msg) = ($cb, @_); |
|
|
254 | $cb = sub { snd @msg, @_ }; |
|
|
255 | } else { |
|
|
256 | # simply kill other port |
|
|
257 | my $port = $cb; |
|
|
258 | $cb = sub { kil $port, @_ if @_ }; |
|
|
259 | } |
|
|
260 | } |
|
|
261 | |
|
|
262 | $node->monitor ($port, $cb); |
|
|
263 | |
|
|
264 | defined wantarray |
|
|
265 | and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } |
189 | } |
266 | } |
190 | |
267 | |
|
|
268 | =item $guard = mon_guard $port, $ref, $ref... |
|
|
269 | |
|
|
270 | Monitors the given C<$port> and keeps the passed references. When the port |
|
|
271 | is killed, the references will be freed. |
|
|
272 | |
|
|
273 | Optionally returns a guard that will stop the monitoring. |
|
|
274 | |
|
|
275 | This function is useful when you create e.g. timers or other watchers and |
|
|
276 | want to free them when the port gets killed: |
|
|
277 | |
|
|
278 | $port->rcv (start => sub { |
|
|
279 | my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub { |
|
|
280 | undef $timer if 0.9 < rand; |
|
|
281 | }); |
|
|
282 | }); |
|
|
283 | |
|
|
284 | =cut |
|
|
285 | |
|
|
286 | sub mon_guard { |
|
|
287 | my ($port, @refs) = @_; |
|
|
288 | |
|
|
289 | mon $port, sub { 0 && @refs } |
|
|
290 | } |
|
|
291 | |
|
|
292 | =item lnk $port1, $port2 |
|
|
293 | |
|
|
294 | Link two ports. This is simply a shorthand for: |
|
|
295 | |
|
|
296 | mon $port1, $port2; |
|
|
297 | mon $port2, $port1; |
|
|
298 | |
|
|
299 | It means that if either one is killed abnormally, the other one gets |
|
|
300 | killed as well. |
|
|
301 | |
|
|
302 | =item $local_port = port |
|
|
303 | |
|
|
304 | Create a new local port object that supports message matching. |
|
|
305 | |
|
|
306 | =item $portid = port { my @msg = @_; $finished } |
|
|
307 | |
|
|
308 | Creates a "mini port", that is, a very lightweight port without any |
|
|
309 | pattern matching behind it, and returns its ID. |
|
|
310 | |
|
|
311 | The block will be called for every message received on the port. When the |
|
|
312 | callback returns a true value its job is considered "done" and the port |
|
|
313 | will be destroyed. Otherwise it will stay alive. |
|
|
314 | |
|
|
315 | The message will be passed as-is, no extra argument (i.e. no port id) will |
|
|
316 | be passed to the callback. |
|
|
317 | |
|
|
318 | If you need the local port id in the callback, this works nicely: |
|
|
319 | |
|
|
320 | my $port; $port = miniport { |
|
|
321 | snd $otherport, reply => $port; |
|
|
322 | }; |
|
|
323 | |
|
|
324 | =cut |
|
|
325 | |
|
|
326 | sub port(;&) { |
|
|
327 | my $id = "$UNIQ." . $ID++; |
|
|
328 | my $port = "$NODE#$id"; |
|
|
329 | |
|
|
330 | if (@_) { |
|
|
331 | my $cb = shift; |
|
|
332 | $PORT{$id} = sub { |
|
|
333 | local $SELF = $port; |
|
|
334 | eval { |
|
|
335 | &$cb |
|
|
336 | and kil $id; |
|
|
337 | }; |
|
|
338 | _self_die if $@; |
|
|
339 | }; |
|
|
340 | } else { |
|
|
341 | my $self = bless { |
|
|
342 | id => "$NODE#$id", |
|
|
343 | }, "AnyEvent::MP::Port"; |
|
|
344 | |
|
|
345 | $PORT_DATA{$id} = $self; |
|
|
346 | $PORT{$id} = sub { |
|
|
347 | local $SELF = $port; |
|
|
348 | |
|
|
349 | eval { |
|
|
350 | for (@{ $self->{rc0}{$_[0]} }) { |
|
|
351 | $_ && &{$_->[0]} |
|
|
352 | && undef $_; |
|
|
353 | } |
|
|
354 | |
|
|
355 | for (@{ $self->{rcv}{$_[0]} }) { |
|
|
356 | $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] |
|
|
357 | && &{$_->[0]} |
|
|
358 | && undef $_; |
|
|
359 | } |
|
|
360 | |
|
|
361 | for (@{ $self->{any} }) { |
|
|
362 | $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] |
|
|
363 | && &{$_->[0]} |
|
|
364 | && undef $_; |
|
|
365 | } |
|
|
366 | }; |
|
|
367 | _self_die if $@; |
|
|
368 | }; |
|
|
369 | } |
|
|
370 | |
|
|
371 | $port |
|
|
372 | } |
|
|
373 | |
|
|
374 | =item reg $portid, $name |
|
|
375 | |
|
|
376 | Registers the given port under the name C<$name>. If the name already |
|
|
377 | exists it is replaced. |
|
|
378 | |
|
|
379 | A port can only be registered under one well known name. |
|
|
380 | |
|
|
381 | A port automatically becomes unregistered when it is killed. |
|
|
382 | |
|
|
383 | =cut |
|
|
384 | |
|
|
385 | sub reg(@) { |
|
|
386 | my ($portid, $name) = @_; |
|
|
387 | |
|
|
388 | $REG{$name} = $portid; |
|
|
389 | } |
|
|
390 | |
191 | =item rcv $portid, type => $callback->(@msg) |
391 | =item rcv $portid, tagstring => $callback->(@msg), ... |
192 | |
392 | |
193 | =item rcv $portid, $smartmatch => $callback->(@msg) |
393 | =item rcv $portid, $smartmatch => $callback->(@msg), ... |
194 | |
394 | |
195 | =item rcv $portid, [$smartmatch...] => $callback->(@msg) |
395 | =item rcv $portid, [$smartmatch...] => $callback->(@msg), ... |
196 | |
396 | |
197 | Register a callback on the port identified by C<$portid>, which I<must> be |
397 | Register callbacks to be called on matching messages on the given port. |
198 | a local port. |
|
|
199 | |
398 | |
200 | The callback has to return a true value when its work is done, after |
399 | The callback has to return a true value when its work is done, after |
201 | which is will be removed, or a false value in which case it will stay |
400 | which is will be removed, or a false value in which case it will stay |
202 | registered. |
401 | registered. |
203 | |
402 | |
|
|
403 | The global C<$SELF> (exported by this module) contains C<$portid> while |
|
|
404 | executing the callback. |
|
|
405 | |
|
|
406 | Runtime errors wdurign callback execution will result in the port being |
|
|
407 | C<kil>ed. |
|
|
408 | |
204 | If the match is an array reference, then it will be matched against the |
409 | If the match is an array reference, then it will be matched against the |
205 | first elements of the message, otherwise only the first element is being |
410 | first elements of the message, otherwise only the first element is being |
206 | matched. |
411 | matched. |
207 | |
412 | |
208 | Any element in the match that is specified as C<_any_> (a function |
413 | Any element in the match that is specified as C<_any_> (a function |
… | |
… | |
213 | also the most efficient match (by far). |
418 | also the most efficient match (by far). |
214 | |
419 | |
215 | =cut |
420 | =cut |
216 | |
421 | |
217 | sub rcv($@) { |
422 | sub rcv($@) { |
218 | my ($port, $match, $cb) = @_; |
|
|
219 | |
|
|
220 | my $port = $PORT{$port} |
|
|
221 | or do { |
|
|
222 | my ($noderef, $lport) = split /#/, $port; |
423 | my ($noderef, $port) = split /#/, shift, 2; |
223 | "AnyEvent::MP::Node::Self" eq ref $NODE{$noderef} |
424 | |
|
|
425 | ($NODE{$noderef} || add_node $noderef) == $NODE{""} |
224 | or Carp::croak "$port: can only rcv on local ports"; |
426 | or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught"; |
225 | |
427 | |
226 | $PORT{$lport} |
428 | my $self = $PORT_DATA{$port} |
227 | or Carp::croak "$port: port does not exist"; |
429 | or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught"; |
228 | |
|
|
229 | $PORT{$port} = $PORT{$lport} # also return |
|
|
230 | }; |
|
|
231 | |
430 | |
|
|
431 | "AnyEvent::MP::Port" eq ref $self |
|
|
432 | or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught"; |
|
|
433 | |
|
|
434 | while (@_) { |
|
|
435 | my ($match, $cb) = splice @_, 0, 2; |
|
|
436 | |
232 | if (!ref $match) { |
437 | if (!ref $match) { |
233 | push @{ $port->{rc0}{$match} }, [$cb]; |
438 | push @{ $self->{rc0}{$match} }, [$cb]; |
234 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
439 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
235 | my ($type, @match) = @$match; |
440 | my ($type, @match) = @$match; |
236 | @match |
441 | @match |
237 | ? push @{ $port->{rcv}{$match->[0]} }, [$cb, \@match] |
442 | ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] |
238 | : push @{ $port->{rc0}{$match->[0]} }, [$cb]; |
443 | : push @{ $self->{rc0}{$match->[0]} }, [$cb]; |
239 | } else { |
444 | } else { |
240 | push @{ $port->{any} }, [$cb, $match]; |
445 | push @{ $self->{any} }, [$cb, $match]; |
|
|
446 | } |
241 | } |
447 | } |
242 | } |
448 | } |
243 | |
449 | |
244 | sub _inject { |
450 | =item $closure = psub { BLOCK } |
245 | my ($port, $msg) = @{+shift}; |
|
|
246 | |
451 | |
247 | $port = $PORT{$port} |
452 | Remembers C<$SELF> and creates a closure out of the BLOCK. When the |
248 | or return; |
453 | closure is executed, sets up the environment in the same way as in C<rcv> |
|
|
454 | callbacks, i.e. runtime errors will cause the port to get C<kil>ed. |
249 | |
455 | |
250 | @_ = @$msg; |
456 | This is useful when you register callbacks from C<rcv> callbacks: |
251 | |
457 | |
252 | for (@{ $port->{rc0}{$msg->[0]} }) { |
458 | rcv delayed_reply => sub { |
253 | $_ && &{$_->[0]} |
459 | my ($delay, @reply) = @_; |
254 | && undef $_; |
460 | my $timer = AE::timer $delay, 0, psub { |
|
|
461 | snd @reply, $SELF; |
|
|
462 | }; |
255 | } |
463 | }; |
256 | |
464 | |
257 | for (@{ $port->{rcv}{$msg->[0]} }) { |
465 | =cut |
258 | $_ && [@_[1..$#{$_->[1]}]] ~~ $_->[1] |
|
|
259 | && &{$_->[0]} |
|
|
260 | && undef $_; |
|
|
261 | } |
|
|
262 | |
466 | |
263 | for (@{ $port->{any} }) { |
467 | sub psub(&) { |
264 | $_ && [@_[0..$#{$_->[1]}]] ~~ $_->[1] |
468 | my $cb = shift; |
265 | && &{$_->[0]} |
469 | |
266 | && undef $_; |
470 | my $port = $SELF |
|
|
471 | or Carp::croak "psub can only be called from within rcv or psub callbacks, not"; |
|
|
472 | |
|
|
473 | sub { |
|
|
474 | local $SELF = $port; |
|
|
475 | |
|
|
476 | if (wantarray) { |
|
|
477 | my @res = eval { &$cb }; |
|
|
478 | _self_die if $@; |
|
|
479 | @res |
|
|
480 | } else { |
|
|
481 | my $res = eval { &$cb }; |
|
|
482 | _self_die if $@; |
|
|
483 | $res |
|
|
484 | } |
267 | } |
485 | } |
268 | } |
486 | } |
269 | |
487 | |
270 | sub normalise_noderef($) { |
488 | =back |
271 | my ($noderef) = @_; |
|
|
272 | |
489 | |
273 | my $cv = AE::cv; |
490 | =head1 FUNCTIONS FOR NODES |
274 | my @res; |
|
|
275 | |
491 | |
276 | $cv->begin (sub { |
492 | =over 4 |
277 | my %seen; |
|
|
278 | my @refs; |
|
|
279 | for (sort { $a->[0] <=> $b->[0] } @res) { |
|
|
280 | push @refs, $_->[1] unless $seen{$_->[1]}++ |
|
|
281 | } |
|
|
282 | shift->send (join ",", @refs); |
|
|
283 | }); |
|
|
284 | |
493 | |
285 | $noderef = $DEFAULT_PORT unless length $noderef; |
494 | =item become_public $noderef |
286 | |
495 | |
287 | my $idx; |
496 | Tells the node to become a public node, i.e. reachable from other nodes. |
288 | for my $t (split /,/, $noderef) { |
|
|
289 | my $pri = ++$idx; |
|
|
290 | |
|
|
291 | #TODO: this should be outside normalise_noderef and in become_public |
|
|
292 | if ($t =~ /^\d*$/) { |
|
|
293 | my $nodename = (POSIX::uname)[1]; |
|
|
294 | |
497 | |
295 | $cv->begin; |
498 | The first argument is the (unresolved) node reference of the local node |
296 | AnyEvent::Socket::resolve_sockaddr $nodename, $t || "aemp=$DEFAULT_PORT", "tcp", 0, undef, sub { |
499 | (if missing then the empty string is used). |
297 | for (@_) { |
|
|
298 | my ($service, $host) = AnyEvent::Socket::unpack_sockaddr $_->[3]; |
|
|
299 | push @res, [ |
|
|
300 | $pri += 1e-5, |
|
|
301 | AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $host, $service |
|
|
302 | ]; |
|
|
303 | } |
|
|
304 | $cv->end; |
|
|
305 | }; |
|
|
306 | |
500 | |
307 | # my (undef, undef, undef, undef, @ipv4) = gethostbyname $nodename; |
501 | It is quite common to not specify anything, in which case the local node |
308 | # |
502 | tries to listen on the default port, or to only specify a port number, in |
309 | # for (@ipv4) { |
503 | which case AnyEvent::MP tries to guess the local addresses. |
310 | # push @res, [ |
|
|
311 | # $pri, |
|
|
312 | # AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $_, $t || $DEFAULT_PORT, |
|
|
313 | # ]; |
|
|
314 | # } |
|
|
315 | } else { |
|
|
316 | my ($host, $port) = AnyEvent::Socket::parse_hostport $t, "aemp=$DEFAULT_PORT" |
|
|
317 | or Carp::croak "$t: unparsable transport descriptor"; |
|
|
318 | |
504 | |
319 | $cv->begin; |
505 | =cut |
320 | AnyEvent::Socket::resolve_sockaddr $host, $port, "tcp", 0, undef, sub { |
|
|
321 | for (@_) { |
|
|
322 | my ($service, $host) = AnyEvent::Socket::unpack_sockaddr $_->[3]; |
|
|
323 | push @res, [ |
|
|
324 | $pri += 1e-5, |
|
|
325 | AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $host, $service |
|
|
326 | ]; |
|
|
327 | } |
|
|
328 | $cv->end; |
|
|
329 | } |
|
|
330 | } |
|
|
331 | } |
|
|
332 | |
|
|
333 | $cv->end; |
|
|
334 | |
|
|
335 | $cv |
|
|
336 | } |
|
|
337 | |
|
|
338 | sub become_public { |
|
|
339 | return if $PUBLIC; |
|
|
340 | |
|
|
341 | my $noderef = join ",", ref $_[0] ? @{+shift} : shift; |
|
|
342 | my @args = @_; |
|
|
343 | |
|
|
344 | $NODE = (normalise_noderef $noderef)->recv; |
|
|
345 | |
|
|
346 | for my $t (split /,/, $NODE) { |
|
|
347 | $NODE{$t} = $NODE{""}; |
|
|
348 | |
|
|
349 | my ($host, $port) = AnyEvent::Socket::parse_hostport $t; |
|
|
350 | |
|
|
351 | $LISTENER{$t} = AnyEvent::MP::Transport::mp_server $host, $port, |
|
|
352 | @args, |
|
|
353 | on_error => sub { |
|
|
354 | die "on_error<@_>\n";#d# |
|
|
355 | }, |
|
|
356 | on_connect => sub { |
|
|
357 | my ($tp) = @_; |
|
|
358 | |
|
|
359 | $NODE{$tp->{remote_id}} = $_[0]; |
|
|
360 | }, |
|
|
361 | sub { |
|
|
362 | my ($tp) = @_; |
|
|
363 | |
|
|
364 | $NODE{"$tp->{peerhost}:$tp->{peerport}"} = $tp; |
|
|
365 | }, |
|
|
366 | ; |
|
|
367 | } |
|
|
368 | |
|
|
369 | $PUBLIC = 1; |
|
|
370 | } |
|
|
371 | |
506 | |
372 | =back |
507 | =back |
373 | |
508 | |
374 | =head1 NODE MESSAGES |
509 | =head1 NODE MESSAGES |
375 | |
510 | |
376 | Nodes understand the following messages sent to them. Many of them take |
511 | Nodes understand the following messages sent to them. Many of them take |
377 | arguments called C<@reply>, which will simply be used to compose a reply |
512 | arguments called C<@reply>, which will simply be used to compose a reply |
378 | message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and |
513 | message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and |
379 | the remaining arguments are simply the message data. |
514 | the remaining arguments are simply the message data. |
380 | |
515 | |
|
|
516 | While other messages exist, they are not public and subject to change. |
|
|
517 | |
381 | =over 4 |
518 | =over 4 |
382 | |
519 | |
383 | =cut |
520 | =cut |
384 | |
521 | |
385 | ############################################################################# |
522 | =item lookup => $name, @reply |
386 | # self node code |
|
|
387 | |
523 | |
388 | sub _new_port($) { |
524 | Replies with the port ID of the specified well-known port, or C<undef>. |
389 | my ($name) = @_; |
|
|
390 | |
|
|
391 | my ($noderef, $portname) = split /#/, $name; |
|
|
392 | |
|
|
393 | $PORT{$name} = |
|
|
394 | $PORT{$portname} = { |
|
|
395 | names => [$name, $portname], |
|
|
396 | }; |
|
|
397 | } |
|
|
398 | |
|
|
399 | $NODE{""} = new AnyEvent::MP::Node::Self noderef => $NODE; |
|
|
400 | _new_port ""; |
|
|
401 | |
525 | |
402 | =item devnull => ... |
526 | =item devnull => ... |
403 | |
527 | |
404 | Generic data sink/CPU heat conversion. |
528 | Generic data sink/CPU heat conversion. |
405 | |
529 | |
406 | =cut |
|
|
407 | |
|
|
408 | rcv "", devnull => sub { () }; |
|
|
409 | |
|
|
410 | =item relay => $port, @msg |
530 | =item relay => $port, @msg |
411 | |
531 | |
412 | Simply forwards the message to the given port. |
532 | Simply forwards the message to the given port. |
413 | |
|
|
414 | =cut |
|
|
415 | |
|
|
416 | rcv "", relay => sub { \&snd; () }; |
|
|
417 | |
533 | |
418 | =item eval => $string[ @reply] |
534 | =item eval => $string[ @reply] |
419 | |
535 | |
420 | Evaluates the given string. If C<@reply> is given, then a message of the |
536 | Evaluates the given string. If C<@reply> is given, then a message of the |
421 | form C<@reply, $@, @evalres> is sent. |
537 | form C<@reply, $@, @evalres> is sent. |
422 | |
538 | |
423 | Example: crash another node. |
539 | Example: crash another node. |
424 | |
540 | |
425 | snd $othernode, eval => "exit"; |
541 | snd $othernode, eval => "exit"; |
426 | |
542 | |
427 | =cut |
|
|
428 | |
|
|
429 | rcv "", eval => sub { |
|
|
430 | my (undef, $string, @reply) = @_; |
|
|
431 | my @res = eval $string; |
|
|
432 | snd @reply, "$@", @res if @reply; |
|
|
433 | () |
|
|
434 | }; |
|
|
435 | |
|
|
436 | =item time => @reply |
543 | =item time => @reply |
437 | |
544 | |
438 | Replies the the current node time to C<@reply>. |
545 | Replies the the current node time to C<@reply>. |
439 | |
546 | |
440 | Example: tell the current node to send the current time to C<$myport> in a |
547 | Example: tell the current node to send the current time to C<$myport> in a |
441 | C<timereply> message. |
548 | C<timereply> message. |
442 | |
549 | |
443 | snd $NODE, time => $myport, timereply => 1, 2; |
550 | snd $NODE, time => $myport, timereply => 1, 2; |
444 | # => snd $myport, timereply => 1, 2, <time> |
551 | # => snd $myport, timereply => 1, 2, <time> |
445 | |
552 | |
446 | =cut |
553 | =back |
447 | |
554 | |
448 | rcv "", time => sub { shift; snd @_, AE::time; () }; |
555 | =head1 AnyEvent::MP vs. Distributed Erlang |
|
|
556 | |
|
|
557 | AnyEvent::MP got lots of its ideas from distributed erlang (erlang node |
|
|
558 | == aemp node, erlang process == aemp port), so many of the documents and |
|
|
559 | programming techniques employed by erlang apply to AnyEvent::MP. Here is a |
|
|
560 | sample: |
|
|
561 | |
|
|
562 | http://www.erlang.se/doc/programming_rules.shtml |
|
|
563 | http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 |
|
|
564 | http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6 |
|
|
565 | http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 |
|
|
566 | |
|
|
567 | Despite the similarities, there are also some important differences: |
|
|
568 | |
|
|
569 | =over 4 |
|
|
570 | |
|
|
571 | =item * Node references contain the recipe on how to contact them. |
|
|
572 | |
|
|
573 | Erlang relies on special naming and DNS to work everywhere in the |
|
|
574 | same way. AEMP relies on each node knowing it's own address(es), with |
|
|
575 | convenience functionality. |
|
|
576 | |
|
|
577 | This means that AEMP requires a less tightly controlled environment at the |
|
|
578 | cost of longer node references and a slightly higher management overhead. |
|
|
579 | |
|
|
580 | =item * Erlang uses processes and a mailbox, AEMP does not queue. |
|
|
581 | |
|
|
582 | Erlang uses processes that selctively receive messages, and therefore |
|
|
583 | needs a queue. AEMP is event based, queuing messages would serve no useful |
|
|
584 | purpose. |
|
|
585 | |
|
|
586 | (But see L<Coro::MP> for a more erlang-like process model on top of AEMP). |
|
|
587 | |
|
|
588 | =item * Erlang sends are synchronous, AEMP sends are asynchronous. |
|
|
589 | |
|
|
590 | Sending messages in erlang is synchronous and blocks the process. AEMP |
|
|
591 | sends are immediate, connection establishment is handled in the |
|
|
592 | background. |
|
|
593 | |
|
|
594 | =item * Erlang can silently lose messages, AEMP cannot. |
|
|
595 | |
|
|
596 | Erlang makes few guarantees on messages delivery - messages can get lost |
|
|
597 | without any of the processes realising it (i.e. you send messages a, b, |
|
|
598 | and c, and the other side only receives messages a and c). |
|
|
599 | |
|
|
600 | AEMP guarantees correct ordering, and the guarantee that there are no |
|
|
601 | holes in the message sequence. |
|
|
602 | |
|
|
603 | =item * In erlang, processes can be declared dead and later be found to be |
|
|
604 | alive. |
|
|
605 | |
|
|
606 | In erlang it can happen that a monitored process is declared dead and |
|
|
607 | linked processes get killed, but later it turns out that the process is |
|
|
608 | still alive - and can receive messages. |
|
|
609 | |
|
|
610 | In AEMP, when port monitoring detects a port as dead, then that port will |
|
|
611 | eventually be killed - it cannot happen that a node detects a port as dead |
|
|
612 | and then later sends messages to it, finding it is still alive. |
|
|
613 | |
|
|
614 | =item * Erlang can send messages to the wrong port, AEMP does not. |
|
|
615 | |
|
|
616 | In erlang it is quite possible that a node that restarts reuses a process |
|
|
617 | ID known to other nodes for a completely different process, causing |
|
|
618 | messages destined for that process to end up in an unrelated process. |
|
|
619 | |
|
|
620 | AEMP never reuses port IDs, so old messages or old port IDs floating |
|
|
621 | around in the network will not be sent to an unrelated port. |
|
|
622 | |
|
|
623 | =item * Erlang uses unprotected connections, AEMP uses secure |
|
|
624 | authentication and can use TLS. |
|
|
625 | |
|
|
626 | AEMP can use a proven protocol - SSL/TLS - to protect connections and |
|
|
627 | securely authenticate nodes. |
|
|
628 | |
|
|
629 | =item * The AEMP protocol is optimised for both text-based and binary |
|
|
630 | communications. |
|
|
631 | |
|
|
632 | The AEMP protocol, unlike the erlang protocol, supports both |
|
|
633 | language-independent text-only protocols (good for debugging) and binary, |
|
|
634 | language-specific serialisers (e.g. Storable). |
|
|
635 | |
|
|
636 | It has also been carefully designed to be implementable in other languages |
|
|
637 | with a minimum of work while gracefully degrading fucntionality to make the |
|
|
638 | protocol simple. |
449 | |
639 | |
450 | =back |
640 | =back |
451 | |
641 | |
452 | =head1 SEE ALSO |
642 | =head1 SEE ALSO |
453 | |
643 | |