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.82 by root, Mon Sep 7 18:42:09 2009 UTC vs.
Revision 1.142 by root, Fri Mar 23 13:44:01 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::MP - multi-processing/message-passing framework 3AnyEvent::MP - erlang-style multi-processing/message-passing framework
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
30 rcv $port, pong => sub { warn "pong received\n" }; 30 rcv $port, pong => sub { warn "pong received\n" };
31 31
32 # create a port on another node 32 # create a port on another node
33 my $port = spawn $node, $initfunc, @initdata; 33 my $port = spawn $node, $initfunc, @initdata;
34 34
35 # destroy a port again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
35 # monitoring 39 # monitoring
36 mon $port, $cb->(@msg) # callback is invoked on death 40 mon $port, $cb->(@msg) # callback is invoked on death
37 mon $port, $otherport # kill otherport on abnormal death 41 mon $port, $localport # kill localport on abnormal death
38 mon $port, $otherport, @msg # send message on death 42 mon $port, $localport, @msg # send message on death
39 43
40=head1 CURRENT STATUS 44 # temporarily execute code in port context
45 peval $port, sub { die "kill the port!" };
41 46
42 bin/aemp - stable. 47 # execute callbacks in $SELF port context
43 AnyEvent::MP - stable API, should work. 48 my $timer = AE::timer 1, 0, psub {
44 AnyEvent::MP::Intro - explains most concepts. 49 die "kill the port, delayed";
45 AnyEvent::MP::Kernel - mostly stable. 50 };
46 AnyEvent::MP::Global - stable but incomplete, protocol not yet final.
47
48stay tuned.
49 51
50=head1 DESCRIPTION 52=head1 DESCRIPTION
51 53
52This module (-family) implements a simple message passing framework. 54This module (-family) implements a simple message passing framework.
53 55
68 70
69Ports allow you to register C<rcv> handlers that can match all or just 71Ports allow you to register C<rcv> handlers that can match all or just
70some messages. Messages send to ports will not be queued, regardless of 72some messages. Messages send to ports will not be queued, regardless of
71anything was listening for them or not. 73anything was listening for them or not.
72 74
75Ports are represented by (printable) strings called "port IDs".
76
73=item port ID - C<nodeid#portname> 77=item port ID - C<nodeid#portname>
74 78
75A port ID is the concatenation of a node ID, a hash-mark (C<#>) as 79A port ID is the concatenation of a node ID, a hash-mark (C<#>)
76separator, and a port name (a printable string of unspecified format). 80as separator, and a port name (a printable string of unspecified
81format created by AnyEvent::MP).
77 82
78=item node 83=item node
79 84
80A node is a single process containing at least one port - the node port, 85A node is a single process containing at least one port - the node port,
81which enables nodes to manage each other remotely, and to create new 86which enables nodes to manage each other remotely, and to create new
82ports. 87ports.
83 88
84Nodes are either public (have one or more listening ports) or private 89Nodes are either public (have one or more listening ports) or private
85(no listening ports). Private nodes cannot talk to other private nodes 90(no listening ports). Private nodes cannot talk to other private nodes
86currently. 91currently, but all nodes can talk to public nodes.
87 92
93Nodes is represented by (printable) strings called "node IDs".
94
88=item node ID - C<[a-za-Z0-9_\-.:]+> 95=item node ID - C<[A-Za-z0-9_\-.:]*>
89 96
90A node ID is a string that uniquely identifies the node within a 97A node ID is a string that uniquely identifies the node within a
91network. Depending on the configuration used, node IDs can look like a 98network. Depending on the configuration used, node IDs can look like a
92hostname, a hostname and a port, or a random string. AnyEvent::MP itself 99hostname, a hostname and a port, or a random string. AnyEvent::MP itself
93doesn't interpret node IDs in any way. 100doesn't interpret node IDs in any way except to uniquely identify a node.
94 101
95=item binds - C<ip:port> 102=item binds - C<ip:port>
96 103
97Nodes can only talk to each other by creating some kind of connection to 104Nodes can only talk to each other by creating some kind of connection to
98each other. To do this, nodes should listen on one or more local transport 105each other. To do this, nodes should listen on one or more local transport
106endpoints - binds.
107
99endpoints - binds. Currently, only standard C<ip:port> specifications can 108Currently, only standard C<ip:port> specifications can be used, which
100be used, which specify TCP ports to listen on. 109specify TCP ports to listen on. So a bind is basically just a tcp socket
110in listening mode thta accepts conenctions form other nodes.
101 111
112=item seed nodes
113
114When a node starts, it knows nothing about the network it is in - it
115needs to connect to at least one other node that is already in the
116network. These other nodes are called "seed nodes".
117
118Seed nodes themselves are not special - they are seed nodes only because
119some other node I<uses> them as such, but any node can be used as seed
120node for other nodes, and eahc node cna use a different set of seed nodes.
121
122In addition to discovering the network, seed nodes are also used to
123maintain the network - all nodes using the same seed node form are part of
124the same network. If a network is split into multiple subnets because e.g.
125the network link between the parts goes down, then using the same seed
126nodes for all nodes ensures that eventually the subnets get merged again.
127
128Seed nodes are expected to be long-running, and at least one seed node
129should always be available. They should also be relatively responsive - a
130seed node that blocks for long periods will slow down everybody else.
131
132For small networks, it's best if every node uses the same set of seed
133nodes. For large networks, it can be useful to specify "regional" seed
134nodes for most nodes in an area, and use all seed nodes as seed nodes for
135each other. What's important is that all seed nodes connections form a
136complete graph, so that the network cannot split into separate subnets
137forever.
138
139Seed nodes are represented by seed IDs.
140
102=item seeds - C<host:port> 141=item seed IDs - C<host:port>
103 142
104When a node starts, it knows nothing about the network. To teach the node 143Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
105about the network it first has to contact some other node within the 144TCP port) of nodes that should be used as seed nodes.
106network. This node is called a seed.
107 145
108Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes 146=item global nodes
109are expected to be long-running, and at least one of those should always
110be available. When nodes run out of connections (e.g. due to a network
111error), they try to re-establish connections to some seednodes again to
112join the network.
113 147
114Apart from being sued for seeding, seednodes are not special in any way - 148An AEMP network needs a discovery service - nodes need to know how to
115every public node can be a seednode. 149connect to other nodes they only know by name. In addition, AEMP offers a
150distributed "group database", which maps group names to a list of strings
151- for example, to register worker ports.
152
153A network needs at least one global node to work, and allows every node to
154be a global node.
155
156Any node that loads the L<AnyEvent::MP::Global> module becomes a global
157node and tries to keep connections to all other nodes. So while it can
158make sense to make every node "global" in small networks, it usually makes
159sense to only make seed nodes into global nodes in large networks (nodes
160keep connections to seed nodes and global nodes, so makign them the same
161reduces overhead).
116 162
117=back 163=back
118 164
119=head1 VARIABLES/FUNCTIONS 165=head1 VARIABLES/FUNCTIONS
120 166
122 168
123=cut 169=cut
124 170
125package AnyEvent::MP; 171package AnyEvent::MP;
126 172
173use AnyEvent::MP::Config ();
127use AnyEvent::MP::Kernel; 174use AnyEvent::MP::Kernel;
175use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
128 176
129use common::sense; 177use common::sense;
130 178
131use Carp (); 179use Carp ();
132 180
133use AE (); 181use AnyEvent ();
182use Guard ();
134 183
135use base "Exporter"; 184use base "Exporter";
136 185
137our $VERSION = $AnyEvent::MP::Kernel::VERSION; 186our $VERSION = $AnyEvent::MP::Config::VERSION;
138 187
139our @EXPORT = qw( 188our @EXPORT = qw(
140 NODE $NODE *SELF node_of after 189 NODE $NODE *SELF node_of after
141 configure 190 configure
142 snd rcv mon mon_guard kil reg psub spawn 191 snd rcv mon mon_guard kil psub peval spawn cal
143 port 192 port
193 db_set db_del db_reg
194 db_mon db_family db_keys db_values
144); 195);
145 196
146our $SELF; 197our $SELF;
147 198
148sub _self_die() { 199sub _self_die() {
171some other nodes in the network to discover other nodes. 222some other nodes in the network to discover other nodes.
172 223
173This function configures a node - it must be called exactly once (or 224This function configures a node - it must be called exactly once (or
174never) before calling other AnyEvent::MP functions. 225never) before calling other AnyEvent::MP functions.
175 226
227The key/value pairs are basically the same ones as documented for the
228F<aemp> command line utility (sans the set/del prefix), with these additions:
229
230=over 4
231
232=item norc => $boolean (default false)
233
234If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
235be consulted - all configuraiton options must be specified in the
236C<configure> call.
237
238=item force => $boolean (default false)
239
240IF true, then the values specified in the C<configure> will take
241precedence over any values configured via the rc file. The default is for
242the rc file to override any options specified in the program.
243
244=back
245
176=over 4 246=over 4
177 247
178=item step 1, gathering configuration from profiles 248=item step 1, gathering configuration from profiles
179 249
180The function first looks up a profile in the aemp configuration (see the 250The function first looks up a profile in the aemp configuration (see the
193That means that the values specified in the profile have highest priority 263That means that the values specified in the profile have highest priority
194and the values specified directly via C<configure> have lowest priority, 264and the values specified directly via C<configure> have lowest priority,
195and can only be used to specify defaults. 265and can only be used to specify defaults.
196 266
197If the profile specifies a node ID, then this will become the node ID of 267If the profile specifies a node ID, then this will become the node ID of
198this process. If not, then the profile name will be used as node ID. The 268this process. If not, then the profile name will be used as node ID, with
199special node ID of C<anon/> will be replaced by a random node ID. 269a unique randoms tring (C</%u>) appended.
270
271The node ID can contain some C<%> sequences that are expanded: C<%n>
272is expanded to the local nodename, C<%u> is replaced by a random
273strign to make the node unique. For example, the F<aemp> commandline
274utility uses C<aemp/%n/%u> as nodename, which might expand to
275C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
200 276
201=item step 2, bind listener sockets 277=item step 2, bind listener sockets
202 278
203The next step is to look up the binds in the profile, followed by binding 279The next step is to look up the binds in the profile, followed by binding
204aemp protocol listeners on all binds specified (it is possible and valid 280aemp protocol listeners on all binds specified (it is possible and valid
210used, meaning the node will bind on a dynamically-assigned port on every 286used, meaning the node will bind on a dynamically-assigned port on every
211local IP address it finds. 287local IP address it finds.
212 288
213=item step 3, connect to seed nodes 289=item step 3, connect to seed nodes
214 290
215As the last step, the seeds list from the profile is passed to the 291As the last step, the seed ID list from the profile is passed to the
216L<AnyEvent::MP::Global> module, which will then use it to keep 292L<AnyEvent::MP::Global> module, which will then use it to keep
217connectivity with at least one node at any point in time. 293connectivity with at least one node at any point in time.
218 294
219=back 295=back
220 296
221Example: become a distributed node using the locla node name as profile. 297Example: become a distributed node using the local node name as profile.
222This should be the most common form of invocation for "daemon"-type nodes. 298This should be the most common form of invocation for "daemon"-type nodes.
223 299
224 configure 300 configure
225 301
226Example: become an anonymous node. This form is often used for commandline 302Example: become a semi-anonymous node. This form is often used for
227clients. 303commandline clients.
228 304
229 configure nodeid => "anon/"; 305 configure nodeid => "myscript/%n/%u";
230 306
231Example: configure a node using a profile called seed, which si suitable 307Example: configure a node using a profile called seed, which is suitable
232for a seed node as it binds on all local addresses on a fixed port (4040, 308for a seed node as it binds on all local addresses on a fixed port (4040,
233customary for aemp). 309customary for aemp).
234 310
235 # use the aemp commandline utility 311 # use the aemp commandline utility
236 # aemp profile seed nodeid anon/ binds '*:4040' 312 # aemp profile seed binds '*:4040'
237 313
238 # then use it 314 # then use it
239 configure profile => "seed"; 315 configure profile => "seed";
240 316
241 # or simply use aemp from the shell again: 317 # or simply use aemp from the shell again:
306 382
307=cut 383=cut
308 384
309sub rcv($@); 385sub rcv($@);
310 386
311sub _kilme { 387my $KILME = sub {
312 die "received message on port without callback"; 388 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
313} 389 kil $SELF, unhandled_message => "no callback found for message '$tag'";
390};
314 391
315sub port(;&) { 392sub port(;&) {
316 my $id = "$UNIQ." . $ID++; 393 my $id = $UNIQ . ++$ID;
317 my $port = "$NODE#$id"; 394 my $port = "$NODE#$id";
318 395
319 rcv $port, shift || \&_kilme; 396 rcv $port, shift || $KILME;
320 397
321 $port 398 $port
322} 399}
323 400
324=item rcv $local_port, $callback->(@msg) 401=item rcv $local_port, $callback->(@msg)
329 406
330The global C<$SELF> (exported by this module) contains C<$port> while 407The global C<$SELF> (exported by this module) contains C<$port> while
331executing the callback. Runtime errors during callback execution will 408executing the callback. Runtime errors during callback execution will
332result in the port being C<kil>ed. 409result in the port being C<kil>ed.
333 410
334The default callback received all messages not matched by a more specific 411The default callback receives all messages not matched by a more specific
335C<tag> match. 412C<tag> match.
336 413
337=item rcv $local_port, tag => $callback->(@msg_without_tag), ... 414=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
338 415
339Register (or replace) callbacks to be called on messages starting with the 416Register (or replace) callbacks to be called on messages starting with the
360 msg1 => sub { ... }, 437 msg1 => sub { ... },
361 ... 438 ...
362 ; 439 ;
363 440
364Example: temporarily register a rcv callback for a tag matching some port 441Example: temporarily register a rcv callback for a tag matching some port
365(e.g. for a rpc reply) and unregister it after a message was received. 442(e.g. for an rpc reply) and unregister it after a message was received.
366 443
367 rcv $port, $otherport => sub { 444 rcv $port, $otherport => sub {
368 my @reply = @_; 445 my @reply = @_;
369 446
370 rcv $SELF, $otherport; 447 rcv $SELF, $otherport;
383 if (ref $_[0]) { 460 if (ref $_[0]) {
384 if (my $self = $PORT_DATA{$portid}) { 461 if (my $self = $PORT_DATA{$portid}) {
385 "AnyEvent::MP::Port" eq ref $self 462 "AnyEvent::MP::Port" eq ref $self
386 or Carp::croak "$port: rcv can only be called on message matching ports, caught"; 463 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
387 464
388 $self->[2] = shift; 465 $self->[0] = shift;
389 } else { 466 } else {
390 my $cb = shift; 467 my $cb = shift;
391 $PORT{$portid} = sub { 468 $PORT{$portid} = sub {
392 local $SELF = $port; 469 local $SELF = $port;
393 eval { &$cb }; _self_die if $@; 470 eval { &$cb }; _self_die if $@;
394 }; 471 };
395 } 472 }
396 } elsif (defined $_[0]) { 473 } elsif (defined $_[0]) {
397 my $self = $PORT_DATA{$portid} ||= do { 474 my $self = $PORT_DATA{$portid} ||= do {
398 my $self = bless [$PORT{$port} || sub { }, { }, $port], "AnyEvent::MP::Port"; 475 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
399 476
400 $PORT{$portid} = sub { 477 $PORT{$portid} = sub {
401 local $SELF = $port; 478 local $SELF = $port;
402 479
403 if (my $cb = $self->[1]{$_[0]}) { 480 if (my $cb = $self->[1]{$_[0]}) {
425 } 502 }
426 503
427 $port 504 $port
428} 505}
429 506
507=item peval $port, $coderef[, @args]
508
509Evaluates the given C<$codref> within the contetx of C<$port>, that is,
510when the code throews an exception the C<$port> will be killed.
511
512Any remaining args will be passed to the callback. Any return values will
513be returned to the caller.
514
515This is useful when you temporarily want to execute code in the context of
516a port.
517
518Example: create a port and run some initialisation code in it's context.
519
520 my $port = port { ... };
521
522 peval $port, sub {
523 init
524 or die "unable to init";
525 };
526
527=cut
528
529sub peval($$) {
530 local $SELF = shift;
531 my $cb = shift;
532
533 if (wantarray) {
534 my @res = eval { &$cb };
535 _self_die if $@;
536 @res
537 } else {
538 my $res = eval { &$cb };
539 _self_die if $@;
540 $res
541 }
542}
543
430=item $closure = psub { BLOCK } 544=item $closure = psub { BLOCK }
431 545
432Remembers C<$SELF> and creates a closure out of the BLOCK. When the 546Remembers C<$SELF> and creates a closure out of the BLOCK. When the
433closure is executed, sets up the environment in the same way as in C<rcv> 547closure is executed, sets up the environment in the same way as in C<rcv>
434callbacks, i.e. runtime errors will cause the port to get C<kil>ed. 548callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
549
550The effect is basically as if it returned C<< sub { peval $SELF, sub {
551BLOCK }, @_ } >>.
435 552
436This is useful when you register callbacks from C<rcv> callbacks: 553This is useful when you register callbacks from C<rcv> callbacks:
437 554
438 rcv delayed_reply => sub { 555 rcv delayed_reply => sub {
439 my ($delay, @reply) = @_; 556 my ($delay, @reply) = @_;
463 $res 580 $res
464 } 581 }
465 } 582 }
466} 583}
467 584
585=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
586
587=item $guard = mon $port # kill $SELF when $port dies
588
468=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies 589=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
469
470=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
471
472=item $guard = mon $port # kill $SELF when $port dies
473 590
474=item $guard = mon $port, $rcvport, @msg # send a message when $port dies 591=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
475 592
476Monitor the given port and do something when the port is killed or 593Monitor the given port and do something when the port is killed or
477messages to it were lost, and optionally return a guard that can be used 594messages to it were lost, and optionally return a guard that can be used
478to stop monitoring again. 595to stop monitoring again.
479 596
597The first two forms distinguish between "normal" and "abnormal" kil's:
598
599In the first form (another port given), if the C<$port> is C<kil>'ed with
600a non-empty reason, the other port (C<$rcvport>) will be kil'ed with the
601same reason. That is, on "normal" kil's nothing happens, while under all
602other conditions, the other port is killed with the same reason.
603
604The second form (kill self) is the same as the first form, except that
605C<$rvport> defaults to C<$SELF>.
606
607The remaining forms don't distinguish between "normal" and "abnormal" kil's
608- it's up to the callback or receiver to check whether the C<@reason> is
609empty and act accordingly.
610
480In the first form (callback), the callback is simply called with any 611In the third form (callback), the callback is simply called with any
481number of C<@reason> elements (no @reason means that the port was deleted 612number of C<@reason> elements (empty @reason means that the port was deleted
482"normally"). Note also that I<< the callback B<must> never die >>, so use 613"normally"). Note also that I<< the callback B<must> never die >>, so use
483C<eval> if unsure. 614C<eval> if unsure.
484 615
485In the second form (another port given), the other port (C<$rcvport>)
486will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
487"normal" kils nothing happens, while under all other conditions, the other
488port is killed with the same reason.
489
490The third form (kill self) is the same as the second form, except that
491C<$rvport> defaults to C<$SELF>.
492
493In the last form (message), a message of the form C<@msg, @reason> will be 616In the last form (message), a message of the form C<$rcvport, @msg,
494C<snd>. 617@reason> will be C<snd>.
495 618
496Monitoring-actions are one-shot: once messages are lost (and a monitoring 619Monitoring-actions are one-shot: once messages are lost (and a monitoring
497alert was raised), they are removed and will not trigger again. 620alert was raised), they are removed and will not trigger again, even if it
621turns out that the port is still alive.
498 622
499As a rule of thumb, monitoring requests should always monitor a port from 623As a rule of thumb, monitoring requests should always monitor a remote
500a local port (or callback). The reason is that kill messages might get 624port locally (using a local C<$rcvport> or a callback). The reason is that
501lost, just like any other message. Another less obvious reason is that 625kill messages might get lost, just like any other message. Another less
502even monitoring requests can get lost (for example, when the connection 626obvious reason is that even monitoring requests can get lost (for example,
503to the other node goes down permanently). When monitoring a port locally 627when the connection to the other node goes down permanently). When
504these problems do not exist. 628monitoring a port locally these problems do not exist.
505 629
506C<mon> effectively guarantees that, in the absence of hardware failures, 630C<mon> effectively guarantees that, in the absence of hardware failures,
507after starting the monitor, either all messages sent to the port will 631after starting the monitor, either all messages sent to the port will
508arrive, or the monitoring action will be invoked after possible message 632arrive, or the monitoring action will be invoked after possible message
509loss has been detected. No messages will be lost "in between" (after 633loss has been detected. No messages will be lost "in between" (after
512delivered again. 636delivered again.
513 637
514Inter-host-connection timeouts and monitoring depend on the transport 638Inter-host-connection timeouts and monitoring depend on the transport
515used. The only transport currently implemented is TCP, and AnyEvent::MP 639used. The only transport currently implemented is TCP, and AnyEvent::MP
516relies on TCP to detect node-downs (this can take 10-15 minutes on a 640relies on TCP to detect node-downs (this can take 10-15 minutes on a
517non-idle connection, and usually around two hours for idle conenctions). 641non-idle connection, and usually around two hours for idle connections).
518 642
519This means that monitoring is good for program errors and cleaning up 643This means that monitoring is good for program errors and cleaning up
520stuff eventually, but they are no replacement for a timeout when you need 644stuff eventually, but they are no replacement for a timeout when you need
521to ensure some maximum latency. 645to ensure some maximum latency.
522 646
554 } 678 }
555 679
556 $node->monitor ($port, $cb); 680 $node->monitor ($port, $cb);
557 681
558 defined wantarray 682 defined wantarray
559 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 683 and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
560} 684}
561 685
562=item $guard = mon_guard $port, $ref, $ref... 686=item $guard = mon_guard $port, $ref, $ref...
563 687
564Monitors the given C<$port> and keeps the passed references. When the port 688Monitors the given C<$port> and keeps the passed references. When the port
587 711
588=item kil $port[, @reason] 712=item kil $port[, @reason]
589 713
590Kill the specified port with the given C<@reason>. 714Kill the specified port with the given C<@reason>.
591 715
592If no C<@reason> is specified, then the port is killed "normally" (ports 716If no C<@reason> is specified, then the port is killed "normally" -
593monitoring other ports will not necessarily die because a port dies 717monitor callback will be invoked, but the kil will not cause linked ports
594"normally"). 718(C<mon $mport, $lport> form) to get killed.
595 719
596Otherwise, linked ports get killed with the same reason (second form of 720If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
597C<mon>, see above). 721form) get killed with the same reason.
598 722
599Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks 723Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
600will be reported as reason C<< die => $@ >>. 724will be reported as reason C<< die => $@ >>.
601 725
602Transport/communication errors are reported as C<< transport_error => 726Transport/communication errors are reported as C<< transport_error =>
603$message >>. 727$message >>.
604 728
605=cut 729Common idioms:
730
731 # silently remove yourself, do not kill linked ports
732 kil $SELF;
733
734 # report a failure in some detail
735 kil $SELF, failure_mode_1 => "it failed with too high temperature";
736
737 # do not waste much time with killing, just die when something goes wrong
738 open my $fh, "<file"
739 or die "file: $!";
606 740
607=item $port = spawn $node, $initfunc[, @initdata] 741=item $port = spawn $node, $initfunc[, @initdata]
608 742
609Creates a port on the node C<$node> (which can also be a port ID, in which 743Creates a port on the node C<$node> (which can also be a port ID, in which
610case it's the node where that port resides). 744case it's the node where that port resides).
668} 802}
669 803
670sub spawn(@) { 804sub spawn(@) {
671 my ($nodeid, undef) = split /#/, shift, 2; 805 my ($nodeid, undef) = split /#/, shift, 2;
672 806
673 my $id = "$RUNIQ." . $ID++; 807 my $id = $RUNIQ . ++$ID;
674 808
675 $_[0] =~ /::/ 809 $_[0] =~ /::/
676 or Carp::croak "spawn init function must be a fully-qualified name, caught"; 810 or Carp::croak "spawn init function must be a fully-qualified name, caught";
677 811
678 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_; 812 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
679 813
680 "$nodeid#$id" 814 "$nodeid#$id"
681} 815}
816
682 817
683=item after $timeout, @msg 818=item after $timeout, @msg
684 819
685=item after $timeout, $callback 820=item after $timeout, $callback
686 821
702 ? $action[0]() 837 ? $action[0]()
703 : snd @action; 838 : snd @action;
704 }; 839 };
705} 840}
706 841
842#=item $cb2 = timeout $seconds, $cb[, @args]
843
844=item cal $port, @msg, $callback[, $timeout]
845
846A simple form of RPC - sends a message to the given C<$port> with the
847given contents (C<@msg>), but adds a reply port to the message.
848
849The reply port is created temporarily just for the purpose of receiving
850the reply, and will be C<kil>ed when no longer needed.
851
852A reply message sent to the port is passed to the C<$callback> as-is.
853
854If an optional time-out (in seconds) is given and it is not C<undef>,
855then the callback will be called without any arguments after the time-out
856elapsed and the port is C<kil>ed.
857
858If no time-out is given (or it is C<undef>), then the local port will
859monitor the remote port instead, so it eventually gets cleaned-up.
860
861Currently this function returns the temporary port, but this "feature"
862might go in future versions unless you can make a convincing case that
863this is indeed useful for something.
864
865=cut
866
867sub cal(@) {
868 my $timeout = ref $_[-1] ? undef : pop;
869 my $cb = pop;
870
871 my $port = port {
872 undef $timeout;
873 kil $SELF;
874 &$cb;
875 };
876
877 if (defined $timeout) {
878 $timeout = AE::timer $timeout, 0, sub {
879 undef $timeout;
880 kil $port;
881 $cb->();
882 };
883 } else {
884 mon $_[0], sub {
885 kil $port;
886 $cb->();
887 };
888 }
889
890 push @_, $port;
891 &snd;
892
893 $port
894}
895
896=back
897
898=head1 DISTRIBUTED DATABASE
899
900AnyEvent::MP comes with a simple distributed database. The database will
901be mirrored asynchronously on all global nodes. Other nodes bind to one
902of the global nodes for their needs. Every node has a "local database"
903which contains all the values that are set locally. All local databases
904are merged together to form the global database, which can be queried.
905
906The database structure is that of a two-level hash - the database hash
907contains hashes which contain values, similarly to a perl hash of hashes,
908i.e.:
909
910 $DATABASE{$family}{$subkey} = $value
911
912The top level hash key is called "family", and the second-level hash key
913is called "subkey" or simply "key".
914
915The family must be alphanumeric, i.e. start with a letter and consist
916of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
917pretty much like Perl module names.
918
919As the family namespace is global, it is recommended to prefix family names
920with the name of the application or module using it.
921
922The subkeys must be non-empty strings, with no further restrictions.
923
924The values should preferably be strings, but other perl scalars should
925work as well (such as C<undef>, arrays and hashes).
926
927Every database entry is owned by one node - adding the same family/subkey
928combination on multiple nodes will not cause discomfort for AnyEvent::MP,
929but the result might be nondeterministic, i.e. the key might have
930different values on different nodes.
931
932Different subkeys in the same family can be owned by different nodes
933without problems, and in fact, this is the common method to create worker
934pools. For example, a worker port for image scaling might do this:
935
936 db_set my_image_scalers => $port;
937
938And clients looking for an image scaler will want to get the
939C<my_image_scalers> keys from time to time:
940
941 db_keys my_image_scalers => sub {
942 @ports = @{ $_[0] };
943 };
944
945Or better yet, they want to monitor the database family, so they always
946have a reasonable up-to-date copy:
947
948 db_mon my_image_scalers => sub {
949 @ports = keys %{ $_[0] };
950 };
951
952In general, you can set or delete single subkeys, but query and monitor
953whole families only.
954
955If you feel the need to monitor or query a single subkey, try giving it
956it's own family.
957
958=over
959
960=item $guard = db_set $family => $subkey [=> $value]
961
962Sets (or replaces) a key to the database - if C<$value> is omitted,
963C<undef> is used instead.
964
965When called in non-void context, C<db_set> returns a guard that
966automatically calls C<db_del> when it is destroyed.
967
968=item db_del $family => $subkey...
969
970Deletes one or more subkeys from the database family.
971
972=item $guard = db_reg $family => $port => $value
973
974=item $guard = db_reg $family => $port
975
976=item $guard = db_reg $family
977
978Registers a port in the given family and optionally returns a guard to
979remove it.
980
981This function basically does the same as:
982
983 db_set $family => $port => $value
984
985Except that the port is monitored and automatically removed from the
986database family when it is kil'ed.
987
988If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
989C<$SELF> is used.
990
991This function is most useful to register a port in some port group (which
992is just another name for a database family), and have it removed when the
993port is gone. This works best when the port is a local port.
994
995=cut
996
997sub db_reg($$;$) {
998 my $family = shift;
999 my $port = @_ ? shift : $SELF;
1000
1001 my $clr = sub { db_del $family => $port };
1002 mon $port, $clr;
1003
1004 db_set $family => $port => $_[0];
1005
1006 defined wantarray
1007 and &Guard::guard ($clr)
1008}
1009
1010=item db_family $family => $cb->(\%familyhash)
1011
1012Queries the named database C<$family> and call the callback with the
1013family represented as a hash. You can keep and freely modify the hash.
1014
1015=item db_keys $family => $cb->(\@keys)
1016
1017Same as C<db_family>, except it only queries the family I<subkeys> and passes
1018them as array reference to the callback.
1019
1020=item db_values $family => $cb->(\@values)
1021
1022Same as C<db_family>, except it only queries the family I<values> and passes them
1023as array reference to the callback.
1024
1025=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
1026
1027Creates a monitor on the given database family. Each time a key is set
1028or or is deleted the callback is called with a hash containing the
1029database family and three lists of added, changed and deleted subkeys,
1030respectively. If no keys have changed then the array reference might be
1031C<undef> or even missing.
1032
1033If not called in void context, a guard object is returned that, when
1034destroyed, stops the monitor.
1035
1036The family hash reference and the key arrays belong to AnyEvent::MP and
1037B<must not be modified or stored> by the callback. When in doubt, make a
1038copy.
1039
1040As soon as possible after the monitoring starts, the callback will be
1041called with the intiial contents of the family, even if it is empty,
1042i.e. there will always be a timely call to the callback with the current
1043contents.
1044
1045It is possible that the callback is called with a change event even though
1046the subkey is already present and the value has not changed.
1047
1048The monitoring stops when the guard object is destroyed.
1049
1050Example: on every change to the family "mygroup", print out all keys.
1051
1052 my $guard = db_mon mygroup => sub {
1053 my ($family, $a, $c, $d) = @_;
1054 print "mygroup members: ", (join " ", keys %$family), "\n";
1055 };
1056
1057Exmaple: wait until the family "My::Module::workers" is non-empty.
1058
1059 my $guard; $guard = db_mon My::Module::workers => sub {
1060 my ($family, $a, $c, $d) = @_;
1061 return unless %$family;
1062 undef $guard;
1063 print "My::Module::workers now nonempty\n";
1064 };
1065
1066Example: print all changes to the family "AnyRvent::Fantasy::Module".
1067
1068 my $guard = db_mon AnyRvent::Fantasy::Module => sub {
1069 my ($family, $a, $c, $d) = @_;
1070
1071 print "+$_=$family->{$_}\n" for @$a;
1072 print "*$_=$family->{$_}\n" for @$c;
1073 print "-$_=$family->{$_}\n" for @$d;
1074 };
1075
1076=cut
1077
707=back 1078=back
708 1079
709=head1 AnyEvent::MP vs. Distributed Erlang 1080=head1 AnyEvent::MP vs. Distributed Erlang
710 1081
711AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 1082AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
712== aemp node, Erlang process == aemp port), so many of the documents and 1083== aemp node, Erlang process == aemp port), so many of the documents and
713programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 1084programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
714sample: 1085sample:
715 1086
716 http://www.Erlang.se/doc/programming_rules.shtml 1087 http://www.erlang.se/doc/programming_rules.shtml
717 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 1088 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
718 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 1089 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
719 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 1090 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
720 1091
721Despite the similarities, there are also some important differences: 1092Despite the similarities, there are also some important differences:
722 1093
723=over 4 1094=over 4
724 1095
725=item * Node IDs are arbitrary strings in AEMP. 1096=item * Node IDs are arbitrary strings in AEMP.
726 1097
727Erlang relies on special naming and DNS to work everywhere in the same 1098Erlang relies on special naming and DNS to work everywhere in the same
728way. AEMP relies on each node somehow knowing its own address(es) (e.g. by 1099way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
729configuration or DNS), but will otherwise discover other odes itself. 1100configuration or DNS), and possibly the addresses of some seed nodes, but
1101will otherwise discover other nodes (and their IDs) itself.
730 1102
731=item * Erlang has a "remote ports are like local ports" philosophy, AEMP 1103=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
732uses "local ports are like remote ports". 1104uses "local ports are like remote ports".
733 1105
734The failure modes for local ports are quite different (runtime errors 1106The failure modes for local ports are quite different (runtime errors
743ports being the special case/exception, where transport errors cannot 1115ports being the special case/exception, where transport errors cannot
744occur. 1116occur.
745 1117
746=item * Erlang uses processes and a mailbox, AEMP does not queue. 1118=item * Erlang uses processes and a mailbox, AEMP does not queue.
747 1119
748Erlang uses processes that selectively receive messages, and therefore 1120Erlang uses processes that selectively receive messages out of order, and
749needs a queue. AEMP is event based, queuing messages would serve no 1121therefore needs a queue. AEMP is event based, queuing messages would serve
750useful purpose. For the same reason the pattern-matching abilities of 1122no useful purpose. For the same reason the pattern-matching abilities
751AnyEvent::MP are more limited, as there is little need to be able to 1123of AnyEvent::MP are more limited, as there is little need to be able to
752filter messages without dequeuing them. 1124filter messages without dequeuing them.
753 1125
754(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). 1126This is not a philosophical difference, but simply stems from AnyEvent::MP
1127being event-based, while Erlang is process-based.
1128
1129You cna have a look at L<Coro::MP> for a more Erlang-like process model on
1130top of AEMP and Coro threads.
755 1131
756=item * Erlang sends are synchronous, AEMP sends are asynchronous. 1132=item * Erlang sends are synchronous, AEMP sends are asynchronous.
757 1133
758Sending messages in Erlang is synchronous and blocks the process (and 1134Sending messages in Erlang is synchronous and blocks the process until
1135a conenction has been established and the message sent (and so does not
759so does not need a queue that can overflow). AEMP sends are immediate, 1136need a queue that can overflow). AEMP sends return immediately, connection
760connection establishment is handled in the background. 1137establishment is handled in the background.
761 1138
762=item * Erlang suffers from silent message loss, AEMP does not. 1139=item * Erlang suffers from silent message loss, AEMP does not.
763 1140
764Erlang makes few guarantees on messages delivery - messages can get lost 1141Erlang implements few guarantees on messages delivery - messages can get
765without any of the processes realising it (i.e. you send messages a, b, 1142lost without any of the processes realising it (i.e. you send messages a,
766and c, and the other side only receives messages a and c). 1143b, and c, and the other side only receives messages a and c).
767 1144
768AEMP guarantees correct ordering, and the guarantee that after one message 1145AEMP guarantees (modulo hardware errors) correct ordering, and the
769is lost, all following ones sent to the same port are lost as well, until 1146guarantee that after one message is lost, all following ones sent to the
770monitoring raises an error, so there are no silent "holes" in the message 1147same port are lost as well, until monitoring raises an error, so there are
771sequence. 1148no silent "holes" in the message sequence.
1149
1150If you want your software to be very reliable, you have to cope with
1151corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
1152simply tries to work better in common error cases, such as when a network
1153link goes down.
772 1154
773=item * Erlang can send messages to the wrong port, AEMP does not. 1155=item * Erlang can send messages to the wrong port, AEMP does not.
774 1156
775In Erlang it is quite likely that a node that restarts reuses a process ID 1157In Erlang it is quite likely that a node that restarts reuses an Erlang
776known to other nodes for a completely different process, causing messages 1158process ID known to other nodes for a completely different process,
777destined for that process to end up in an unrelated process. 1159causing messages destined for that process to end up in an unrelated
1160process.
778 1161
779AEMP never reuses port IDs, so old messages or old port IDs floating 1162AEMP does not reuse port IDs, so old messages or old port IDs floating
780around in the network will not be sent to an unrelated port. 1163around in the network will not be sent to an unrelated port.
781 1164
782=item * Erlang uses unprotected connections, AEMP uses secure 1165=item * Erlang uses unprotected connections, AEMP uses secure
783authentication and can use TLS. 1166authentication and can use TLS.
784 1167
787 1170
788=item * The AEMP protocol is optimised for both text-based and binary 1171=item * The AEMP protocol is optimised for both text-based and binary
789communications. 1172communications.
790 1173
791The AEMP protocol, unlike the Erlang protocol, supports both programming 1174The AEMP protocol, unlike the Erlang protocol, supports both programming
792language independent text-only protocols (good for debugging) and binary, 1175language independent text-only protocols (good for debugging), and binary,
793language-specific serialisers (e.g. Storable). By default, unless TLS is 1176language-specific serialisers (e.g. Storable). By default, unless TLS is
794used, the protocol is actually completely text-based. 1177used, the protocol is actually completely text-based.
795 1178
796It has also been carefully designed to be implementable in other languages 1179It has also been carefully designed to be implementable in other languages
797with a minimum of work while gracefully degrading functionality to make the 1180with a minimum of work while gracefully degrading functionality to make the
798protocol simple. 1181protocol simple.
799 1182
800=item * AEMP has more flexible monitoring options than Erlang. 1183=item * AEMP has more flexible monitoring options than Erlang.
801 1184
802In Erlang, you can chose to receive I<all> exit signals as messages 1185In Erlang, you can chose to receive I<all> exit signals as messages or
803or I<none>, there is no in-between, so monitoring single processes is 1186I<none>, there is no in-between, so monitoring single Erlang processes is
804difficult to implement. Monitoring in AEMP is more flexible than in 1187difficult to implement.
805Erlang, as one can choose between automatic kill, exit message or callback 1188
806on a per-process basis. 1189Monitoring in AEMP is more flexible than in Erlang, as one can choose
1190between automatic kill, exit message or callback on a per-port basis.
807 1191
808=item * Erlang tries to hide remote/local connections, AEMP does not. 1192=item * Erlang tries to hide remote/local connections, AEMP does not.
809 1193
810Monitoring in Erlang is not an indicator of process death/crashes, in the 1194Monitoring in Erlang is not an indicator of process death/crashes, in the
811same way as linking is (except linking is unreliable in Erlang). 1195same way as linking is (except linking is unreliable in Erlang).
833overhead, as well as having to keep a proxy object everywhere. 1217overhead, as well as having to keep a proxy object everywhere.
834 1218
835Strings can easily be printed, easily serialised etc. and need no special 1219Strings can easily be printed, easily serialised etc. and need no special
836procedures to be "valid". 1220procedures to be "valid".
837 1221
838And as a result, a miniport consists of a single closure stored in a 1222And as a result, a port with just a default receiver consists of a single
839global hash - it can't become much cheaper. 1223code reference stored in a global hash - it can't become much cheaper.
840 1224
841=item Why favour JSON, why not a real serialising format such as Storable? 1225=item Why favour JSON, why not a real serialising format such as Storable?
842 1226
843In fact, any AnyEvent::MP node will happily accept Storable as framing 1227In fact, any AnyEvent::MP node will happily accept Storable as framing
844format, but currently there is no way to make a node use Storable by 1228format, but currently there is no way to make a node use Storable by
854Keeping your messages simple, concentrating on data structures rather than 1238Keeping your messages simple, concentrating on data structures rather than
855objects, will keep your messages clean, tidy and efficient. 1239objects, will keep your messages clean, tidy and efficient.
856 1240
857=back 1241=back
858 1242
1243=head1 PORTING FROM AnyEvent::MP VERSION 1.X
1244
1245AEMP version 2 has a few major incompatible changes compared to version 1:
1246
1247=over 4
1248
1249=item AnyEvent::MP::Global no longer has group management functions.
1250
1251At least not officially - the grp_* functions are still exported and might
1252work, but they will be removed in some later release.
1253
1254AnyEvent::MP now comes with a distributed database that is more
1255powerful. Its database families map closely to port groups, but the API
1256has changed (the functions are also now exported by AnyEvent::MP). Here is
1257a rough porting guide:
1258
1259 grp_reg $group, $port # old
1260 db_reg $group, $port # new
1261
1262 $list = grp_get $group # old
1263 db_keys $group, sub { my $list = shift } # new
1264
1265 grp_mon $group, $cb->(\@ports, $add, $del) # old
1266 db_mon $group, $cb->(\%ports, $add, $change, $del) # new
1267
1268C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> is
1269no longer instant, because the local node might not have a copy of the
1270group. You can either modify your code to allow for a callback, or use
1271C<db_mon> to keep an updated copy of the group:
1272
1273 my $local_group_copy;
1274 db_mon $group => sub { $local_group_copy = $_[0] };
1275
1276 # now "keys %$local_group_copy" always returns the most up-to-date
1277 # list of ports in the group.
1278
1279C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon>
1280passes a hash as first argument, and an extra C<$chg> argument that can be
1281ignored:
1282
1283 db_mon $group => sub {
1284 my ($ports, $add, $chg, $lde) = @_;
1285 $ports = [keys %$ports];
1286
1287 # now $ports, $add and $del are the same as
1288 # were originally passed by grp_mon.
1289 ...
1290 };
1291
1292=item Nodes not longer connect to all other nodes.
1293
1294In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
1295module, which in turn would create connections to all other nodes in the
1296network (helped by the seed nodes).
1297
1298In version 2.x, global nodes still connect to all other global nodes, but
1299other nodes don't - now every node either is a global node itself, or
1300attaches itself to another global node.
1301
1302If a node isn't a global node itself, then it attaches itself to one
1303of its seed nodes. If that seed node isn't a global node yet, it will
1304automatically be upgraded to a global node.
1305
1306So in many cases, nothing needs to be changed - one just has to make sure
1307that all seed nodes are meshed together with the other seed nodes (as with
1308AEMP 1.x), and other nodes specify them as seed nodes. This is most easily
1309achieved by specifying the same set of seed nodes for all nodes in the
1310network.
1311
1312Not opening a connection to every other node is usually an advantage,
1313except when you need the lower latency of an already established
1314connection. To ensure a node establishes a connection to another node,
1315you can monitor the node port (C<mon $node, ...>), which will attempt to
1316create the connection (and notify you when the connection fails).
1317
1318=item Listener-less nodes (nodes without binds) are gone.
1319
1320And are not coming back, at least not in their old form. If no C<binds>
1321are specified for a node, AnyEvent::MP assumes a default of C<*:*>.
1322
1323There are vague plans to implement some form of routing domains, which
1324might or might not bring back listener-less nodes, but don't count on it.
1325
1326The fact that most connections are now optional somewhat mitigates this,
1327as a node can be effectively unreachable from the outside without any
1328problems, as long as it isn't a global node and only reaches out to other
1329nodes (as opposed to being contacted from other nodes).
1330
1331=item $AnyEvent::MP::Kernel::WARN has gone.
1332
1333AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
1334uses this, and so should your programs.
1335
1336Every module now documents what kinds of messages it generates, with
1337AnyEvent::MP acting as a catch all.
1338
1339On the positive side, this means that instead of setting
1340C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE> -
1341much less to type.
1342
1343=back
1344
1345=head1 LOGGING
1346
1347AnyEvent::MP does not normally log anything by itself, but sinc eit is the
1348root of the contetx hierarchy for AnyEvent::MP modules, it will receive
1349all log messages by submodules.
1350
859=head1 SEE ALSO 1351=head1 SEE ALSO
860 1352
861L<AnyEvent::MP::Intro> - a gentle introduction. 1353L<AnyEvent::MP::Intro> - a gentle introduction.
862 1354
863L<AnyEvent::MP::Kernel> - more, lower-level, stuff. 1355L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
864 1356
865L<AnyEvent::MP::Global> - network maintainance and port groups, to find 1357L<AnyEvent::MP::Global> - network maintenance and port groups, to find
866your applications. 1358your applications.
1359
1360L<AnyEvent::MP::DataConn> - establish data connections between nodes.
867 1361
868L<AnyEvent::MP::LogCatcher> - simple service to display log messages from 1362L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
869all nodes. 1363all nodes.
870 1364
871L<AnyEvent>. 1365L<AnyEvent>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines