ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-MP/MP.pm
(Generate patch)

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.8 by root, Sun Aug 2 14:44:37 2009 UTC vs.
Revision 1.32 by root, Wed Aug 5 19:58:46 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines