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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines