… | |
… | |
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 | |
… | |
… | |
84 | |
90 | |
85 | use base "Exporter"; |
91 | use base "Exporter"; |
86 | |
92 | |
87 | our $VERSION = '0.02'; |
93 | our $VERSION = '0.02'; |
88 | our @EXPORT = qw( |
94 | our @EXPORT = qw( |
89 | NODE $NODE $PORT snd rcv _any_ |
95 | NODE $NODE *SELF node_of _any_ |
90 | create_port create_port_on |
|
|
91 | create_miniport |
|
|
92 | become_slave become_public |
96 | become_slave become_public |
|
|
97 | snd rcv mon kil reg psub |
|
|
98 | port |
93 | ); |
99 | ); |
94 | |
100 | |
|
|
101 | our $SELF; |
|
|
102 | |
|
|
103 | sub _self_die() { |
|
|
104 | my $msg = $@; |
|
|
105 | $msg =~ s/\n+$// unless ref $msg; |
|
|
106 | kil $SELF, die => $msg; |
|
|
107 | } |
|
|
108 | |
95 | =item NODE / $NODE |
109 | =item $thisnode = NODE / $NODE |
96 | |
110 | |
97 | The C<NODE ()> function and the C<$NODE> variable contain the noderef of |
111 | The C<NODE> function returns, and the C<$NODE> variable contains |
98 | the local node. The value is initialised by a call to C<become_public> or |
112 | the noderef of the local node. The value is initialised by a call |
99 | C<become_slave>, after which all local port identifiers become invalid. |
113 | to C<become_public> or C<become_slave>, after which all local port |
|
|
114 | identifiers become invalid. |
|
|
115 | |
|
|
116 | =item $noderef = node_of $portid |
|
|
117 | |
|
|
118 | Extracts and returns the noderef from a portid or a noderef. |
|
|
119 | |
|
|
120 | =item $SELF |
|
|
121 | |
|
|
122 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
|
|
123 | blocks. |
|
|
124 | |
|
|
125 | =item SELF, %SELF, @SELF... |
|
|
126 | |
|
|
127 | Due to some quirks in how perl exports variables, it is impossible to |
|
|
128 | just export C<$SELF>, all the symbols called C<SELF> are exported by this |
|
|
129 | module, but only C<$SELF> is currently used. |
100 | |
130 | |
101 | =item snd $portid, type => @data |
131 | =item snd $portid, type => @data |
102 | |
132 | |
103 | =item snd $portid, @msg |
133 | =item snd $portid, @msg |
104 | |
134 | |
… | |
… | |
118 | JSON is used, then only strings, numbers and arrays and hashes consisting |
148 | JSON is used, then only strings, numbers and arrays and hashes consisting |
119 | of those are allowed (no objects). When Storable is used, then anything |
149 | of those are allowed (no objects). When Storable is used, then anything |
120 | that Storable can serialise and deserialise is allowed, and for the local |
150 | that Storable can serialise and deserialise is allowed, and for the local |
121 | node, anything can be passed. |
151 | node, anything can be passed. |
122 | |
152 | |
123 | =item $local_port = create_port |
153 | =item kil $portid[, @reason] |
124 | |
154 | |
125 | Create a new local port object. See the next section for allowed methods. |
155 | Kill the specified port with the given C<@reason>. |
126 | |
156 | |
127 | =cut |
157 | If no C<@reason> is specified, then the port is killed "normally" (linked |
|
|
158 | ports will not be kileld, or even notified). |
128 | |
159 | |
129 | sub create_port { |
160 | Otherwise, linked ports get killed with the same reason (second form of |
130 | my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID; |
161 | C<mon>, see below). |
131 | |
162 | |
132 | my $self = bless { |
163 | Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks |
133 | id => "$NODE#$id", |
164 | will be reported as reason C<< die => $@ >>. |
134 | names => [$id], |
|
|
135 | }, "AnyEvent::MP::Port"; |
|
|
136 | |
165 | |
137 | $AnyEvent::MP::Base::PORT{$id} = sub { |
166 | Transport/communication errors are reported as C<< transport_error => |
138 | unshift @_, $self; |
167 | $message >>. |
139 | |
168 | |
140 | for (@{ $self->{rc0}{$_[1]} }) { |
169 | =item $guard = mon $portid, $cb->(@reason) |
141 | $_ && &{$_->[0]} |
170 | |
142 | && undef $_; |
171 | =item $guard = mon $portid, $otherport |
|
|
172 | |
|
|
173 | =item $guard = mon $portid, $otherport, @msg |
|
|
174 | |
|
|
175 | Monitor the given port and do something when the port is killed. |
|
|
176 | |
|
|
177 | In the first form, the callback is simply called with any number |
|
|
178 | of C<@reason> elements (no @reason means that the port was deleted |
|
|
179 | "normally"). Note also that I<< the callback B<must> never die >>, so use |
|
|
180 | C<eval> if unsure. |
|
|
181 | |
|
|
182 | In the second form, the other port will be C<kil>'ed with C<@reason>, iff |
|
|
183 | a @reason was specified, i.e. on "normal" kils nothing happens, while |
|
|
184 | under all other conditions, the other port is killed with the same reason. |
|
|
185 | |
|
|
186 | In the last form, a message of the form C<@msg, @reason> will be C<snd>. |
|
|
187 | |
|
|
188 | Example: call a given callback when C<$port> is killed. |
|
|
189 | |
|
|
190 | mon $port, sub { warn "port died because of <@_>\n" }; |
|
|
191 | |
|
|
192 | Example: kill ourselves when C<$port> is killed abnormally. |
|
|
193 | |
|
|
194 | mon $port, $self; |
|
|
195 | |
|
|
196 | Example: send us a restart message another C<$port> is killed. |
|
|
197 | |
|
|
198 | mon $port, $self => "restart"; |
|
|
199 | |
|
|
200 | =cut |
|
|
201 | |
|
|
202 | sub mon { |
|
|
203 | my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift); |
|
|
204 | |
|
|
205 | my $node = $NODE{$noderef} || add_node $noderef; |
|
|
206 | |
|
|
207 | #TODO: ports must not be references |
|
|
208 | if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) { |
|
|
209 | if (@_) { |
|
|
210 | # send a kill info message |
|
|
211 | my (@msg) = ($cb, @_); |
|
|
212 | $cb = sub { snd @msg, @_ }; |
|
|
213 | } else { |
|
|
214 | # simply kill other port |
|
|
215 | my $port = $cb; |
|
|
216 | $cb = sub { kil $port, @_ if @_ }; |
143 | } |
217 | } |
144 | |
|
|
145 | for (@{ $self->{rcv}{$_[1]} }) { |
|
|
146 | $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] |
|
|
147 | && &{$_->[0]} |
|
|
148 | && undef $_; |
|
|
149 | } |
|
|
150 | |
|
|
151 | for (@{ $self->{any} }) { |
|
|
152 | $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] |
|
|
153 | && &{$_->[0]} |
|
|
154 | && undef $_; |
|
|
155 | } |
|
|
156 | }; |
218 | } |
157 | |
219 | |
158 | $self |
220 | $node->monitor ($port, $cb); |
159 | } |
|
|
160 | |
221 | |
|
|
222 | defined wantarray |
|
|
223 | and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } |
|
|
224 | } |
|
|
225 | |
|
|
226 | =item $guard = mon_guard $port, $ref, $ref... |
|
|
227 | |
|
|
228 | Monitors the given C<$port> and keeps the passed references. When the port |
|
|
229 | is killed, the references will be freed. |
|
|
230 | |
|
|
231 | Optionally returns a guard that will stop the monitoring. |
|
|
232 | |
|
|
233 | This function is useful when you create e.g. timers or other watchers and |
|
|
234 | want to free them when the port gets killed: |
|
|
235 | |
|
|
236 | $port->rcv (start => sub { |
|
|
237 | my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub { |
|
|
238 | undef $timer if 0.9 < rand; |
|
|
239 | }); |
|
|
240 | }); |
|
|
241 | |
|
|
242 | =cut |
|
|
243 | |
|
|
244 | sub mon_guard { |
|
|
245 | my ($port, @refs) = @_; |
|
|
246 | |
|
|
247 | mon $port, sub { 0 && @refs } |
|
|
248 | } |
|
|
249 | |
|
|
250 | =item $local_port = port |
|
|
251 | |
|
|
252 | Create a new local port object that supports message matching. |
|
|
253 | |
161 | =item $portid = miniport { my @msg = @_; $finished } |
254 | =item $portid = port { my @msg = @_; $finished } |
162 | |
255 | |
163 | Creates a "mini port", that is, a very lightweight port without any |
256 | Creates a "mini port", that is, a very lightweight port without any |
164 | pattern matching behind it, and returns its ID. |
257 | pattern matching behind it, and returns its ID. |
165 | |
258 | |
166 | The block will be called for every message received on the port. When the |
259 | The block will be called for every message received on the port. When the |
167 | callback returns a true value its job is considered "done" and the port |
260 | callback returns a true value its job is considered "done" and the port |
168 | will be destroyed. Otherwise it will stay alive. |
261 | will be destroyed. Otherwise it will stay alive. |
169 | |
262 | |
170 | The message will be passed as-is, no extra argument (ie.. no port id) will |
263 | The message will be passed as-is, no extra argument (i.e. no port id) will |
171 | be passed to the callback. |
264 | be passed to the callback. |
172 | |
265 | |
173 | If you need the local port id in the callback, this works nicely: |
266 | If you need the local port id in the callback, this works nicely: |
174 | |
267 | |
175 | my $port; $port = miniport { |
268 | my $port; $port = miniport { |
176 | snd $otherport, reply => $port; |
269 | snd $otherport, reply => $port; |
177 | }; |
270 | }; |
178 | |
271 | |
179 | =cut |
272 | =cut |
180 | |
273 | |
181 | sub miniport(&) { |
274 | sub port(;&) { |
|
|
275 | my $id = "$UNIQ." . $ID++; |
|
|
276 | my $port = "$NODE#$id"; |
|
|
277 | |
|
|
278 | if (@_) { |
182 | my $cb = shift; |
279 | my $cb = shift; |
183 | my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID; |
280 | $PORT{$id} = sub { |
184 | |
281 | local $SELF = $port; |
185 | $AnyEvent::MP::Base::PORT{$id} = sub { |
282 | eval { |
186 | &$cb |
283 | &$cb |
187 | and delete $AnyEvent::MP::Base::PORT{$id}; |
284 | and kil $id; |
|
|
285 | }; |
|
|
286 | _self_die if $@; |
|
|
287 | }; |
|
|
288 | } else { |
|
|
289 | my $self = bless { |
|
|
290 | id => "$NODE#$id", |
|
|
291 | }, "AnyEvent::MP::Port"; |
|
|
292 | |
|
|
293 | $PORT_DATA{$id} = $self; |
|
|
294 | $PORT{$id} = sub { |
|
|
295 | local $SELF = $port; |
|
|
296 | |
|
|
297 | eval { |
|
|
298 | for (@{ $self->{rc0}{$_[0]} }) { |
|
|
299 | $_ && &{$_->[0]} |
|
|
300 | && undef $_; |
|
|
301 | } |
|
|
302 | |
|
|
303 | for (@{ $self->{rcv}{$_[0]} }) { |
|
|
304 | $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] |
|
|
305 | && &{$_->[0]} |
|
|
306 | && undef $_; |
|
|
307 | } |
|
|
308 | |
|
|
309 | for (@{ $self->{any} }) { |
|
|
310 | $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] |
|
|
311 | && &{$_->[0]} |
|
|
312 | && undef $_; |
|
|
313 | } |
|
|
314 | }; |
|
|
315 | _self_die if $@; |
|
|
316 | }; |
188 | }; |
317 | } |
189 | |
318 | |
190 | "$NODE#$id" |
319 | $port |
191 | } |
320 | } |
192 | |
321 | |
193 | package AnyEvent::MP::Port; |
322 | =item reg $portid, $name |
194 | |
323 | |
195 | =back |
324 | Registers the given port under the name C<$name>. If the name already |
|
|
325 | exists it is replaced. |
196 | |
326 | |
197 | =head1 METHODS FOR PORT OBJECTS |
327 | A port can only be registered under one well known name. |
198 | |
328 | |
199 | =over 4 |
329 | A port automatically becomes unregistered when it is killed. |
200 | |
330 | |
201 | =item "$port" |
|
|
202 | |
|
|
203 | A port object stringifies to its port ID, so can be used directly for |
|
|
204 | C<snd> operations. |
|
|
205 | |
|
|
206 | =cut |
331 | =cut |
207 | |
332 | |
208 | use overload |
333 | sub reg(@) { |
209 | '""' => sub { $_[0]{id} }, |
334 | my ($portid, $name) = @_; |
210 | fallback => 1; |
|
|
211 | |
335 | |
212 | =item $port->rcv (type => $callback->($port, @msg)) |
336 | $REG{$name} = $portid; |
|
|
337 | } |
213 | |
338 | |
214 | =item $port->rcv ($smartmatch => $callback->($port, @msg)) |
339 | =item rcv $portid, tagstring => $callback->(@msg), ... |
215 | |
340 | |
|
|
341 | =item rcv $portid, $smartmatch => $callback->(@msg), ... |
|
|
342 | |
216 | =item $port->rcv ([$smartmatch...] => $callback->($port, @msg)) |
343 | =item rcv $portid, [$smartmatch...] => $callback->(@msg), ... |
217 | |
344 | |
218 | Register a callback on the given port. |
345 | Register callbacks to be called on matching messages on the given port. |
219 | |
346 | |
220 | The callback has to return a true value when its work is done, after |
347 | The callback has to return a true value when its work is done, after |
221 | which is will be removed, or a false value in which case it will stay |
348 | which is will be removed, or a false value in which case it will stay |
222 | registered. |
349 | registered. |
223 | |
350 | |
|
|
351 | The global C<$SELF> (exported by this module) contains C<$portid> while |
|
|
352 | executing the callback. |
|
|
353 | |
|
|
354 | Runtime errors wdurign callback execution will result in the port being |
|
|
355 | C<kil>ed. |
|
|
356 | |
224 | If the match is an array reference, then it will be matched against the |
357 | If the match is an array reference, then it will be matched against the |
225 | first elements of the message, otherwise only the first element is being |
358 | first elements of the message, otherwise only the first element is being |
226 | matched. |
359 | matched. |
227 | |
360 | |
228 | Any element in the match that is specified as C<_any_> (a function |
361 | Any element in the match that is specified as C<_any_> (a function |
… | |
… | |
233 | also the most efficient match (by far). |
366 | also the most efficient match (by far). |
234 | |
367 | |
235 | =cut |
368 | =cut |
236 | |
369 | |
237 | sub rcv($@) { |
370 | sub rcv($@) { |
238 | my ($self, $match, $cb) = @_; |
371 | my ($noderef, $port) = split /#/, shift, 2; |
239 | |
372 | |
|
|
373 | ($NODE{$noderef} || add_node $noderef) == $NODE{""} |
|
|
374 | or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught"; |
|
|
375 | |
|
|
376 | my $self = $PORT_DATA{$port} |
|
|
377 | or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught"; |
|
|
378 | |
|
|
379 | "AnyEvent::MP::Port" eq ref $self |
|
|
380 | or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught"; |
|
|
381 | |
|
|
382 | while (@_) { |
|
|
383 | my ($match, $cb) = splice @_, 0, 2; |
|
|
384 | |
240 | if (!ref $match) { |
385 | if (!ref $match) { |
241 | push @{ $self->{rc0}{$match} }, [$cb]; |
386 | push @{ $self->{rc0}{$match} }, [$cb]; |
242 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
387 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
243 | my ($type, @match) = @$match; |
388 | my ($type, @match) = @$match; |
244 | @match |
389 | @match |
245 | ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] |
390 | ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] |
246 | : push @{ $self->{rc0}{$match->[0]} }, [$cb]; |
391 | : push @{ $self->{rc0}{$match->[0]} }, [$cb]; |
247 | } else { |
392 | } else { |
248 | push @{ $self->{any} }, [$cb, $match]; |
393 | push @{ $self->{any} }, [$cb, $match]; |
|
|
394 | } |
249 | } |
395 | } |
250 | } |
396 | } |
251 | |
397 | |
252 | =item $port->register ($name) |
398 | =item $closure = psub { BLOCK } |
253 | |
399 | |
254 | Registers the given port under the well known name C<$name>. If the name |
400 | Remembers C<$SELF> and creates a closure out of the BLOCK. When the |
255 | already exists it is replaced. |
401 | closure is executed, sets up the environment in the same way as in C<rcv> |
|
|
402 | callbacks, i.e. runtime errors will cause the port to get C<kil>ed. |
256 | |
403 | |
257 | A port can only be registered under one well known name. |
404 | This is useful when you register callbacks from C<rcv> callbacks: |
258 | |
405 | |
259 | =cut |
406 | rcv delayed_reply => sub { |
|
|
407 | my ($delay, @reply) = @_; |
|
|
408 | my $timer = AE::timer $delay, 0, psub { |
|
|
409 | snd @reply, $SELF; |
|
|
410 | }; |
|
|
411 | }; |
260 | |
412 | |
261 | sub register { |
|
|
262 | my ($self, $name) = @_; |
|
|
263 | |
|
|
264 | $self->{wkname} = $name; |
|
|
265 | $AnyEvent::MP::Base::WKP{$name} = "$self"; |
|
|
266 | } |
|
|
267 | |
|
|
268 | =item $port->destroy |
|
|
269 | |
|
|
270 | Explicitly destroy/remove/nuke/vaporise the port. |
|
|
271 | |
|
|
272 | Ports are normally kept alive by there mere existance alone, and need to |
|
|
273 | be destroyed explicitly. |
|
|
274 | |
|
|
275 | =cut |
413 | =cut |
276 | |
414 | |
277 | sub destroy { |
415 | sub psub(&) { |
278 | my ($self) = @_; |
416 | my $cb = shift; |
279 | |
417 | |
280 | delete $AnyEvent::MP::Base::WKP{ $self->{wkname} }; |
418 | my $port = $SELF |
|
|
419 | or Carp::croak "psub can only be called from within rcv or psub callbacks, not"; |
281 | |
420 | |
282 | delete $AnyEvent::MP::Base::PORT{$_} |
421 | sub { |
283 | for @{ $self->{names} }; |
422 | local $SELF = $port; |
|
|
423 | |
|
|
424 | if (wantarray) { |
|
|
425 | my @res = eval { &$cb }; |
|
|
426 | _self_die if $@; |
|
|
427 | @res |
|
|
428 | } else { |
|
|
429 | my $res = eval { &$cb }; |
|
|
430 | _self_die if $@; |
|
|
431 | $res |
|
|
432 | } |
|
|
433 | } |
284 | } |
434 | } |
285 | |
435 | |
286 | =back |
436 | =back |
287 | |
437 | |
288 | =head1 FUNCTIONS FOR NODES |
438 | =head1 FUNCTIONS FOR NODES |
289 | |
439 | |
290 | =over 4 |
440 | =over 4 |
291 | |
|
|
292 | =item mon $noderef, $callback->($noderef, $status, $) |
|
|
293 | |
|
|
294 | Monitors the given noderef. |
|
|
295 | |
441 | |
296 | =item become_public endpoint... |
442 | =item become_public endpoint... |
297 | |
443 | |
298 | Tells the node to become a public node, i.e. reachable from other nodes. |
444 | Tells the node to become a public node, i.e. reachable from other nodes. |
299 | |
445 | |
… | |
… | |
319 | |
465 | |
320 | =over 4 |
466 | =over 4 |
321 | |
467 | |
322 | =cut |
468 | =cut |
323 | |
469 | |
324 | =item wkp => $name, @reply |
470 | =item lookup => $name, @reply |
325 | |
471 | |
326 | Replies with the port ID of the specified well-known port, or C<undef>. |
472 | Replies with the port ID of the specified well-known port, or C<undef>. |
327 | |
473 | |
328 | =item devnull => ... |
474 | =item devnull => ... |
329 | |
475 | |