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.84 by root, Tue Sep 8 01:42:14 2009 UTC vs.
Revision 1.122 by root, Wed Feb 29 18:44:59 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 $localport, $cb->(@msg) # callback is invoked on death
37 mon $port, $otherport # kill otherport on abnormal death 41 mon $localport, $otherport # kill otherport on abnormal death
38 mon $port, $otherport, @msg # send message on death 42 mon $localport, $otherport, @msg # send message on death
43
44 # temporarily execute code in port context
45 peval $port, sub { die "kill the port!" };
46
47 # execute callbacks in $SELF port context
48 my $timer = AE::timer 1, 0, psub {
49 die "kill the port, delayed";
50 };
39 51
40=head1 CURRENT STATUS 52=head1 CURRENT STATUS
41 53
42 bin/aemp - stable. 54 bin/aemp - stable.
43 AnyEvent::MP - stable API, should work. 55 AnyEvent::MP - stable API, should work.
44 AnyEvent::MP::Intro - explains most concepts. 56 AnyEvent::MP::Intro - explains most concepts.
45 AnyEvent::MP::Kernel - mostly stable. 57 AnyEvent::MP::Kernel - mostly stable API.
46 AnyEvent::MP::Global - stable but incomplete, protocol not yet final. 58 AnyEvent::MP::Global - stable API.
47
48stay tuned.
49 59
50=head1 DESCRIPTION 60=head1 DESCRIPTION
51 61
52This module (-family) implements a simple message passing framework. 62This module (-family) implements a simple message passing framework.
53 63
68 78
69Ports allow you to register C<rcv> handlers that can match all or just 79Ports 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 80some messages. Messages send to ports will not be queued, regardless of
71anything was listening for them or not. 81anything was listening for them or not.
72 82
83Ports are represented by (printable) strings called "port IDs".
84
73=item port ID - C<nodeid#portname> 85=item port ID - C<nodeid#portname>
74 86
75A port ID is the concatenation of a node ID, a hash-mark (C<#>) as 87A port ID is the concatenation of a node ID, a hash-mark (C<#>) as
76separator, and a port name (a printable string of unspecified format). 88separator, and a port name (a printable string of unspecified format).
77 89
81which enables nodes to manage each other remotely, and to create new 93which enables nodes to manage each other remotely, and to create new
82ports. 94ports.
83 95
84Nodes are either public (have one or more listening ports) or private 96Nodes are either public (have one or more listening ports) or private
85(no listening ports). Private nodes cannot talk to other private nodes 97(no listening ports). Private nodes cannot talk to other private nodes
86currently. 98currently, but all nodes can talk to public nodes.
87 99
100Nodes is represented by (printable) strings called "node IDs".
101
88=item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*> 102=item node ID - C<[A-Za-z0-9_\-.:]*>
89 103
90A node ID is a string that uniquely identifies the node within a 104A node ID is a string that uniquely identifies the node within a
91network. Depending on the configuration used, node IDs can look like a 105network. Depending on the configuration used, node IDs can look like a
92hostname, a hostname and a port, or a random string. AnyEvent::MP itself 106hostname, a hostname and a port, or a random string. AnyEvent::MP itself
93doesn't interpret node IDs in any way. 107doesn't interpret node IDs in any way except to uniquely identify a node.
94 108
95=item binds - C<ip:port> 109=item binds - C<ip:port>
96 110
97Nodes can only talk to each other by creating some kind of connection to 111Nodes 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 112each other. To do this, nodes should listen on one or more local transport
113endpoints - binds.
114
99endpoints - binds. Currently, only standard C<ip:port> specifications can 115Currently, only standard C<ip:port> specifications can be used, which
100be used, which specify TCP ports to listen on. 116specify TCP ports to listen on. So a bind is basically just a tcp socket
117in listening mode thta accepts conenctions form other nodes.
101 118
102=item seed nodes 119=item seed nodes
103 120
104When a node starts, it knows nothing about the network. To teach the node 121When a node starts, it knows nothing about the network it is in - it
105about the network it first has to contact some other node within the 122needs to connect to at least one other node that is already in the
106network. This node is called a seed. 123network. These other nodes are called "seed nodes".
107 124
108Apart from the fact that other nodes know them as seed nodes and they have 125Seed nodes themselves are not special - they are seed nodes only because
109to have fixed listening addresses, seed nodes are perfectly normal nodes - 126some other node I<uses> them as such, but any node can be used as seed
110any node can function as a seed node for others. 127node for other nodes, and eahc node cna use a different set of seed nodes.
111 128
112In addition to discovering the network, seed nodes are also used to 129In addition to discovering the network, seed nodes are also used to
113maintain the network and to connect nodes that otherwise would have 130maintain the network - all nodes using the same seed node form are part of
114trouble connecting. They form the backbone of the AnyEvent::MP network. 131the same network. If a network is split into multiple subnets because e.g.
132the network link between the parts goes down, then using the same seed
133nodes for all nodes ensures that eventually the subnets get merged again.
115 134
116Seed nodes are expected to be long-running, and at least one seed node 135Seed nodes are expected to be long-running, and at least one seed node
117should always be available. 136should always be available. They should also be relatively responsive - a
137seed node that blocks for long periods will slow down everybody else.
118 138
139For small networks, it's best if every node uses the same set of seed
140nodes. For large networks, it can be useful to specify "regional" seed
141nodes for most nodes in an area, and use all seed nodes as seed nodes for
142each other. What's important is that all seed nodes connections form a
143complete graph, so that the network cannot split into separate subnets
144forever.
145
146Seed nodes are represented by seed IDs.
147
119=item seeds - C<host:port> 148=item seed IDs - C<host:port>
120 149
121Seeds are transport endpoint(s) (usually a hostname/IP address and a 150Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
122TCP port) of nodes thta should be used as seed nodes. 151TCP port) of nodes that should be used as seed nodes.
123 152
124The nodes listening on those endpoints are expected to be long-running, 153=item global nodes
125and at least one of those should always be available. When nodes run out 154
126of connections (e.g. due to a network error), they try to re-establish 155An AEMP network needs a discovery service - nodes need to know how to
127connections to some seednodes again to join the network. 156connect to other nodes they only know by name. In addition, AEMP offers a
157distributed "group database", which maps group names to a list of strings
158- for example, to register worker ports.
159
160A network needs at least one global node to work, and allows every node to
161be a global node.
162
163Any node that loads the L<AnyEvent::MP::Global> module becomes a global
164node and tries to keep connections to all other nodes. So while it can
165make sense to make every node "global" in small networks, it usually makes
166sense to only make seed nodes into global nodes in large networks (nodes
167keep connections to seed nodes and global nodes, so makign them the same
168reduces overhead).
128 169
129=back 170=back
130 171
131=head1 VARIABLES/FUNCTIONS 172=head1 VARIABLES/FUNCTIONS
132 173
134 175
135=cut 176=cut
136 177
137package AnyEvent::MP; 178package AnyEvent::MP;
138 179
180use AnyEvent::MP::Config ();
139use AnyEvent::MP::Kernel; 181use AnyEvent::MP::Kernel;
182use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
140 183
141use common::sense; 184use common::sense;
142 185
143use Carp (); 186use Carp ();
144 187
145use AE (); 188use AE ();
146 189
147use base "Exporter"; 190use base "Exporter";
148 191
149our $VERSION = $AnyEvent::MP::Kernel::VERSION; 192our $VERSION = $AnyEvent::MP::Config::VERSION;
150 193
151our @EXPORT = qw( 194our @EXPORT = qw(
152 NODE $NODE *SELF node_of after 195 NODE $NODE *SELF node_of after
153 configure 196 configure
154 snd rcv mon mon_guard kil reg psub spawn 197 snd rcv mon mon_guard kil psub peval spawn cal
155 port 198 port
156); 199);
157 200
158our $SELF; 201our $SELF;
159 202
182to know is its own name, and optionally it should know the addresses of 225to know is its own name, and optionally it should know the addresses of
183some other nodes in the network to discover other nodes. 226some other nodes in the network to discover other nodes.
184 227
185This function configures a node - it must be called exactly once (or 228This function configures a node - it must be called exactly once (or
186never) before calling other AnyEvent::MP functions. 229never) before calling other AnyEvent::MP functions.
230
231The key/value pairs are basically the same ones as documented for the
232F<aemp> command line utility (sans the set/del prefix), with two additions:
233
234=over 4
235
236=item norc => $boolean (default false)
237
238If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
239be consulted - all configuraiton options must be specified in the
240C<configure> call.
241
242=item force => $boolean (default false)
243
244IF true, then the values specified in the C<configure> will take
245precedence over any values configured via the rc file. The default is for
246the rc file to override any options specified in the program.
247
248=back
187 249
188=over 4 250=over 4
189 251
190=item step 1, gathering configuration from profiles 252=item step 1, gathering configuration from profiles
191 253
205That means that the values specified in the profile have highest priority 267That means that the values specified in the profile have highest priority
206and the values specified directly via C<configure> have lowest priority, 268and the values specified directly via C<configure> have lowest priority,
207and can only be used to specify defaults. 269and can only be used to specify defaults.
208 270
209If the profile specifies a node ID, then this will become the node ID of 271If the profile specifies a node ID, then this will become the node ID of
210this process. If not, then the profile name will be used as node ID. The 272this process. If not, then the profile name will be used as node ID, with
211special node ID of C<anon/> will be replaced by a random node ID. 273a slash (C</>) attached.
274
275If the node ID (or profile name) ends with a slash (C</>), then a random
276string is appended to make it unique.
212 277
213=item step 2, bind listener sockets 278=item step 2, bind listener sockets
214 279
215The next step is to look up the binds in the profile, followed by binding 280The next step is to look up the binds in the profile, followed by binding
216aemp protocol listeners on all binds specified (it is possible and valid 281aemp protocol listeners on all binds specified (it is possible and valid
222used, meaning the node will bind on a dynamically-assigned port on every 287used, meaning the node will bind on a dynamically-assigned port on every
223local IP address it finds. 288local IP address it finds.
224 289
225=item step 3, connect to seed nodes 290=item step 3, connect to seed nodes
226 291
227As the last step, the seeds list from the profile is passed to the 292As the last step, the seed ID list from the profile is passed to the
228L<AnyEvent::MP::Global> module, which will then use it to keep 293L<AnyEvent::MP::Global> module, which will then use it to keep
229connectivity with at least one node at any point in time. 294connectivity with at least one node at any point in time.
230 295
231=back 296=back
232 297
233Example: become a distributed node using the locla node name as profile. 298Example: become a distributed node using the local node name as profile.
234This should be the most common form of invocation for "daemon"-type nodes. 299This should be the most common form of invocation for "daemon"-type nodes.
235 300
236 configure 301 configure
237 302
238Example: become an anonymous node. This form is often used for commandline 303Example: become an anonymous node. This form is often used for commandline
239clients. 304clients.
240 305
241 configure nodeid => "anon/"; 306 configure nodeid => "anon/";
242 307
243Example: configure a node using a profile called seed, which si suitable 308Example: configure a node using a profile called seed, which is suitable
244for a seed node as it binds on all local addresses on a fixed port (4040, 309for a seed node as it binds on all local addresses on a fixed port (4040,
245customary for aemp). 310customary for aemp).
246 311
247 # use the aemp commandline utility 312 # use the aemp commandline utility
248 # aemp profile seed nodeid anon/ binds '*:4040' 313 # aemp profile seed binds '*:4040'
249 314
250 # then use it 315 # then use it
251 configure profile => "seed"; 316 configure profile => "seed";
252 317
253 # or simply use aemp from the shell again: 318 # or simply use aemp from the shell again:
323sub _kilme { 388sub _kilme {
324 die "received message on port without callback"; 389 die "received message on port without callback";
325} 390}
326 391
327sub port(;&) { 392sub port(;&) {
328 my $id = "$UNIQ." . $ID++; 393 my $id = "$UNIQ." . ++$ID;
329 my $port = "$NODE#$id"; 394 my $port = "$NODE#$id";
330 395
331 rcv $port, shift || \&_kilme; 396 rcv $port, shift || \&_kilme;
332 397
333 $port 398 $port
372 msg1 => sub { ... }, 437 msg1 => sub { ... },
373 ... 438 ...
374 ; 439 ;
375 440
376Example: temporarily register a rcv callback for a tag matching some port 441Example: temporarily register a rcv callback for a tag matching some port
377(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.
378 443
379 rcv $port, $otherport => sub { 444 rcv $port, $otherport => sub {
380 my @reply = @_; 445 my @reply = @_;
381 446
382 rcv $SELF, $otherport; 447 rcv $SELF, $otherport;
395 if (ref $_[0]) { 460 if (ref $_[0]) {
396 if (my $self = $PORT_DATA{$portid}) { 461 if (my $self = $PORT_DATA{$portid}) {
397 "AnyEvent::MP::Port" eq ref $self 462 "AnyEvent::MP::Port" eq ref $self
398 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";
399 464
400 $self->[2] = shift; 465 $self->[0] = shift;
401 } else { 466 } else {
402 my $cb = shift; 467 my $cb = shift;
403 $PORT{$portid} = sub { 468 $PORT{$portid} = sub {
404 local $SELF = $port; 469 local $SELF = $port;
405 eval { &$cb }; _self_die if $@; 470 eval { &$cb }; _self_die if $@;
406 }; 471 };
407 } 472 }
408 } elsif (defined $_[0]) { 473 } elsif (defined $_[0]) {
409 my $self = $PORT_DATA{$portid} ||= do { 474 my $self = $PORT_DATA{$portid} ||= do {
410 my $self = bless [$PORT{$port} || sub { }, { }, $port], "AnyEvent::MP::Port"; 475 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
411 476
412 $PORT{$portid} = sub { 477 $PORT{$portid} = sub {
413 local $SELF = $port; 478 local $SELF = $port;
414 479
415 if (my $cb = $self->[1]{$_[0]}) { 480 if (my $cb = $self->[1]{$_[0]}) {
437 } 502 }
438 503
439 $port 504 $port
440} 505}
441 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
442=item $closure = psub { BLOCK } 544=item $closure = psub { BLOCK }
443 545
444Remembers 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
445closure 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>
446callbacks, 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 }, @_ } >>.
447 552
448This is useful when you register callbacks from C<rcv> callbacks: 553This is useful when you register callbacks from C<rcv> callbacks:
449 554
450 rcv delayed_reply => sub { 555 rcv delayed_reply => sub {
451 my ($delay, @reply) = @_; 556 my ($delay, @reply) = @_;
524delivered again. 629delivered again.
525 630
526Inter-host-connection timeouts and monitoring depend on the transport 631Inter-host-connection timeouts and monitoring depend on the transport
527used. The only transport currently implemented is TCP, and AnyEvent::MP 632used. The only transport currently implemented is TCP, and AnyEvent::MP
528relies on TCP to detect node-downs (this can take 10-15 minutes on a 633relies on TCP to detect node-downs (this can take 10-15 minutes on a
529non-idle connection, and usually around two hours for idle conenctions). 634non-idle connection, and usually around two hours for idle connections).
530 635
531This means that monitoring is good for program errors and cleaning up 636This means that monitoring is good for program errors and cleaning up
532stuff eventually, but they are no replacement for a timeout when you need 637stuff eventually, but they are no replacement for a timeout when you need
533to ensure some maximum latency. 638to ensure some maximum latency.
534 639
566 } 671 }
567 672
568 $node->monitor ($port, $cb); 673 $node->monitor ($port, $cb);
569 674
570 defined wantarray 675 defined wantarray
571 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 676 and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
572} 677}
573 678
574=item $guard = mon_guard $port, $ref, $ref... 679=item $guard = mon_guard $port, $ref, $ref...
575 680
576Monitors the given C<$port> and keeps the passed references. When the port 681Monitors the given C<$port> and keeps the passed references. When the port
599 704
600=item kil $port[, @reason] 705=item kil $port[, @reason]
601 706
602Kill the specified port with the given C<@reason>. 707Kill the specified port with the given C<@reason>.
603 708
604If no C<@reason> is specified, then the port is killed "normally" (ports 709If no C<@reason> is specified, then the port is killed "normally" -
605monitoring other ports will not necessarily die because a port dies 710monitor callback will be invoked, but the kil will not cause linked ports
606"normally"). 711(C<mon $mport, $lport> form) to get killed.
607 712
608Otherwise, linked ports get killed with the same reason (second form of 713If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
609C<mon>, see above). 714form) get killed with the same reason.
610 715
611Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks 716Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
612will be reported as reason C<< die => $@ >>. 717will be reported as reason C<< die => $@ >>.
613 718
614Transport/communication errors are reported as C<< transport_error => 719Transport/communication errors are reported as C<< transport_error =>
680} 785}
681 786
682sub spawn(@) { 787sub spawn(@) {
683 my ($nodeid, undef) = split /#/, shift, 2; 788 my ($nodeid, undef) = split /#/, shift, 2;
684 789
685 my $id = "$RUNIQ." . $ID++; 790 my $id = "$RUNIQ." . ++$ID;
686 791
687 $_[0] =~ /::/ 792 $_[0] =~ /::/
688 or Carp::croak "spawn init function must be a fully-qualified name, caught"; 793 or Carp::croak "spawn init function must be a fully-qualified name, caught";
689 794
690 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_; 795 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
691 796
692 "$nodeid#$id" 797 "$nodeid#$id"
693} 798}
799
694 800
695=item after $timeout, @msg 801=item after $timeout, @msg
696 802
697=item after $timeout, $callback 803=item after $timeout, $callback
698 804
714 ? $action[0]() 820 ? $action[0]()
715 : snd @action; 821 : snd @action;
716 }; 822 };
717} 823}
718 824
825=item cal $port, @msg, $callback[, $timeout]
826
827A simple form of RPC - sends a message to the given C<$port> with the
828given contents (C<@msg>), but adds a reply port to the message.
829
830The reply port is created temporarily just for the purpose of receiving
831the reply, and will be C<kil>ed when no longer needed.
832
833A reply message sent to the port is passed to the C<$callback> as-is.
834
835If an optional time-out (in seconds) is given and it is not C<undef>,
836then the callback will be called without any arguments after the time-out
837elapsed and the port is C<kil>ed.
838
839If no time-out is given (or it is C<undef>), then the local port will
840monitor the remote port instead, so it eventually gets cleaned-up.
841
842Currently this function returns the temporary port, but this "feature"
843might go in future versions unless you can make a convincing case that
844this is indeed useful for something.
845
846=cut
847
848sub cal(@) {
849 my $timeout = ref $_[-1] ? undef : pop;
850 my $cb = pop;
851
852 my $port = port {
853 undef $timeout;
854 kil $SELF;
855 &$cb;
856 };
857
858 if (defined $timeout) {
859 $timeout = AE::timer $timeout, 0, sub {
860 undef $timeout;
861 kil $port;
862 $cb->();
863 };
864 } else {
865 mon $_[0], sub {
866 kil $port;
867 $cb->();
868 };
869 }
870
871 push @_, $port;
872 &snd;
873
874 $port
875}
876
719=back 877=back
720 878
721=head1 AnyEvent::MP vs. Distributed Erlang 879=head1 AnyEvent::MP vs. Distributed Erlang
722 880
723AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 881AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
724== aemp node, Erlang process == aemp port), so many of the documents and 882== aemp node, Erlang process == aemp port), so many of the documents and
725programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 883programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
726sample: 884sample:
727 885
728 http://www.Erlang.se/doc/programming_rules.shtml 886 http://www.erlang.se/doc/programming_rules.shtml
729 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 887 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
730 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 888 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
731 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 889 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
732 890
733Despite the similarities, there are also some important differences: 891Despite the similarities, there are also some important differences:
734 892
735=over 4 893=over 4
736 894
737=item * Node IDs are arbitrary strings in AEMP. 895=item * Node IDs are arbitrary strings in AEMP.
738 896
739Erlang relies on special naming and DNS to work everywhere in the same 897Erlang relies on special naming and DNS to work everywhere in the same
740way. AEMP relies on each node somehow knowing its own address(es) (e.g. by 898way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
741configuration or DNS), but will otherwise discover other odes itself. 899configuration or DNS), and possibly the addresses of some seed nodes, but
900will otherwise discover other nodes (and their IDs) itself.
742 901
743=item * Erlang has a "remote ports are like local ports" philosophy, AEMP 902=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
744uses "local ports are like remote ports". 903uses "local ports are like remote ports".
745 904
746The failure modes for local ports are quite different (runtime errors 905The failure modes for local ports are quite different (runtime errors
755ports being the special case/exception, where transport errors cannot 914ports being the special case/exception, where transport errors cannot
756occur. 915occur.
757 916
758=item * Erlang uses processes and a mailbox, AEMP does not queue. 917=item * Erlang uses processes and a mailbox, AEMP does not queue.
759 918
760Erlang uses processes that selectively receive messages, and therefore 919Erlang uses processes that selectively receive messages out of order, and
761needs a queue. AEMP is event based, queuing messages would serve no 920therefore needs a queue. AEMP is event based, queuing messages would serve
762useful purpose. For the same reason the pattern-matching abilities of 921no useful purpose. For the same reason the pattern-matching abilities
763AnyEvent::MP are more limited, as there is little need to be able to 922of AnyEvent::MP are more limited, as there is little need to be able to
764filter messages without dequeuing them. 923filter messages without dequeuing them.
765 924
766(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). 925This is not a philosophical difference, but simply stems from AnyEvent::MP
926being event-based, while Erlang is process-based.
927
928You cna have a look at L<Coro::MP> for a more Erlang-like process model on
929top of AEMP and Coro threads.
767 930
768=item * Erlang sends are synchronous, AEMP sends are asynchronous. 931=item * Erlang sends are synchronous, AEMP sends are asynchronous.
769 932
770Sending messages in Erlang is synchronous and blocks the process (and 933Sending messages in Erlang is synchronous and blocks the process until
934a conenction has been established and the message sent (and so does not
771so does not need a queue that can overflow). AEMP sends are immediate, 935need a queue that can overflow). AEMP sends return immediately, connection
772connection establishment is handled in the background. 936establishment is handled in the background.
773 937
774=item * Erlang suffers from silent message loss, AEMP does not. 938=item * Erlang suffers from silent message loss, AEMP does not.
775 939
776Erlang makes few guarantees on messages delivery - messages can get lost 940Erlang implements few guarantees on messages delivery - messages can get
777without any of the processes realising it (i.e. you send messages a, b, 941lost without any of the processes realising it (i.e. you send messages a,
778and c, and the other side only receives messages a and c). 942b, and c, and the other side only receives messages a and c).
779 943
780AEMP guarantees correct ordering, and the guarantee that after one message 944AEMP guarantees (modulo hardware errors) correct ordering, and the
781is lost, all following ones sent to the same port are lost as well, until 945guarantee that after one message is lost, all following ones sent to the
782monitoring raises an error, so there are no silent "holes" in the message 946same port are lost as well, until monitoring raises an error, so there are
783sequence. 947no silent "holes" in the message sequence.
948
949If you want your software to be very reliable, you have to cope with
950corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
951simply tries to work better in common error cases, such as when a network
952link goes down.
784 953
785=item * Erlang can send messages to the wrong port, AEMP does not. 954=item * Erlang can send messages to the wrong port, AEMP does not.
786 955
787In Erlang it is quite likely that a node that restarts reuses a process ID 956In Erlang it is quite likely that a node that restarts reuses an Erlang
788known to other nodes for a completely different process, causing messages 957process ID known to other nodes for a completely different process,
789destined for that process to end up in an unrelated process. 958causing messages destined for that process to end up in an unrelated
959process.
790 960
791AEMP never reuses port IDs, so old messages or old port IDs floating 961AEMP does not reuse port IDs, so old messages or old port IDs floating
792around in the network will not be sent to an unrelated port. 962around in the network will not be sent to an unrelated port.
793 963
794=item * Erlang uses unprotected connections, AEMP uses secure 964=item * Erlang uses unprotected connections, AEMP uses secure
795authentication and can use TLS. 965authentication and can use TLS.
796 966
799 969
800=item * The AEMP protocol is optimised for both text-based and binary 970=item * The AEMP protocol is optimised for both text-based and binary
801communications. 971communications.
802 972
803The AEMP protocol, unlike the Erlang protocol, supports both programming 973The AEMP protocol, unlike the Erlang protocol, supports both programming
804language independent text-only protocols (good for debugging) and binary, 974language independent text-only protocols (good for debugging), and binary,
805language-specific serialisers (e.g. Storable). By default, unless TLS is 975language-specific serialisers (e.g. Storable). By default, unless TLS is
806used, the protocol is actually completely text-based. 976used, the protocol is actually completely text-based.
807 977
808It has also been carefully designed to be implementable in other languages 978It has also been carefully designed to be implementable in other languages
809with a minimum of work while gracefully degrading functionality to make the 979with a minimum of work while gracefully degrading functionality to make the
810protocol simple. 980protocol simple.
811 981
812=item * AEMP has more flexible monitoring options than Erlang. 982=item * AEMP has more flexible monitoring options than Erlang.
813 983
814In Erlang, you can chose to receive I<all> exit signals as messages 984In Erlang, you can chose to receive I<all> exit signals as messages or
815or I<none>, there is no in-between, so monitoring single processes is 985I<none>, there is no in-between, so monitoring single Erlang processes is
816difficult to implement. Monitoring in AEMP is more flexible than in 986difficult to implement.
817Erlang, as one can choose between automatic kill, exit message or callback 987
818on a per-process basis. 988Monitoring in AEMP is more flexible than in Erlang, as one can choose
989between automatic kill, exit message or callback on a per-port basis.
819 990
820=item * Erlang tries to hide remote/local connections, AEMP does not. 991=item * Erlang tries to hide remote/local connections, AEMP does not.
821 992
822Monitoring in Erlang is not an indicator of process death/crashes, in the 993Monitoring in Erlang is not an indicator of process death/crashes, in the
823same way as linking is (except linking is unreliable in Erlang). 994same way as linking is (except linking is unreliable in Erlang).
845overhead, as well as having to keep a proxy object everywhere. 1016overhead, as well as having to keep a proxy object everywhere.
846 1017
847Strings can easily be printed, easily serialised etc. and need no special 1018Strings can easily be printed, easily serialised etc. and need no special
848procedures to be "valid". 1019procedures to be "valid".
849 1020
850And as a result, a miniport consists of a single closure stored in a 1021And as a result, a port with just a default receiver consists of a single
851global hash - it can't become much cheaper. 1022code reference stored in a global hash - it can't become much cheaper.
852 1023
853=item Why favour JSON, why not a real serialising format such as Storable? 1024=item Why favour JSON, why not a real serialising format such as Storable?
854 1025
855In fact, any AnyEvent::MP node will happily accept Storable as framing 1026In fact, any AnyEvent::MP node will happily accept Storable as framing
856format, but currently there is no way to make a node use Storable by 1027format, but currently there is no way to make a node use Storable by
872 1043
873L<AnyEvent::MP::Intro> - a gentle introduction. 1044L<AnyEvent::MP::Intro> - a gentle introduction.
874 1045
875L<AnyEvent::MP::Kernel> - more, lower-level, stuff. 1046L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
876 1047
877L<AnyEvent::MP::Global> - network maintainance and port groups, to find 1048L<AnyEvent::MP::Global> - network maintenance and port groups, to find
878your applications. 1049your applications.
1050
1051L<AnyEvent::MP::DataConn> - establish data connections between nodes.
879 1052
880L<AnyEvent::MP::LogCatcher> - simple service to display log messages from 1053L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
881all nodes. 1054all nodes.
882 1055
883L<AnyEvent>. 1056L<AnyEvent>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines