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.56 by root, Sat Aug 15 04:12:38 2009 UTC vs.
Revision 1.103 by root, Sat Oct 17 01:42:39 2009 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
9 $NODE # contains this node's noderef 9 $NODE # contains this node's node ID
10 NODE # returns this node's noderef 10 NODE # returns this node's node ID
11 NODE $port # returns the noderef of the port
12 11
13 $SELF # receiving/own port id in rcv callbacks 12 $SELF # receiving/own port id in rcv callbacks
14 13
15 # initialise the node so it can send/receive messages 14 # initialise the node so it can send/receive messages
16 initialise_node; # -OR- 15 configure;
17 initialise_node "localhost:4040"; # -OR-
18 initialise_node "slave/", "localhost:4040"
19 16
20 # ports are message endpoints 17 # ports are message destinations
21 18
22 # sending messages 19 # sending messages
23 snd $port, type => data...; 20 snd $port, type => data...;
24 snd $port, @msg; 21 snd $port, @msg;
25 snd @msg_with_first_element_being_a_port; 22 snd @msg_with_first_element_being_a_port;
26 23
27 # creating/using ports, the simple way 24 # creating/using ports, the simple way
28 my $simple_port = port { my @msg = @_; 0 }; 25 my $simple_port = port { my @msg = @_ };
29 26
30 # creating/using ports, tagged message matching 27 # creating/using ports, tagged message matching
31 my $port = port; 28 my $port = port;
32 rcv $port, ping => sub { snd $_[0], "pong"; 0 }; 29 rcv $port, ping => sub { snd $_[0], "pong" };
33 rcv $port, pong => sub { warn "pong received\n"; 0 }; 30 rcv $port, pong => sub { warn "pong received\n" };
34 31
35 # create a port on another node 32 # create a port on another node
36 my $port = spawn $node, $initfunc, @initdata; 33 my $port = spawn $node, $initfunc, @initdata;
37 34
35 # destroy a prot again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
38 # monitoring 39 # monitoring
39 mon $port, $cb->(@msg) # callback is invoked on death 40 mon $localport, $cb->(@msg) # callback is invoked on death
40 mon $port, $otherport # kill otherport on abnormal death 41 mon $localport, $otherport # kill otherport on abnormal death
41 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 };
42 51
43=head1 CURRENT STATUS 52=head1 CURRENT STATUS
44 53
54 bin/aemp - stable.
45 AnyEvent::MP - stable API, should work 55 AnyEvent::MP - stable API, should work.
46 AnyEvent::MP::Intro - outdated 56 AnyEvent::MP::Intro - explains most concepts.
47 AnyEvent::MP::Kernel - WIP
48 AnyEvent::MP::Transport - mostly stable 57 AnyEvent::MP::Kernel - mostly stable API.
49 58 AnyEvent::MP::Global - stable API.
50 stay tuned.
51 59
52=head1 DESCRIPTION 60=head1 DESCRIPTION
53 61
54This module (-family) implements a simple message passing framework. 62This module (-family) implements a simple message passing framework.
55 63
56Despite its simplicity, you can securely message other processes running 64Despite its simplicity, you can securely message other processes running
57on the same or other hosts. 65on the same or other hosts, and you can supervise entities remotely.
58 66
59For an introduction to this module family, see the L<AnyEvent::MP::Intro> 67For an introduction to this module family, see the L<AnyEvent::MP::Intro>
60manual page. 68manual page and the examples under F<eg/>.
61
62At the moment, this module family is severly broken and underdocumented,
63so do not use. This was uploaded mainly to reserve the CPAN namespace -
64stay tuned!
65 69
66=head1 CONCEPTS 70=head1 CONCEPTS
67 71
68=over 4 72=over 4
69 73
70=item port 74=item port
71 75
72A port is something you can send messages to (with the C<snd> function). 76Not to be confused with a TCP port, a "port" is something you can send
77messages to (with the C<snd> function).
73 78
74Ports 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
75some messages. Messages will not be queued. 80some messages. Messages send to ports will not be queued, regardless of
81anything was listening for them or not.
76 82
77=item port id - C<noderef#portname> 83=item port ID - C<nodeid#portname>
78 84
79A port ID is the concatenation of a noderef, a hash-mark (C<#>) as 85A port ID is the concatenation of a node ID, a hash-mark (C<#>) as
80separator, and a port name (a printable string of unspecified format). An 86separator, and a port name (a printable string of unspecified format).
81exception is the the node port, whose ID is identical to its node
82reference.
83 87
84=item node 88=item node
85 89
86A node is a single process containing at least one port - the node port, 90A node is a single process containing at least one port - the node port,
87which provides nodes to manage each other remotely, and to create new 91which enables nodes to manage each other remotely, and to create new
88ports. 92ports.
89 93
90Nodes are either private (single-process only), slaves (connected to a 94Nodes are either public (have one or more listening ports) or private
91master node only) or public nodes (connectable from unrelated nodes). 95(no listening ports). Private nodes cannot talk to other private nodes
96currently.
92 97
93=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> 98=item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*>
94 99
95A node reference is a string that either simply identifies the node (for 100A node ID is a string that uniquely identifies the node within a
96private and slave nodes), or contains a recipe on how to reach a given 101network. Depending on the configuration used, node IDs can look like a
97node (for public nodes). 102hostname, a hostname and a port, or a random string. AnyEvent::MP itself
103doesn't interpret node IDs in any way.
98 104
99This recipe is simply a comma-separated list of C<address:port> pairs (for 105=item binds - C<ip:port>
100TCP/IP, other protocols might look different).
101 106
102Node references come in two flavours: resolved (containing only numerical 107Nodes can only talk to each other by creating some kind of connection to
103addresses) or unresolved (where hostnames are used instead of addresses). 108each other. To do this, nodes should listen on one or more local transport
109endpoints - binds. Currently, only standard C<ip:port> specifications can
110be used, which specify TCP ports to listen on.
104 111
105Before using an unresolved node reference in a message you first have to 112=item seed nodes
106resolve it. 113
114When a node starts, it knows nothing about the network. To teach the node
115about the network it first has to contact some other node within the
116network. This node is called a seed.
117
118Apart from the fact that other nodes know them as seed nodes and they have
119to have fixed listening addresses, seed nodes are perfectly normal nodes -
120any node can function as a seed node for others.
121
122In addition to discovering the network, seed nodes are also used to
123maintain the network and to connect nodes that otherwise would have
124trouble connecting. They form the backbone of an AnyEvent::MP network.
125
126Seed nodes are expected to be long-running, and at least one seed node
127should always be available. They should also be relatively responsive - a
128seed node that blocks for long periods will slow down everybody else.
129
130=item seeds - C<host:port>
131
132Seeds are transport endpoint(s) (usually a hostname/IP address and a
133TCP port) of nodes that should be used as seed nodes.
134
135The nodes listening on those endpoints are expected to be long-running,
136and at least one of those should always be available. When nodes run out
137of connections (e.g. due to a network error), they try to re-establish
138connections to some seednodes again to join the network.
107 139
108=back 140=back
109 141
110=head1 VARIABLES/FUNCTIONS 142=head1 VARIABLES/FUNCTIONS
111 143
123 155
124use AE (); 156use AE ();
125 157
126use base "Exporter"; 158use base "Exporter";
127 159
128our $VERSION = $AnyEvent::MP::Kernel::VERSION; 160our $VERSION = 1.22;
129 161
130our @EXPORT = qw( 162our @EXPORT = qw(
131 NODE $NODE *SELF node_of _any_ 163 NODE $NODE *SELF node_of after
132 resolve_node initialise_node 164 configure
133 snd rcv mon kil reg psub spawn 165 snd rcv mon mon_guard kil psub peval spawn cal
134 port 166 port
135); 167);
136 168
137our $SELF; 169our $SELF;
138 170
142 kil $SELF, die => $msg; 174 kil $SELF, die => $msg;
143} 175}
144 176
145=item $thisnode = NODE / $NODE 177=item $thisnode = NODE / $NODE
146 178
147The C<NODE> function returns, and the C<$NODE> variable contains the 179The C<NODE> function returns, and the C<$NODE> variable contains, the node
148noderef of the local node. The value is initialised by a call to 180ID of the node running in the current process. This value is initialised by
149C<initialise_node>. 181a call to C<configure>.
150 182
151=item $noderef = node_of $port 183=item $nodeid = node_of $port
152 184
153Extracts and returns the noderef from a port ID or a noderef. 185Extracts and returns the node ID from a port ID or a node ID.
154 186
155=item initialise_node $noderef, $seednode, $seednode... 187=item configure $profile, key => value...
156 188
157=item initialise_node "slave/", $master, $master... 189=item configure key => value...
158 190
159Before a node can talk to other nodes on the network it has to initialise 191Before a node can talk to other nodes on the network (i.e. enter
160itself - the minimum a node needs to know is it's own name, and optionally 192"distributed mode") it has to configure itself - the minimum a node needs
161it should know the noderefs of some other nodes in the network. 193to know is its own name, and optionally it should know the addresses of
194some other nodes in the network to discover other nodes.
162 195
163This function initialises a node - it must be called exactly once (or 196This function configures a node - it must be called exactly once (or
164never) before calling other AnyEvent::MP functions. 197never) before calling other AnyEvent::MP functions.
165 198
166All arguments (optionally except for the first) are noderefs, which can be
167either resolved or unresolved.
168
169The first argument will be looked up in the configuration database first
170(if it is C<undef> then the current nodename will be used instead) to find
171the relevant configuration profile (see L<aemp>). If none is found then
172the default configuration is used. The configuration supplies additional
173seed/master nodes and can override the actual noderef.
174
175There are two types of networked nodes, public nodes and slave nodes:
176
177=over 4 199=over 4
178 200
179=item public nodes 201=item step 1, gathering configuration from profiles
180 202
181For public nodes, C<$noderef> (supplied either directly to 203The function first looks up a profile in the aemp configuration (see the
182C<initialise_node> or indirectly via a profile or the nodename) must be a 204L<aemp> commandline utility). The profile name can be specified via the
183noderef (possibly unresolved, in which case it will be resolved). 205named C<profile> parameter or can simply be the first parameter). If it is
206missing, then the nodename (F<uname -n>) will be used as profile name.
184 207
185After resolving, the node will bind itself on all endpoints and try to 208The profile data is then gathered as follows:
186connect to all additional C<$seednodes> that are specified. Seednodes are
187optional and can be used to quickly bootstrap the node into an existing
188network.
189 209
190=item slave nodes 210First, all remaining key => value pairs (all of which are conveniently
211undocumented at the moment) will be interpreted as configuration
212data. Then they will be overwritten by any values specified in the global
213default configuration (see the F<aemp> utility), then the chain of
214profiles chosen by the profile name (and any C<parent> attributes).
191 215
192When the C<$noderef> (either as given or overriden by the config file) 216That means that the values specified in the profile have highest priority
193is the special string C<slave/>, then the node will become a slave 217and the values specified directly via C<configure> have lowest priority,
194node. Slave nodes cannot be contacted from outside and will route most of 218and can only be used to specify defaults.
195their traffic to the master node that they attach to.
196 219
197At least one additional noderef is required (either by specifying it 220If the profile specifies a node ID, then this will become the node ID of
198directly or because it is part of the configuration profile): The node 221this process. If not, then the profile name will be used as node ID. The
199will try to connect to all of them and will become a slave attached to the 222special node ID of C<anon/> will be replaced by a random node ID.
200first node it can successfully connect to.
201 223
202Note that slave nodes cannot change their name, and consequently, their 224=item step 2, bind listener sockets
203master, so if the master goes down, the slave node will not function well 225
204anymore until it can re-establish conenciton to its master. This makes 226The next step is to look up the binds in the profile, followed by binding
205slave nodes unsuitable for long-term nodes or fault-tolerant networks. 227aemp protocol listeners on all binds specified (it is possible and valid
228to have no binds, meaning that the node cannot be contacted form the
229outside. This means the node cannot talk to other nodes that also have no
230binds, but it can still talk to all "normal" nodes).
231
232If the profile does not specify a binds list, then a default of C<*> is
233used, meaning the node will bind on a dynamically-assigned port on every
234local IP address it finds.
235
236=item step 3, connect to seed nodes
237
238As the last step, the seeds list from the profile is passed to the
239L<AnyEvent::MP::Global> module, which will then use it to keep
240connectivity with at least one node at any point in time.
206 241
207=back 242=back
208 243
209This function will block until all nodes have been resolved and, for slave 244Example: become a distributed node using the local node name as profile.
210nodes, until it has successfully established a connection to a master 245This should be the most common form of invocation for "daemon"-type nodes.
211server.
212 246
213All the seednodes will also be specially marked to automatically retry 247 configure
214connecting to them infinitely.
215 248
216Example: become a public node listening on the guessed noderef, or the one 249Example: become an anonymous node. This form is often used for commandline
217specified via C<aemp> for the current node. This should be the most common 250clients.
218form of invocation for "daemon"-type nodes.
219 251
220 initialise_node; 252 configure nodeid => "anon/";
221 253
222Example: become a slave node to any of the the seednodes specified via 254Example: configure a node using a profile called seed, which si suitable
223C<aemp>. This form is often used for commandline clients. 255for a seed node as it binds on all local addresses on a fixed port (4040,
256customary for aemp).
224 257
225 initialise_node "slave/"; 258 # use the aemp commandline utility
259 # aemp profile seed nodeid anon/ binds '*:4040'
226 260
227Example: become a slave node to any of the specified master servers. This 261 # then use it
228form is also often used for commandline clients. 262 configure profile => "seed";
229 263
230 initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net"; 264 # or simply use aemp from the shell again:
265 # aemp run profile seed
231 266
232Example: become a public node, and try to contact some well-known master 267 # or provide a nicer-to-remember nodeid
233servers to become part of the network. 268 # aemp run profile seed nodeid "$(hostname)"
234
235 initialise_node undef, "master1", "master2";
236
237Example: become a public node listening on port C<4041>.
238
239 initialise_node 4041;
240
241Example: become a public node, only visible on localhost port 4044.
242
243 initialise_node "localhost:4044";
244
245=item $cv = resolve_node $noderef
246
247Takes an unresolved node reference that may contain hostnames and
248abbreviated IDs, resolves all of them and returns a resolved node
249reference.
250
251In addition to C<address:port> pairs allowed in resolved noderefs, the
252following forms are supported:
253
254=over 4
255
256=item the empty string
257
258An empty-string component gets resolved as if the default port (4040) was
259specified.
260
261=item naked port numbers (e.g. C<1234>)
262
263These are resolved by prepending the local nodename and a colon, to be
264further resolved.
265
266=item hostnames (e.g. C<localhost:1234>, C<localhost>)
267
268These are resolved by using AnyEvent::DNS to resolve them, optionally
269looking up SRV records for the C<aemp=4040> port, if no port was
270specified.
271
272=back
273 269
274=item $SELF 270=item $SELF
275 271
276Contains the current port id while executing C<rcv> callbacks or C<psub> 272Contains the current port id while executing C<rcv> callbacks or C<psub>
277blocks. 273blocks.
278 274
279=item SELF, %SELF, @SELF... 275=item *SELF, SELF, %SELF, @SELF...
280 276
281Due to some quirks in how perl exports variables, it is impossible to 277Due to some quirks in how perl exports variables, it is impossible to
282just export C<$SELF>, all the symbols called C<SELF> are exported by this 278just export C<$SELF>, all the symbols named C<SELF> are exported by this
283module, but only C<$SELF> is currently used. 279module, but only C<$SELF> is currently used.
284 280
285=item snd $port, type => @data 281=item snd $port, type => @data
286 282
287=item snd $port, @msg 283=item snd $port, @msg
288 284
289Send the given message to the given port ID, which can identify either 285Send the given message to the given port, which can identify either a
290a local or a remote port, and must be a port ID. 286local or a remote port, and must be a port ID.
291 287
292While the message can be about anything, it is highly recommended to use a 288While the message can be almost anything, it is highly recommended to
293string as first element (a port ID, or some word that indicates a request 289use a string as first element (a port ID, or some word that indicates a
294type etc.). 290request type etc.) and to consist if only simple perl values (scalars,
291arrays, hashes) - if you think you need to pass an object, think again.
295 292
296The message data effectively becomes read-only after a call to this 293The message data logically becomes read-only after a call to this
297function: modifying any argument is not allowed and can cause many 294function: modifying any argument (or values referenced by them) is
298problems. 295forbidden, as there can be considerable time between the call to C<snd>
296and the time the message is actually being serialised - in fact, it might
297never be copied as within the same process it is simply handed to the
298receiving port.
299 299
300The type of data you can transfer depends on the transport protocol: when 300The type of data you can transfer depends on the transport protocol: when
301JSON is used, then only strings, numbers and arrays and hashes consisting 301JSON is used, then only strings, numbers and arrays and hashes consisting
302of those are allowed (no objects). When Storable is used, then anything 302of those are allowed (no objects). When Storable is used, then anything
303that Storable can serialise and deserialise is allowed, and for the local 303that Storable can serialise and deserialise is allowed, and for the local
304node, anything can be passed. 304node, anything can be passed. Best rely only on the common denominator of
305these.
305 306
306=item $local_port = port 307=item $local_port = port
307 308
308Create a new local port object and returns its port ID. Initially it has 309Create a new local port object and returns its port ID. Initially it has
309no callbacks set and will throw an error when it receives messages. 310no callbacks set and will throw an error when it receives messages.
382 msg1 => sub { ... }, 383 msg1 => sub { ... },
383 ... 384 ...
384 ; 385 ;
385 386
386Example: temporarily register a rcv callback for a tag matching some port 387Example: temporarily register a rcv callback for a tag matching some port
387(e.g. for a rpc reply) and unregister it after a message was received. 388(e.g. for an rpc reply) and unregister it after a message was received.
388 389
389 rcv $port, $otherport => sub { 390 rcv $port, $otherport => sub {
390 my @reply = @_; 391 my @reply = @_;
391 392
392 rcv $SELF, $otherport; 393 rcv $SELF, $otherport;
394 395
395=cut 396=cut
396 397
397sub rcv($@) { 398sub rcv($@) {
398 my $port = shift; 399 my $port = shift;
399 my ($noderef, $portid) = split /#/, $port, 2; 400 my ($nodeid, $portid) = split /#/, $port, 2;
400 401
401 ($NODE{$noderef} || add_node $noderef) == $NODE{""} 402 $NODE{$nodeid} == $NODE{""}
402 or Carp::croak "$port: rcv can only be called on local ports, caught"; 403 or Carp::croak "$port: rcv can only be called on local ports, caught";
403 404
404 while (@_) { 405 while (@_) {
405 if (ref $_[0]) { 406 if (ref $_[0]) {
406 if (my $self = $PORT_DATA{$portid}) { 407 if (my $self = $PORT_DATA{$portid}) {
407 "AnyEvent::MP::Port" eq ref $self 408 "AnyEvent::MP::Port" eq ref $self
408 or Carp::croak "$port: rcv can only be called on message matching ports, caught"; 409 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
409 410
410 $self->[2] = shift; 411 $self->[0] = shift;
411 } else { 412 } else {
412 my $cb = shift; 413 my $cb = shift;
413 $PORT{$portid} = sub { 414 $PORT{$portid} = sub {
414 local $SELF = $port; 415 local $SELF = $port;
415 eval { &$cb }; _self_die if $@; 416 eval { &$cb }; _self_die if $@;
416 }; 417 };
417 } 418 }
418 } elsif (defined $_[0]) { 419 } elsif (defined $_[0]) {
419 my $self = $PORT_DATA{$portid} ||= do { 420 my $self = $PORT_DATA{$portid} ||= do {
420 my $self = bless [$PORT{$port} || sub { }, { }, $port], "AnyEvent::MP::Port"; 421 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
421 422
422 $PORT{$portid} = sub { 423 $PORT{$portid} = sub {
423 local $SELF = $port; 424 local $SELF = $port;
424 425
425 if (my $cb = $self->[1]{$_[0]}) { 426 if (my $cb = $self->[1]{$_[0]}) {
447 } 448 }
448 449
449 $port 450 $port
450} 451}
451 452
453=item peval $port, $coderef[, @args]
454
455Evaluates the given C<$codref> within the contetx of C<$port>, that is,
456when the code throews an exception the C<$port> will be killed.
457
458Any remaining args will be passed to the callback. Any return values will
459be returned to the caller.
460
461This is useful when you temporarily want to execute code in the context of
462a port.
463
464Example: create a port and run some initialisation code in it's context.
465
466 my $port = port { ... };
467
468 peval $port, sub {
469 init
470 or die "unable to init";
471 };
472
473=cut
474
475sub peval($$) {
476 local $SELF = shift;
477 my $cb = shift;
478
479 if (wantarray) {
480 my @res = eval { &$cb };
481 _self_die if $@;
482 @res
483 } else {
484 my $res = eval { &$cb };
485 _self_die if $@;
486 $res
487 }
488}
489
452=item $closure = psub { BLOCK } 490=item $closure = psub { BLOCK }
453 491
454Remembers C<$SELF> and creates a closure out of the BLOCK. When the 492Remembers C<$SELF> and creates a closure out of the BLOCK. When the
455closure is executed, sets up the environment in the same way as in C<rcv> 493closure is executed, sets up the environment in the same way as in C<rcv>
456callbacks, i.e. runtime errors will cause the port to get C<kil>ed. 494callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
495
496The effect is basically as if it returned C<< sub { peval $SELF, sub {
497BLOCK } } >>.
457 498
458This is useful when you register callbacks from C<rcv> callbacks: 499This is useful when you register callbacks from C<rcv> callbacks:
459 500
460 rcv delayed_reply => sub { 501 rcv delayed_reply => sub {
461 my ($delay, @reply) = @_; 502 my ($delay, @reply) = @_;
485 $res 526 $res
486 } 527 }
487 } 528 }
488} 529}
489 530
490=item $guard = mon $port, $cb->(@reason) 531=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
491 532
492=item $guard = mon $port, $rcvport 533=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
493 534
494=item $guard = mon $port 535=item $guard = mon $port # kill $SELF when $port dies
495 536
496=item $guard = mon $port, $rcvport, @msg 537=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
497 538
498Monitor the given port and do something when the port is killed or 539Monitor the given port and do something when the port is killed or
499messages to it were lost, and optionally return a guard that can be used 540messages to it were lost, and optionally return a guard that can be used
500to stop monitoring again. 541to stop monitoring again.
501
502C<mon> effectively guarantees that, in the absence of hardware failures,
503that after starting the monitor, either all messages sent to the port
504will arrive, or the monitoring action will be invoked after possible
505message loss has been detected. No messages will be lost "in between"
506(after the first lost message no further messages will be received by the
507port). After the monitoring action was invoked, further messages might get
508delivered again.
509 542
510In the first form (callback), the callback is simply called with any 543In the first form (callback), the callback is simply called with any
511number of C<@reason> elements (no @reason means that the port was deleted 544number of C<@reason> elements (no @reason means that the port was deleted
512"normally"). Note also that I<< the callback B<must> never die >>, so use 545"normally"). Note also that I<< the callback B<must> never die >>, so use
513C<eval> if unsure. 546C<eval> if unsure.
514 547
515In the second form (another port given), the other port (C<$rcvport>) 548In the second form (another port given), the other port (C<$rcvport>)
516will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on 549will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
517"normal" kils nothing happens, while under all other conditions, the other 550"normal" kils nothing happens, while under all other conditions, the other
518port is killed with the same reason. 551port is killed with the same reason.
519 552
520The third form (kill self) is the same as the second form, except that 553The third form (kill self) is the same as the second form, except that
521C<$rvport> defaults to C<$SELF>. 554C<$rvport> defaults to C<$SELF>.
522 555
523In the last form (message), a message of the form C<@msg, @reason> will be 556In the last form (message), a message of the form C<@msg, @reason> will be
524C<snd>. 557C<snd>.
558
559Monitoring-actions are one-shot: once messages are lost (and a monitoring
560alert was raised), they are removed and will not trigger again.
525 561
526As a rule of thumb, monitoring requests should always monitor a port from 562As a rule of thumb, monitoring requests should always monitor a port from
527a local port (or callback). The reason is that kill messages might get 563a local port (or callback). The reason is that kill messages might get
528lost, just like any other message. Another less obvious reason is that 564lost, just like any other message. Another less obvious reason is that
529even monitoring requests can get lost (for exmaple, when the connection 565even monitoring requests can get lost (for example, when the connection
530to the other node goes down permanently). When monitoring a port locally 566to the other node goes down permanently). When monitoring a port locally
531these problems do not exist. 567these problems do not exist.
532 568
569C<mon> effectively guarantees that, in the absence of hardware failures,
570after starting the monitor, either all messages sent to the port will
571arrive, or the monitoring action will be invoked after possible message
572loss has been detected. No messages will be lost "in between" (after
573the first lost message no further messages will be received by the
574port). After the monitoring action was invoked, further messages might get
575delivered again.
576
577Inter-host-connection timeouts and monitoring depend on the transport
578used. The only transport currently implemented is TCP, and AnyEvent::MP
579relies on TCP to detect node-downs (this can take 10-15 minutes on a
580non-idle connection, and usually around two hours for idle connections).
581
582This means that monitoring is good for program errors and cleaning up
583stuff eventually, but they are no replacement for a timeout when you need
584to ensure some maximum latency.
585
533Example: call a given callback when C<$port> is killed. 586Example: call a given callback when C<$port> is killed.
534 587
535 mon $port, sub { warn "port died because of <@_>\n" }; 588 mon $port, sub { warn "port died because of <@_>\n" };
536 589
537Example: kill ourselves when C<$port> is killed abnormally. 590Example: kill ourselves when C<$port> is killed abnormally.
543 mon $port, $self => "restart"; 596 mon $port, $self => "restart";
544 597
545=cut 598=cut
546 599
547sub mon { 600sub mon {
548 my ($noderef, $port) = split /#/, shift, 2; 601 my ($nodeid, $port) = split /#/, shift, 2;
549 602
550 my $node = $NODE{$noderef} || add_node $noderef; 603 my $node = $NODE{$nodeid} || add_node $nodeid;
551 604
552 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,'; 605 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
553 606
554 unless (ref $cb) { 607 unless (ref $cb) {
555 if (@_) { 608 if (@_) {
564 } 617 }
565 618
566 $node->monitor ($port, $cb); 619 $node->monitor ($port, $cb);
567 620
568 defined wantarray 621 defined wantarray
569 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 622 and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
570} 623}
571 624
572=item $guard = mon_guard $port, $ref, $ref... 625=item $guard = mon_guard $port, $ref, $ref...
573 626
574Monitors the given C<$port> and keeps the passed references. When the port 627Monitors the given C<$port> and keeps the passed references. When the port
575is killed, the references will be freed. 628is killed, the references will be freed.
576 629
577Optionally returns a guard that will stop the monitoring. 630Optionally returns a guard that will stop the monitoring.
578 631
579This function is useful when you create e.g. timers or other watchers and 632This function is useful when you create e.g. timers or other watchers and
580want to free them when the port gets killed: 633want to free them when the port gets killed (note the use of C<psub>):
581 634
582 $port->rcv (start => sub { 635 $port->rcv (start => sub {
583 my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub { 636 my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
584 undef $timer if 0.9 < rand; 637 undef $timer if 0.9 < rand;
585 }); 638 });
586 }); 639 });
587 640
588=cut 641=cut
597 650
598=item kil $port[, @reason] 651=item kil $port[, @reason]
599 652
600Kill the specified port with the given C<@reason>. 653Kill the specified port with the given C<@reason>.
601 654
602If no C<@reason> is specified, then the port is killed "normally" (linked 655If no C<@reason> is specified, then the port is killed "normally" (ports
603ports will not be kileld, or even notified). 656monitoring other ports will not necessarily die because a port dies
657"normally").
604 658
605Otherwise, linked ports get killed with the same reason (second form of 659Otherwise, linked ports get killed with the same reason (second form of
606C<mon>, see below). 660C<mon>, see above).
607 661
608Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks 662Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
609will be reported as reason C<< die => $@ >>. 663will be reported as reason C<< die => $@ >>.
610 664
611Transport/communication errors are reported as C<< transport_error => 665Transport/communication errors are reported as C<< transport_error =>
616=item $port = spawn $node, $initfunc[, @initdata] 670=item $port = spawn $node, $initfunc[, @initdata]
617 671
618Creates a port on the node C<$node> (which can also be a port ID, in which 672Creates a port on the node C<$node> (which can also be a port ID, in which
619case it's the node where that port resides). 673case it's the node where that port resides).
620 674
621The port ID of the newly created port is return immediately, and it is 675The port ID of the newly created port is returned immediately, and it is
622permissible to immediately start sending messages or monitor the port. 676possible to immediately start sending messages or to monitor the port.
623 677
624After the port has been created, the init function is 678After the port has been created, the init function is called on the remote
625called. This function must be a fully-qualified function name 679node, in the same context as a C<rcv> callback. This function must be a
626(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main 680fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
627program, use C<::name>. 681specify a function in the main program, use C<::name>.
628 682
629If the function doesn't exist, then the node tries to C<require> 683If the function doesn't exist, then the node tries to C<require>
630the package, then the package above the package and so on (e.g. 684the package, then the package above the package and so on (e.g.
631C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function 685C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
632exists or it runs out of package names. 686exists or it runs out of package names.
633 687
634The init function is then called with the newly-created port as context 688The init function is then called with the newly-created port as context
635object (C<$SELF>) and the C<@initdata> values as arguments. 689object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
690call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
691the port might not get created.
636 692
637A common idiom is to pass your own port, monitor the spawned port, and 693A common idiom is to pass a local port, immediately monitor the spawned
638in the init function, monitor the original port. This two-way monitoring 694port, and in the remote init function, immediately monitor the passed
639ensures that both ports get cleaned up when there is a problem. 695local port. This two-way monitoring ensures that both ports get cleaned up
696when there is a problem.
697
698C<spawn> guarantees that the C<$initfunc> has no visible effects on the
699caller before C<spawn> returns (by delaying invocation when spawn is
700called for the local node).
640 701
641Example: spawn a chat server port on C<$othernode>. 702Example: spawn a chat server port on C<$othernode>.
642 703
643 # this node, executed from within a port context: 704 # this node, executed from within a port context:
644 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; 705 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
659 720
660sub _spawn { 721sub _spawn {
661 my $port = shift; 722 my $port = shift;
662 my $init = shift; 723 my $init = shift;
663 724
725 # rcv will create the actual port
664 local $SELF = "$NODE#$port"; 726 local $SELF = "$NODE#$port";
665 eval { 727 eval {
666 &{ load_func $init } 728 &{ load_func $init }
667 }; 729 };
668 _self_die if $@; 730 _self_die if $@;
669} 731}
670 732
671sub spawn(@) { 733sub spawn(@) {
672 my ($noderef, undef) = split /#/, shift, 2; 734 my ($nodeid, undef) = split /#/, shift, 2;
673 735
674 my $id = "$RUNIQ." . $ID++; 736 my $id = "$RUNIQ." . $ID++;
675 737
676 $_[0] =~ /::/ 738 $_[0] =~ /::/
677 or Carp::croak "spawn init function must be a fully-qualified name, caught"; 739 or Carp::croak "spawn init function must be a fully-qualified name, caught";
678 740
679 snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_; 741 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
680 742
681 "$noderef#$id" 743 "$nodeid#$id"
682} 744}
683 745
684=back 746=item after $timeout, @msg
685 747
686=head1 NODE MESSAGES 748=item after $timeout, $callback
687 749
688Nodes understand the following messages sent to them. Many of them take 750Either sends the given message, or call the given callback, after the
689arguments called C<@reply>, which will simply be used to compose a reply 751specified number of seconds.
690message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
691the remaining arguments are simply the message data.
692 752
693While other messages exist, they are not public and subject to change. 753This is simply a utility function that comes in handy at times - the
754AnyEvent::MP author is not convinced of the wisdom of having it, though,
755so it may go away in the future.
694 756
695=over 4
696
697=cut 757=cut
698 758
699=item lookup => $name, @reply 759sub after($@) {
760 my ($timeout, @action) = @_;
700 761
701Replies with the port ID of the specified well-known port, or C<undef>. 762 my $t; $t = AE::timer $timeout, 0, sub {
763 undef $t;
764 ref $action[0]
765 ? $action[0]()
766 : snd @action;
767 };
768}
702 769
703=item devnull => ... 770=item cal $port, @msg, $callback[, $timeout]
704 771
705Generic data sink/CPU heat conversion. 772A simple form of RPC - sends a message to the given C<$port> with the
773given contents (C<@msg>), but adds a reply port to the message.
706 774
707=item relay => $port, @msg 775The reply port is created temporarily just for the purpose of receiving
776the reply, and will be C<kil>ed when no longer needed.
708 777
709Simply forwards the message to the given port. 778A reply message sent to the port is passed to the C<$callback> as-is.
710 779
711=item eval => $string[ @reply] 780If an optional time-out (in seconds) is given and it is not C<undef>,
781then the callback will be called without any arguments after the time-out
782elapsed and the port is C<kil>ed.
712 783
713Evaluates the given string. If C<@reply> is given, then a message of the 784If no time-out is given (or it is C<undef>), then the local port will
714form C<@reply, $@, @evalres> is sent. 785monitor the remote port instead, so it eventually gets cleaned-up.
715 786
716Example: crash another node. 787Currently this function returns the temporary port, but this "feature"
788might go in future versions unless you can make a convincing case that
789this is indeed useful for something.
717 790
718 snd $othernode, eval => "exit"; 791=cut
719 792
720=item time => @reply 793sub cal(@) {
794 my $timeout = ref $_[-1] ? undef : pop;
795 my $cb = pop;
721 796
722Replies the the current node time to C<@reply>. 797 my $port = port {
798 undef $timeout;
799 kil $SELF;
800 &$cb;
801 };
723 802
724Example: tell the current node to send the current time to C<$myport> in a 803 if (defined $timeout) {
725C<timereply> message. 804 $timeout = AE::timer $timeout, 0, sub {
805 undef $timeout;
806 kil $port;
807 $cb->();
808 };
809 } else {
810 mon $_[0], sub {
811 kil $port;
812 $cb->();
813 };
814 }
726 815
727 snd $NODE, time => $myport, timereply => 1, 2; 816 push @_, $port;
728 # => snd $myport, timereply => 1, 2, <time> 817 &snd;
818
819 $port
820}
729 821
730=back 822=back
731 823
732=head1 AnyEvent::MP vs. Distributed Erlang 824=head1 AnyEvent::MP vs. Distributed Erlang
733 825
734AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 826AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
735== aemp node, Erlang process == aemp port), so many of the documents and 827== aemp node, Erlang process == aemp port), so many of the documents and
736programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 828programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
737sample: 829sample:
738 830
739 http://www.Erlang.se/doc/programming_rules.shtml 831 http://www.erlang.se/doc/programming_rules.shtml
740 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 832 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
741 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 833 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
742 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 834 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
743 835
744Despite the similarities, there are also some important differences: 836Despite the similarities, there are also some important differences:
745 837
746=over 4 838=over 4
747 839
748=item * Node references contain the recipe on how to contact them. 840=item * Node IDs are arbitrary strings in AEMP.
749 841
750Erlang relies on special naming and DNS to work everywhere in the 842Erlang relies on special naming and DNS to work everywhere in the same
751same way. AEMP relies on each node knowing it's own address(es), with 843way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
752convenience functionality. 844configuration or DNS), and possibly the addresses of some seed nodes, but
753 845will otherwise discover other nodes (and their IDs) itself.
754This means that AEMP requires a less tightly controlled environment at the
755cost of longer node references and a slightly higher management overhead.
756 846
757=item * Erlang has a "remote ports are like local ports" philosophy, AEMP 847=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
758uses "local ports are like remote ports". 848uses "local ports are like remote ports".
759 849
760The failure modes for local ports are quite different (runtime errors 850The failure modes for local ports are quite different (runtime errors
773 863
774Erlang uses processes that selectively receive messages, and therefore 864Erlang uses processes that selectively receive messages, and therefore
775needs a queue. AEMP is event based, queuing messages would serve no 865needs a queue. AEMP is event based, queuing messages would serve no
776useful purpose. For the same reason the pattern-matching abilities of 866useful purpose. For the same reason the pattern-matching abilities of
777AnyEvent::MP are more limited, as there is little need to be able to 867AnyEvent::MP are more limited, as there is little need to be able to
778filter messages without dequeing them. 868filter messages without dequeuing them.
779 869
780(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). 870(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
781 871
782=item * Erlang sends are synchronous, AEMP sends are asynchronous. 872=item * Erlang sends are synchronous, AEMP sends are asynchronous.
783 873
785so does not need a queue that can overflow). AEMP sends are immediate, 875so does not need a queue that can overflow). AEMP sends are immediate,
786connection establishment is handled in the background. 876connection establishment is handled in the background.
787 877
788=item * Erlang suffers from silent message loss, AEMP does not. 878=item * Erlang suffers from silent message loss, AEMP does not.
789 879
790Erlang makes few guarantees on messages delivery - messages can get lost 880Erlang implements few guarantees on messages delivery - messages can get
791without any of the processes realising it (i.e. you send messages a, b, 881lost without any of the processes realising it (i.e. you send messages a,
792and c, and the other side only receives messages a and c). 882b, and c, and the other side only receives messages a and c).
793 883
794AEMP guarantees correct ordering, and the guarantee that there are no 884AEMP guarantees correct ordering, and the guarantee that after one message
795holes in the message sequence. 885is lost, all following ones sent to the same port are lost as well, until
796 886monitoring raises an error, so there are no silent "holes" in the message
797=item * In Erlang, processes can be declared dead and later be found to be 887sequence.
798alive.
799
800In Erlang it can happen that a monitored process is declared dead and
801linked processes get killed, but later it turns out that the process is
802still alive - and can receive messages.
803
804In AEMP, when port monitoring detects a port as dead, then that port will
805eventually be killed - it cannot happen that a node detects a port as dead
806and then later sends messages to it, finding it is still alive.
807 888
808=item * Erlang can send messages to the wrong port, AEMP does not. 889=item * Erlang can send messages to the wrong port, AEMP does not.
809 890
810In Erlang it is quite likely that a node that restarts reuses a process ID 891In Erlang it is quite likely that a node that restarts reuses a process ID
811known to other nodes for a completely different process, causing messages 892known to other nodes for a completely different process, causing messages
815around in the network will not be sent to an unrelated port. 896around in the network will not be sent to an unrelated port.
816 897
817=item * Erlang uses unprotected connections, AEMP uses secure 898=item * Erlang uses unprotected connections, AEMP uses secure
818authentication and can use TLS. 899authentication and can use TLS.
819 900
820AEMP can use a proven protocol - SSL/TLS - to protect connections and 901AEMP can use a proven protocol - TLS - to protect connections and
821securely authenticate nodes. 902securely authenticate nodes.
822 903
823=item * The AEMP protocol is optimised for both text-based and binary 904=item * The AEMP protocol is optimised for both text-based and binary
824communications. 905communications.
825 906
826The AEMP protocol, unlike the Erlang protocol, supports both 907The AEMP protocol, unlike the Erlang protocol, supports both programming
827language-independent text-only protocols (good for debugging) and binary, 908language independent text-only protocols (good for debugging) and binary,
828language-specific serialisers (e.g. Storable). 909language-specific serialisers (e.g. Storable). By default, unless TLS is
910used, the protocol is actually completely text-based.
829 911
830It has also been carefully designed to be implementable in other languages 912It has also been carefully designed to be implementable in other languages
831with a minimum of work while gracefully degrading fucntionality to make the 913with a minimum of work while gracefully degrading functionality to make the
832protocol simple. 914protocol simple.
833 915
834=item * AEMP has more flexible monitoring options than Erlang. 916=item * AEMP has more flexible monitoring options than Erlang.
835 917
836In Erlang, you can chose to receive I<all> exit signals as messages 918In Erlang, you can chose to receive I<all> exit signals as messages
839Erlang, as one can choose between automatic kill, exit message or callback 921Erlang, as one can choose between automatic kill, exit message or callback
840on a per-process basis. 922on a per-process basis.
841 923
842=item * Erlang tries to hide remote/local connections, AEMP does not. 924=item * Erlang tries to hide remote/local connections, AEMP does not.
843 925
844Monitoring in Erlang is not an indicator of process death/crashes, 926Monitoring in Erlang is not an indicator of process death/crashes, in the
845as linking is (except linking is unreliable in Erlang). 927same way as linking is (except linking is unreliable in Erlang).
846 928
847In AEMP, you don't "look up" registered port names or send to named ports 929In AEMP, you don't "look up" registered port names or send to named ports
848that might or might not be persistent. Instead, you normally spawn a port 930that might or might not be persistent. Instead, you normally spawn a port
849on the remote node. The init function monitors the you, and you monitor 931on the remote node. The init function monitors you, and you monitor the
850the remote port. Since both monitors are local to the node, they are much 932remote port. Since both monitors are local to the node, they are much more
851more reliable. 933reliable (no need for C<spawn_link>).
852 934
853This also saves round-trips and avoids sending messages to the wrong port 935This also saves round-trips and avoids sending messages to the wrong port
854(hard to do in Erlang). 936(hard to do in Erlang).
855 937
856=back 938=back
857 939
858=head1 RATIONALE 940=head1 RATIONALE
859 941
860=over 4 942=over 4
861 943
862=item Why strings for ports and noderefs, why not objects? 944=item Why strings for port and node IDs, why not objects?
863 945
864We considered "objects", but found that the actual number of methods 946We considered "objects", but found that the actual number of methods
865thatc an be called are very low. Since port IDs and noderefs travel over 947that can be called are quite low. Since port and node IDs travel over
866the network frequently, the serialising/deserialising would add lots of 948the network frequently, the serialising/deserialising would add lots of
867overhead, as well as having to keep a proxy object. 949overhead, as well as having to keep a proxy object everywhere.
868 950
869Strings can easily be printed, easily serialised etc. and need no special 951Strings can easily be printed, easily serialised etc. and need no special
870procedures to be "valid". 952procedures to be "valid".
871 953
872And a a miniport consists of a single closure stored in a global hash - it 954And as a result, a miniport consists of a single closure stored in a
873can't become much cheaper. 955global hash - it can't become much cheaper.
874 956
875=item Why favour JSON, why not real serialising format such as Storable? 957=item Why favour JSON, why not a real serialising format such as Storable?
876 958
877In fact, any AnyEvent::MP node will happily accept Storable as framing 959In fact, any AnyEvent::MP node will happily accept Storable as framing
878format, but currently there is no way to make a node use Storable by 960format, but currently there is no way to make a node use Storable by
879default. 961default (although all nodes will accept it).
880 962
881The default framing protocol is JSON because a) JSON::XS is many times 963The default framing protocol is JSON because a) JSON::XS is many times
882faster for small messages and b) most importantly, after years of 964faster for small messages and b) most importantly, after years of
883experience we found that object serialisation is causing more problems 965experience we found that object serialisation is causing more problems
884than it gains: Just like function calls, objects simply do not travel 966than it solves: Just like function calls, objects simply do not travel
885easily over the network, mostly because they will always be a copy, so you 967easily over the network, mostly because they will always be a copy, so you
886always have to re-think your design. 968always have to re-think your design.
887 969
888Keeping your messages simple, concentrating on data structures rather than 970Keeping your messages simple, concentrating on data structures rather than
889objects, will keep your messages clean, tidy and efficient. 971objects, will keep your messages clean, tidy and efficient.
890 972
891=back 973=back
892 974
893=head1 SEE ALSO 975=head1 SEE ALSO
894 976
977L<AnyEvent::MP::Intro> - a gentle introduction.
978
979L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
980
981L<AnyEvent::MP::Global> - network maintainance and port groups, to find
982your applications.
983
984L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
985all nodes.
986
895L<AnyEvent>. 987L<AnyEvent>.
896 988
897=head1 AUTHOR 989=head1 AUTHOR
898 990
899 Marc Lehmann <schmorp@schmorp.de> 991 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines