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.9 by root, Sun Aug 2 15:47:04 2009 UTC vs.
Revision 1.31 by root, Wed Aug 5 19:55:58 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.02'; 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 kil $portid[, @reason]
123 195
124Create a new local port object. See the next section for allowed methods. 196Kill the specified port with the given C<@reason>.
125 197
126=cut 198If no C<@reason> is specified, then the port is killed "normally" (linked
199ports will not be kileld, or even notified).
127 200
128sub create_port { 201Otherwise, linked ports get killed with the same reason (second form of
129 my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID; 202C<mon>, see below).
130 203
131 my $self = bless { 204Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
132 id => "$NODE#$id", 205will be reported as reason C<< die => $@ >>.
133 names => [$id],
134 }, "AnyEvent::MP::Port";
135 206
136 $AnyEvent::MP::Base::PORT{$id} = sub { 207Transport/communication errors are reported as C<< transport_error =>
137 unshift @_, $self; 208$message >>.
138 209
139 for (@{ $self->{rc0}{$_[1]} }) { 210=item $guard = mon $portid, $cb->(@reason)
140 $_ && &{$_->[0]} 211
141 && undef $_; 212=item $guard = mon $portid, $otherport
213
214=item $guard = mon $portid, $otherport, @msg
215
216Monitor the given port and do something when the port is killed.
217
218In the first form, the callback is simply called with any number
219of C<@reason> elements (no @reason means that the port was deleted
220"normally"). Note also that I<< the callback B<must> never die >>, so use
221C<eval> if unsure.
222
223In the second form, the other port will be C<kil>'ed with C<@reason>, iff
224a @reason was specified, i.e. on "normal" kils nothing happens, while
225under all other conditions, the other port is killed with the same reason.
226
227In the last form, a message of the form C<@msg, @reason> will be C<snd>.
228
229Example: call a given callback when C<$port> is killed.
230
231 mon $port, sub { warn "port died because of <@_>\n" };
232
233Example: kill ourselves when C<$port> is killed abnormally.
234
235 mon $port, $self;
236
237Example: send us a restart message another C<$port> is killed.
238
239 mon $port, $self => "restart";
240
241=cut
242
243sub mon {
244 my ($noderef, $port) = split /#/, shift, 2;
245
246 my $node = $NODE{$noderef} || add_node $noderef;
247
248 my $cb = shift;
249
250 unless (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 @_ };
142 } 259 }
260 }
143 261
144 for (@{ $self->{rcv}{$_[1]} }) { 262 $node->monitor ($port, $cb);
145 $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] 263
146 && &{$_->[0]} 264 defined wantarray
147 && undef $_; 265 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
266}
267
268=item $guard = mon_guard $port, $ref, $ref...
269
270Monitors the given C<$port> and keeps the passed references. When the port
271is killed, the references will be freed.
272
273Optionally returns a guard that will stop the monitoring.
274
275This function is useful when you create e.g. timers or other watchers and
276want 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;
148 } 281 });
282 });
149 283
150 for (@{ $self->{any} }) { 284=cut
151 $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] 285
152 && &{$_->[0]} 286sub mon_guard {
153 && undef $_; 287 my ($port, @refs) = @_;
154 } 288
289 mon $port, sub { 0 && @refs }
290}
291
292=item lnk $port1, $port2
293
294Link two ports. This is simply a shorthand for:
295
296 mon $port1, $port2;
297 mon $port2, $port1;
298
299It means that if either one is killed abnormally, the other one gets
300killed as well.
301
302=item $local_port = port
303
304Create a new local port object that can be used either as a pattern
305matching port ("full port") or a single-callback port ("miniport"),
306depending on how C<rcv> callbacks are bound to the object.
307
308=item $portid = port { my @msg = @_; $finished }
309
310Creates a "mini port", that is, a very lightweight port without any
311pattern matching behind it, and returns its ID.
312
313The block will be called for every message received on the port. When the
314callback returns a true value its job is considered "done" and the port
315will be destroyed. Otherwise it will stay alive.
316
317The message will be passed as-is, no extra argument (i.e. no port id) will
318be passed to the callback.
319
320If you need the local port id in the callback, this works nicely:
321
322 my $port; $port = port {
323 snd $otherport, reply => $port;
155 }; 324 };
156 325
157 $self 326=cut
327
328sub port(;&) {
329 my $id = "$UNIQ." . $ID++;
330 my $port = "$NODE#$id";
331
332 if (@_) {
333 my $cb = shift;
334 $PORT{$id} = sub {
335 local $SELF = $port;
336 eval {
337 &$cb
338 and kil $id;
339 };
340 _self_die if $@;
341 };
342 } else {
343 my $self = bless {
344 id => "$NODE#$id",
345 }, "AnyEvent::MP::Port";
346
347 $PORT_DATA{$id} = $self;
348 $PORT{$id} = sub {
349 local $SELF = $port;
350
351 eval {
352 for (@{ $self->{rc0}{$_[0]} }) {
353 $_ && &{$_->[0]}
354 && undef $_;
355 }
356
357 for (@{ $self->{rcv}{$_[0]} }) {
358 $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
359 && &{$_->[0]}
360 && undef $_;
361 }
362
363 for (@{ $self->{any} }) {
364 $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
365 && &{$_->[0]}
366 && undef $_;
367 }
368 };
369 _self_die if $@;
370 };
371 }
372
373 $port
158} 374}
159 375
160package AnyEvent::MP::Port; 376=item reg $portid, $name
161 377
162=back 378Registers the given port under the name C<$name>. If the name already
379exists it is replaced.
163 380
164=head1 METHODS FOR PORT OBJECTS 381A port can only be registered under one well known name.
165 382
166=over 4 383A port automatically becomes unregistered when it is killed.
167 384
168=item "$port"
169
170A port object stringifies to its port ID, so can be used directly for
171C<snd> operations.
172
173=cut 385=cut
174 386
175use overload 387sub reg(@) {
176 '""' => sub { $_[0]{id} }, 388 my ($portid, $name) = @_;
177 fallback => 1;
178 389
179=item $port->rcv (type => $callback->($port, @msg)) 390 $REG{$name} = $portid;
391}
180 392
181=item $port->rcv ($smartmatch => $callback->($port, @msg)) 393=item rcv $portid, $callback->(@msg)
182 394
395Replaces the callback on the specified miniport (or newly created port
396object, see C<port>). Full ports are configured with the following calls:
397
398=item rcv $portid, tagstring => $callback->(@msg), ...
399
400=item rcv $portid, $smartmatch => $callback->(@msg), ...
401
183=item $port->rcv ([$smartmatch...] => $callback->($port, @msg)) 402=item rcv $portid, [$smartmatch...] => $callback->(@msg), ...
184 403
185Register a callback on the given port. 404Register callbacks to be called on matching messages on the given port.
186 405
187The callback has to return a true value when its work is done, after 406The 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 407which is will be removed, or a false value in which case it will stay
189registered. 408registered.
190 409
410The global C<$SELF> (exported by this module) contains C<$portid> while
411executing the callback.
412
413Runtime errors wdurign callback execution will result in the port being
414C<kil>ed.
415
191If the match is an array reference, then it will be matched against the 416If 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 417first elements of the message, otherwise only the first element is being
193matched. 418matched.
194 419
195Any element in the match that is specified as C<_any_> (a function 420Any element in the match that is specified as C<_any_> (a function
200also the most efficient match (by far). 425also the most efficient match (by far).
201 426
202=cut 427=cut
203 428
204sub rcv($@) { 429sub rcv($@) {
205 my ($self, $match, $cb) = @_; 430 my $portid = shift;
431 my ($noderef, $port) = split /#/, $port, 2;
206 432
433 ($NODE{$noderef} || add_node $noderef) == $NODE{""}
434 or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught";
435
436 my $self = $PORT_DATA{$port}
437 or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
438
439 "AnyEvent::MP::Port" eq ref $self
440 or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
441
442 while (@_) {
443 my ($match, $cb) = splice @_, 0, 2;
444
207 if (!ref $match) { 445 if (!ref $match) {
208 push @{ $self->{rc0}{$match} }, [$cb]; 446 push @{ $self->{rc0}{$match} }, [$cb];
209 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { 447 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
210 my ($type, @match) = @$match; 448 my ($type, @match) = @$match;
211 @match 449 @match
212 ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] 450 ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
213 : push @{ $self->{rc0}{$match->[0]} }, [$cb]; 451 : push @{ $self->{rc0}{$match->[0]} }, [$cb];
214 } else { 452 } else {
215 push @{ $self->{any} }, [$cb, $match]; 453 push @{ $self->{any} }, [$cb, $match];
454 }
455 }
456
457 $portid
458}
459
460=item $closure = psub { BLOCK }
461
462Remembers C<$SELF> and creates a closure out of the BLOCK. When the
463closure is executed, sets up the environment in the same way as in C<rcv>
464callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
465
466This is useful when you register callbacks from C<rcv> callbacks:
467
468 rcv delayed_reply => sub {
469 my ($delay, @reply) = @_;
470 my $timer = AE::timer $delay, 0, psub {
471 snd @reply, $SELF;
472 };
473 };
474
475=cut
476
477sub psub(&) {
478 my $cb = shift;
479
480 my $port = $SELF
481 or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
482
483 sub {
484 local $SELF = $port;
485
486 if (wantarray) {
487 my @res = eval { &$cb };
488 _self_die if $@;
489 @res
490 } else {
491 my $res = eval { &$cb };
492 _self_die if $@;
493 $res
494 }
216 } 495 }
217} 496}
218 497
219=item $port->register ($name)
220
221Registers the given port under the well known name C<$name>. If the name
222already exists it is replaced.
223
224A port can only be registered under one well known name.
225
226=cut
227
228sub register {
229 my ($self, $name) = @_;
230
231 $self->{wkname} = $name;
232 $AnyEvent::MP::Base::WKP{$name} = "$self";
233}
234
235=item $port->destroy
236
237Explicitly destroy/remove/nuke/vaporise the port.
238
239Ports are normally kept alive by there mere existance alone, and need to
240be destroyed explicitly.
241
242=cut
243
244sub destroy {
245 my ($self) = @_;
246
247 delete $AnyEvent::MP::Base::WKP{ $self->{wkname} };
248
249 delete $AnyEvent::MP::Base::PORT{$_}
250 for @{ $self->{names} };
251}
252
253=back 498=back
254 499
255=head1 FUNCTIONS FOR NODES 500=head1 FUNCTIONS FOR NODES
256 501
257=over 4 502=over 4
258 503
259=item mon $noderef, $callback->($noderef, $status, $) 504=item become_public $noderef
260
261Monitors the given noderef.
262
263=item become_public endpoint...
264 505
265Tells the node to become a public node, i.e. reachable from other nodes. 506Tells the node to become a public node, i.e. reachable from other nodes.
266 507
267If no arguments are given, or the first argument is C<undef>, then 508The 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 509(if missing then the empty string is used).
269local nodename resolves to.
270 510
271Otherwise the first argument must be an array-reference with transport 511It 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 512tries 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 513which case AnyEvent::MP tries to guess the local addresses.
274will become the node reference.
275 514
276=cut 515=cut
277 516
278=back 517=back
279 518
282Nodes understand the following messages sent to them. Many of them take 521Nodes understand the following messages sent to them. Many of them take
283arguments called C<@reply>, which will simply be used to compose a reply 522arguments 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 523message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
285the remaining arguments are simply the message data. 524the remaining arguments are simply the message data.
286 525
526While other messages exist, they are not public and subject to change.
527
287=over 4 528=over 4
288 529
289=cut 530=cut
290 531
291=item wkp => $name, @reply 532=item lookup => $name, @reply
292 533
293Replies with the port ID of the specified well-known port, or C<undef>. 534Replies with the port ID of the specified well-known port, or C<undef>.
294 535
295=item devnull => ... 536=item devnull => ...
296 537
319 snd $NODE, time => $myport, timereply => 1, 2; 560 snd $NODE, time => $myport, timereply => 1, 2;
320 # => snd $myport, timereply => 1, 2, <time> 561 # => snd $myport, timereply => 1, 2, <time>
321 562
322=back 563=back
323 564
565=head1 AnyEvent::MP vs. Distributed Erlang
566
567AnyEvent::MP got lots of its ideas from distributed erlang (erlang node
568== aemp node, erlang process == aemp port), so many of the documents and
569programming techniques employed by erlang apply to AnyEvent::MP. Here is a
570sample:
571
572 http://www.erlang.se/doc/programming_rules.shtml
573 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
574 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
575 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
576
577Despite the similarities, there are also some important differences:
578
579=over 4
580
581=item * Node references contain the recipe on how to contact them.
582
583Erlang relies on special naming and DNS to work everywhere in the
584same way. AEMP relies on each node knowing it's own address(es), with
585convenience functionality.
586
587This means that AEMP requires a less tightly controlled environment at the
588cost of longer node references and a slightly higher management overhead.
589
590=item * Erlang uses processes and a mailbox, AEMP does not queue.
591
592Erlang uses processes that selctively receive messages, and therefore
593needs a queue. AEMP is event based, queuing messages would serve no useful
594purpose.
595
596(But see L<Coro::MP> for a more erlang-like process model on top of AEMP).
597
598=item * Erlang sends are synchronous, AEMP sends are asynchronous.
599
600Sending messages in erlang is synchronous and blocks the process. AEMP
601sends are immediate, connection establishment is handled in the
602background.
603
604=item * Erlang can silently lose messages, AEMP cannot.
605
606Erlang makes few guarantees on messages delivery - messages can get lost
607without any of the processes realising it (i.e. you send messages a, b,
608and c, and the other side only receives messages a and c).
609
610AEMP guarantees correct ordering, and the guarantee that there are no
611holes in the message sequence.
612
613=item * In erlang, processes can be declared dead and later be found to be
614alive.
615
616In erlang it can happen that a monitored process is declared dead and
617linked processes get killed, but later it turns out that the process is
618still alive - and can receive messages.
619
620In AEMP, when port monitoring detects a port as dead, then that port will
621eventually be killed - it cannot happen that a node detects a port as dead
622and then later sends messages to it, finding it is still alive.
623
624=item * Erlang can send messages to the wrong port, AEMP does not.
625
626In erlang it is quite possible that a node that restarts reuses a process
627ID known to other nodes for a completely different process, causing
628messages destined for that process to end up in an unrelated process.
629
630AEMP never reuses port IDs, so old messages or old port IDs floating
631around in the network will not be sent to an unrelated port.
632
633=item * Erlang uses unprotected connections, AEMP uses secure
634authentication and can use TLS.
635
636AEMP can use a proven protocol - SSL/TLS - to protect connections and
637securely authenticate nodes.
638
639=item * The AEMP protocol is optimised for both text-based and binary
640communications.
641
642The AEMP protocol, unlike the erlang protocol, supports both
643language-independent text-only protocols (good for debugging) and binary,
644language-specific serialisers (e.g. Storable).
645
646It has also been carefully designed to be implementable in other languages
647with a minimum of work while gracefully degrading fucntionality to make the
648protocol simple.
649
650=back
651
324=head1 SEE ALSO 652=head1 SEE ALSO
325 653
326L<AnyEvent>. 654L<AnyEvent>.
327 655
328=head1 AUTHOR 656=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines