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.75 by root, Mon Aug 31 13:18:06 2009 UTC vs.
Revision 1.135 by root, Mon Mar 12 14:55:55 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::MP - multi-processing/message-passing framework 3AnyEvent::MP - erlang-style multi-processing/message-passing framework
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
30 rcv $port, pong => sub { warn "pong received\n" }; 30 rcv $port, pong => sub { warn "pong received\n" };
31 31
32 # create a port on another node 32 # create a port on another node
33 my $port = spawn $node, $initfunc, @initdata; 33 my $port = spawn $node, $initfunc, @initdata;
34 34
35 # destroy a port again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
35 # monitoring 39 # monitoring
36 mon $port, $cb->(@msg) # callback is invoked on death 40 mon $port, $cb->(@msg) # callback is invoked on death
37 mon $port, $otherport # kill otherport on abnormal death 41 mon $port, $localport # kill localport on abnormal death
38 mon $port, $otherport, @msg # send message on death 42 mon $port, $localport, @msg # send message on death
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 - uptodate, but incomplete. 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 API, protocol not yet final. 58 AnyEvent::MP::Global - stable API.
47
48 stay 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
55on the same or other hosts, and you can supervise entities remotely. 65on the same or other hosts, and you can supervise entities remotely.
56 66
57For 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>
58manual page and the examples under F<eg/>. 68manual page and the examples under F<eg/>.
59 69
60At the moment, this module family is a bit underdocumented.
61
62=head1 CONCEPTS 70=head1 CONCEPTS
63 71
64=over 4 72=over 4
65 73
66=item port 74=item port
67 75
68A 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).
69 78
70Ports 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
71some messages. Messages send to ports will not be queued, regardless of 80some messages. Messages send to ports will not be queued, regardless of
72anything was listening for them or not. 81anything was listening for them or not.
73 82
83Ports are represented by (printable) strings called "port IDs".
84
74=item port ID - C<nodeid#portname> 85=item port ID - C<nodeid#portname>
75 86
76A 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<#>)
77separator, 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).
78 90
79=item node 91=item node
80 92
81A 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,
82which enables nodes to manage each other remotely, and to create new 94which enables nodes to manage each other remotely, and to create new
83ports. 95ports.
84 96
85Nodes are either public (have one or more listening ports) or private 97Nodes are either public (have one or more listening ports) or private
86(no listening ports). Private nodes cannot talk to other private nodes 98(no listening ports). Private nodes cannot talk to other private nodes
87currently. 99currently, but all nodes can talk to public nodes.
88 100
101Nodes is represented by (printable) strings called "node IDs".
102
89=item node ID - C<[a-za-Z0-9_\-.:]+> 103=item node ID - C<[A-Za-z0-9_\-.:]*>
90 104
91A 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
92network. Depending on the configuration used, node IDs can look like a 106network. Depending on the configuration used, node IDs can look like a
93hostname, 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
94doesn't interpret node IDs in any way. 108doesn't interpret node IDs in any way except to uniquely identify a node.
95 109
96=item binds - C<ip:port> 110=item binds - C<ip:port>
97 111
98Nodes 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
99each 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
100endpoints - binds. Currently, only standard C<ip:port> specifications can 116Currently, only standard C<ip:port> specifications can be used, which
101be 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.
102 119
120=item seed nodes
121
122When a node starts, it knows nothing about the network it is in - it
123needs to connect to at least one other node that is already in the
124network. These other nodes are called "seed nodes".
125
126Seed nodes themselves are not special - they are seed nodes only because
127some other node I<uses> them as such, but any node can be used as seed
128node for other nodes, and eahc node cna use a different set of seed nodes.
129
130In addition to discovering the network, seed nodes are also used to
131maintain the network - all nodes using the same seed node form are part of
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.
135
136Seed nodes are expected to be long-running, and at least one seed node
137should always be available. They should also be relatively responsive - a
138seed node that blocks for long periods will slow down everybody else.
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
103=item seeds - C<host:port> 149=item seed IDs - C<host:port>
104 150
105When a node starts, it knows nothing about the network. To teach the node 151Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
106about the network it first has to contact some other node within the 152TCP port) of nodes that should be used as seed nodes.
107network. This node is called a seed.
108 153
109Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes 154=item global nodes
110are expected to be long-running, and at least one of those should always
111be available. When nodes run out of connections (e.g. due to a network
112error), they try to re-establish connections to some seednodes again to
113join the network.
114 155
115Apart from being sued for seeding, seednodes are not special in any way - 156An AEMP network needs a discovery service - nodes need to know how to
116every public node can be a seednode. 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).
117 170
118=back 171=back
119 172
120=head1 VARIABLES/FUNCTIONS 173=head1 VARIABLES/FUNCTIONS
121 174
123 176
124=cut 177=cut
125 178
126package AnyEvent::MP; 179package AnyEvent::MP;
127 180
181use AnyEvent::MP::Config ();
128use AnyEvent::MP::Kernel; 182use AnyEvent::MP::Kernel;
183use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
129 184
130use common::sense; 185use common::sense;
131 186
132use Carp (); 187use Carp ();
133 188
134use AE (); 189use AE ();
190use Guard ();
135 191
136use base "Exporter"; 192use base "Exporter";
137 193
138our $VERSION = $AnyEvent::MP::Kernel::VERSION; 194our $VERSION = $AnyEvent::MP::Config::VERSION;
139 195
140our @EXPORT = qw( 196our @EXPORT = qw(
141 NODE $NODE *SELF node_of after 197 NODE $NODE *SELF node_of after
142 configure 198 configure
143 snd rcv mon mon_guard kil reg psub spawn 199 snd rcv mon mon_guard kil psub peval spawn cal
144 port 200 port
201 db_set db_del db_reg
202 db_mon db_family db_keys db_values
145); 203);
146 204
147our $SELF; 205our $SELF;
148 206
149sub _self_die() { 207sub _self_die() {
160 218
161=item $nodeid = node_of $port 219=item $nodeid = node_of $port
162 220
163Extracts and returns the node ID from a port ID or a node ID. 221Extracts and returns the node ID from a port ID or a node ID.
164 222
223=item configure $profile, key => value...
224
165=item configure key => value... 225=item configure key => value...
166 226
167Before a node can talk to other nodes on the network (i.e. enter 227Before a node can talk to other nodes on the network (i.e. enter
168"distributed mode") it has to configure itself - the minimum a node needs 228"distributed mode") it has to configure itself - the minimum a node needs
169to know is its own name, and optionally it should know the addresses of 229to know is its own name, and optionally it should know the addresses of
170some other nodes in the network to discover other nodes. 230some other nodes in the network to discover other nodes.
171 231
172This function configures a node - it must be called exactly once (or 232This function configures a node - it must be called exactly once (or
173never) before calling other AnyEvent::MP functions. 233never) before calling other AnyEvent::MP functions.
174 234
235The key/value pairs are basically the same ones as documented for the
236F<aemp> command line utility (sans the set/del prefix), with these additions:
237
238=over 4
239
240=item norc => $boolean (default false)
241
242If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
243be consulted - all configuraiton options must be specified in the
244C<configure> call.
245
246=item force => $boolean (default false)
247
248IF true, then the values specified in the C<configure> will take
249precedence over any values configured via the rc file. The default is for
250the rc file to override any options specified in the program.
251
252=item secure => $pass->($nodeid)
253
254In addition to specifying a boolean, you can specify a code reference that
255is called for every remote execution attempt - the execution request is
256granted iff the callback returns a true value.
257
258See F<semp setsecure> for more info.
259
260=back
261
175=over 4 262=over 4
176 263
177=item step 1, gathering configuration from profiles 264=item step 1, gathering configuration from profiles
178 265
179The function first looks up a profile in the aemp configuration (see the 266The function first looks up a profile in the aemp configuration (see the
180L<aemp> commandline utility). The profile name can be specified via the 267L<aemp> commandline utility). The profile name can be specified via the
181named C<profile> parameter. If it is missing, then the nodename (F<uname 268named C<profile> parameter or can simply be the first parameter). If it is
182-n>) will be used as profile name. 269missing, then the nodename (F<uname -n>) will be used as profile name.
183 270
184The profile data is then gathered as follows: 271The profile data is then gathered as follows:
185 272
186First, all remaining key => value pairs (all of which are conviniently 273First, all remaining key => value pairs (all of which are conveniently
187undocumented at the moment) will be interpreted as configuration 274undocumented at the moment) will be interpreted as configuration
188data. Then they will be overwritten by any values specified in the global 275data. Then they will be overwritten by any values specified in the global
189default configuration (see the F<aemp> utility), then the chain of 276default configuration (see the F<aemp> utility), then the chain of
190profiles chosen by the profile name (and any C<parent> attributes). 277profiles chosen by the profile name (and any C<parent> attributes).
191 278
192That means that the values specified in the profile have highest priority 279That means that the values specified in the profile have highest priority
193and the values specified directly via C<configure> have lowest priority, 280and the values specified directly via C<configure> have lowest priority,
194and can only be used to specify defaults. 281and can only be used to specify defaults.
195 282
196If the profile specifies a node ID, then this will become the node ID of 283If the profile specifies a node ID, then this will become the node ID of
197this process. If not, then the profile name will be used as node ID. The 284this process. If not, then the profile name will be used as node ID, with
198special node ID of C<anon/> will be replaced by a random node ID. 285a unique randoms tring (C</%u>) appended.
286
287The node ID can contain some C<%> sequences that are expanded: C<%n>
288is expanded to the local nodename, C<%u> is replaced by a random
289strign to make the node unique. For example, the F<aemp> commandline
290utility uses C<aemp/%n/%u> as nodename, which might expand to
291C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
199 292
200=item step 2, bind listener sockets 293=item step 2, bind listener sockets
201 294
202The next step is to look up the binds in the profile, followed by binding 295The next step is to look up the binds in the profile, followed by binding
203aemp protocol listeners on all binds specified (it is possible and valid 296aemp protocol listeners on all binds specified (it is possible and valid
209used, meaning the node will bind on a dynamically-assigned port on every 302used, meaning the node will bind on a dynamically-assigned port on every
210local IP address it finds. 303local IP address it finds.
211 304
212=item step 3, connect to seed nodes 305=item step 3, connect to seed nodes
213 306
214As the last step, the seeds list from the profile is passed to the 307As the last step, the seed ID list from the profile is passed to the
215L<AnyEvent::MP::Global> module, which will then use it to keep 308L<AnyEvent::MP::Global> module, which will then use it to keep
216connectivity with at least one node at any point in time. 309connectivity with at least one node at any point in time.
217 310
218=back 311=back
219 312
220Example: become a distributed node using the locla node name as profile. 313Example: become a distributed node using the local node name as profile.
221This should be the most common form of invocation for "daemon"-type nodes. 314This should be the most common form of invocation for "daemon"-type nodes.
222 315
223 configure 316 configure
224 317
225Example: become an anonymous node. This form is often used for commandline 318Example: become a semi-anonymous node. This form is often used for
226clients. 319commandline clients.
227 320
228 configure nodeid => "anon/"; 321 configure nodeid => "myscript/%n/%u";
229 322
230Example: configure a node using a profile called seed, which si suitable 323Example: configure a node using a profile called seed, which is suitable
231for a seed node as it binds on all local addresses on a fixed port (4040, 324for a seed node as it binds on all local addresses on a fixed port (4040,
232customary for aemp). 325customary for aemp).
233 326
234 # use the aemp commandline utility 327 # use the aemp commandline utility
235 # aemp profile seed nodeid anon/ binds '*:4040' 328 # aemp profile seed binds '*:4040'
236 329
237 # then use it 330 # then use it
238 configure profile => "seed"; 331 configure profile => "seed";
239 332
240 # or simply use aemp from the shell again: 333 # or simply use aemp from the shell again:
305 398
306=cut 399=cut
307 400
308sub rcv($@); 401sub rcv($@);
309 402
310sub _kilme { 403my $KILME = sub {
311 die "received message on port without callback"; 404 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
312} 405 kil $SELF, unhandled_message => "no callback found for message '$tag'";
406};
313 407
314sub port(;&) { 408sub port(;&) {
315 my $id = "$UNIQ." . $ID++; 409 my $id = $UNIQ . ++$ID;
316 my $port = "$NODE#$id"; 410 my $port = "$NODE#$id";
317 411
318 rcv $port, shift || \&_kilme; 412 rcv $port, shift || $KILME;
319 413
320 $port 414 $port
321} 415}
322 416
323=item rcv $local_port, $callback->(@msg) 417=item rcv $local_port, $callback->(@msg)
328 422
329The global C<$SELF> (exported by this module) contains C<$port> while 423The global C<$SELF> (exported by this module) contains C<$port> while
330executing the callback. Runtime errors during callback execution will 424executing the callback. Runtime errors during callback execution will
331result in the port being C<kil>ed. 425result in the port being C<kil>ed.
332 426
333The default callback received all messages not matched by a more specific 427The default callback receives all messages not matched by a more specific
334C<tag> match. 428C<tag> match.
335 429
336=item rcv $local_port, tag => $callback->(@msg_without_tag), ... 430=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
337 431
338Register (or replace) callbacks to be called on messages starting with the 432Register (or replace) callbacks to be called on messages starting with the
359 msg1 => sub { ... }, 453 msg1 => sub { ... },
360 ... 454 ...
361 ; 455 ;
362 456
363Example: temporarily register a rcv callback for a tag matching some port 457Example: temporarily register a rcv callback for a tag matching some port
364(e.g. for a rpc reply) and unregister it after a message was received. 458(e.g. for an rpc reply) and unregister it after a message was received.
365 459
366 rcv $port, $otherport => sub { 460 rcv $port, $otherport => sub {
367 my @reply = @_; 461 my @reply = @_;
368 462
369 rcv $SELF, $otherport; 463 rcv $SELF, $otherport;
382 if (ref $_[0]) { 476 if (ref $_[0]) {
383 if (my $self = $PORT_DATA{$portid}) { 477 if (my $self = $PORT_DATA{$portid}) {
384 "AnyEvent::MP::Port" eq ref $self 478 "AnyEvent::MP::Port" eq ref $self
385 or Carp::croak "$port: rcv can only be called on message matching ports, caught"; 479 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
386 480
387 $self->[2] = shift; 481 $self->[0] = shift;
388 } else { 482 } else {
389 my $cb = shift; 483 my $cb = shift;
390 $PORT{$portid} = sub { 484 $PORT{$portid} = sub {
391 local $SELF = $port; 485 local $SELF = $port;
392 eval { &$cb }; _self_die if $@; 486 eval { &$cb }; _self_die if $@;
393 }; 487 };
394 } 488 }
395 } elsif (defined $_[0]) { 489 } elsif (defined $_[0]) {
396 my $self = $PORT_DATA{$portid} ||= do { 490 my $self = $PORT_DATA{$portid} ||= do {
397 my $self = bless [$PORT{$port} || sub { }, { }, $port], "AnyEvent::MP::Port"; 491 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
398 492
399 $PORT{$portid} = sub { 493 $PORT{$portid} = sub {
400 local $SELF = $port; 494 local $SELF = $port;
401 495
402 if (my $cb = $self->[1]{$_[0]}) { 496 if (my $cb = $self->[1]{$_[0]}) {
424 } 518 }
425 519
426 $port 520 $port
427} 521}
428 522
523=item peval $port, $coderef[, @args]
524
525Evaluates the given C<$codref> within the contetx of C<$port>, that is,
526when the code throews an exception the C<$port> will be killed.
527
528Any remaining args will be passed to the callback. Any return values will
529be returned to the caller.
530
531This is useful when you temporarily want to execute code in the context of
532a port.
533
534Example: create a port and run some initialisation code in it's context.
535
536 my $port = port { ... };
537
538 peval $port, sub {
539 init
540 or die "unable to init";
541 };
542
543=cut
544
545sub peval($$) {
546 local $SELF = shift;
547 my $cb = shift;
548
549 if (wantarray) {
550 my @res = eval { &$cb };
551 _self_die if $@;
552 @res
553 } else {
554 my $res = eval { &$cb };
555 _self_die if $@;
556 $res
557 }
558}
559
429=item $closure = psub { BLOCK } 560=item $closure = psub { BLOCK }
430 561
431Remembers C<$SELF> and creates a closure out of the BLOCK. When the 562Remembers C<$SELF> and creates a closure out of the BLOCK. When the
432closure is executed, sets up the environment in the same way as in C<rcv> 563closure is executed, sets up the environment in the same way as in C<rcv>
433callbacks, i.e. runtime errors will cause the port to get C<kil>ed. 564callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
565
566The effect is basically as if it returned C<< sub { peval $SELF, sub {
567BLOCK }, @_ } >>.
434 568
435This is useful when you register callbacks from C<rcv> callbacks: 569This is useful when you register callbacks from C<rcv> callbacks:
436 570
437 rcv delayed_reply => sub { 571 rcv delayed_reply => sub {
438 my ($delay, @reply) = @_; 572 my ($delay, @reply) = @_;
474 608
475Monitor the given port and do something when the port is killed or 609Monitor the given port and do something when the port is killed or
476messages to it were lost, and optionally return a guard that can be used 610messages to it were lost, and optionally return a guard that can be used
477to stop monitoring again. 611to stop monitoring again.
478 612
613In the first form (callback), the callback is simply called with any
614number of C<@reason> elements (no @reason means that the port was deleted
615"normally"). Note also that I<< the callback B<must> never die >>, so use
616C<eval> if unsure.
617
618In the second form (another port given), the other port (C<$rcvport>)
619will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
620"normal" kils nothing happens, while under all other conditions, the other
621port is killed with the same reason.
622
623The third form (kill self) is the same as the second form, except that
624C<$rvport> defaults to C<$SELF>.
625
626In the last form (message), a message of the form C<@msg, @reason> will be
627C<snd>.
628
629Monitoring-actions are one-shot: once messages are lost (and a monitoring
630alert was raised), they are removed and will not trigger again.
631
632As a rule of thumb, monitoring requests should always monitor a port from
633a local port (or callback). The reason is that kill messages might get
634lost, just like any other message. Another less obvious reason is that
635even monitoring requests can get lost (for example, when the connection
636to the other node goes down permanently). When monitoring a port locally
637these problems do not exist.
638
479C<mon> effectively guarantees that, in the absence of hardware failures, 639C<mon> effectively guarantees that, in the absence of hardware failures,
480after starting the monitor, either all messages sent to the port will 640after starting the monitor, either all messages sent to the port will
481arrive, or the monitoring action will be invoked after possible message 641arrive, or the monitoring action will be invoked after possible message
482loss has been detected. No messages will be lost "in between" (after 642loss has been detected. No messages will be lost "in between" (after
483the first lost message no further messages will be received by the 643the first lost message no further messages will be received by the
484port). After the monitoring action was invoked, further messages might get 644port). After the monitoring action was invoked, further messages might get
485delivered again. 645delivered again.
486 646
487Note that monitoring-actions are one-shot: once messages are lost (and a 647Inter-host-connection timeouts and monitoring depend on the transport
488monitoring alert was raised), they are removed and will not trigger again. 648used. The only transport currently implemented is TCP, and AnyEvent::MP
649relies on TCP to detect node-downs (this can take 10-15 minutes on a
650non-idle connection, and usually around two hours for idle connections).
489 651
490In the first form (callback), the callback is simply called with any 652This means that monitoring is good for program errors and cleaning up
491number of C<@reason> elements (no @reason means that the port was deleted 653stuff eventually, but they are no replacement for a timeout when you need
492"normally"). Note also that I<< the callback B<must> never die >>, so use 654to ensure some maximum latency.
493C<eval> if unsure.
494
495In the second form (another port given), the other port (C<$rcvport>)
496will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
497"normal" kils nothing happens, while under all other conditions, the other
498port is killed with the same reason.
499
500The third form (kill self) is the same as the second form, except that
501C<$rvport> defaults to C<$SELF>.
502
503In the last form (message), a message of the form C<@msg, @reason> will be
504C<snd>.
505
506As a rule of thumb, monitoring requests should always monitor a port from
507a local port (or callback). The reason is that kill messages might get
508lost, just like any other message. Another less obvious reason is that
509even monitoring requests can get lost (for exmaple, when the connection
510to the other node goes down permanently). When monitoring a port locally
511these problems do not exist.
512 655
513Example: call a given callback when C<$port> is killed. 656Example: call a given callback when C<$port> is killed.
514 657
515 mon $port, sub { warn "port died because of <@_>\n" }; 658 mon $port, sub { warn "port died because of <@_>\n" };
516 659
544 } 687 }
545 688
546 $node->monitor ($port, $cb); 689 $node->monitor ($port, $cb);
547 690
548 defined wantarray 691 defined wantarray
549 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 692 and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
550} 693}
551 694
552=item $guard = mon_guard $port, $ref, $ref... 695=item $guard = mon_guard $port, $ref, $ref...
553 696
554Monitors the given C<$port> and keeps the passed references. When the port 697Monitors the given C<$port> and keeps the passed references. When the port
577 720
578=item kil $port[, @reason] 721=item kil $port[, @reason]
579 722
580Kill the specified port with the given C<@reason>. 723Kill the specified port with the given C<@reason>.
581 724
582If no C<@reason> is specified, then the port is killed "normally" (ports 725If no C<@reason> is specified, then the port is killed "normally" -
583monitoring other ports will not necessarily die because a port dies 726monitor callback will be invoked, but the kil will not cause linked ports
584"normally"). 727(C<mon $mport, $lport> form) to get killed.
585 728
586Otherwise, linked ports get killed with the same reason (second form of 729If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
587C<mon>, see above). 730form) get killed with the same reason.
588 731
589Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks 732Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
590will be reported as reason C<< die => $@ >>. 733will be reported as reason C<< die => $@ >>.
591 734
592Transport/communication errors are reported as C<< transport_error => 735Transport/communication errors are reported as C<< transport_error =>
593$message >>. 736$message >>.
594 737
595=cut 738Common idioms:
739
740 # silently remove yourself, do not kill linked ports
741 kil $SELF;
742
743 # report a failure in some detail
744 kil $SELF, failure_mode_1 => "it failed with too high temperature";
745
746 # do not waste much time with killing, just die when something goes wrong
747 open my $fh, "<file"
748 or die "file: $!";
596 749
597=item $port = spawn $node, $initfunc[, @initdata] 750=item $port = spawn $node, $initfunc[, @initdata]
598 751
599Creates a port on the node C<$node> (which can also be a port ID, in which 752Creates a port on the node C<$node> (which can also be a port ID, in which
600case it's the node where that port resides). 753case it's the node where that port resides).
611the package, then the package above the package and so on (e.g. 764the package, then the package above the package and so on (e.g.
612C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function 765C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
613exists or it runs out of package names. 766exists or it runs out of package names.
614 767
615The init function is then called with the newly-created port as context 768The init function is then called with the newly-created port as context
616object (C<$SELF>) and the C<@initdata> values as arguments. 769object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
770call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
771the port might not get created.
617 772
618A common idiom is to pass a local port, immediately monitor the spawned 773A common idiom is to pass a local port, immediately monitor the spawned
619port, and in the remote init function, immediately monitor the passed 774port, and in the remote init function, immediately monitor the passed
620local port. This two-way monitoring ensures that both ports get cleaned up 775local port. This two-way monitoring ensures that both ports get cleaned up
621when there is a problem. 776when there is a problem.
622 777
778C<spawn> guarantees that the C<$initfunc> has no visible effects on the
779caller before C<spawn> returns (by delaying invocation when spawn is
780called for the local node).
781
623Example: spawn a chat server port on C<$othernode>. 782Example: spawn a chat server port on C<$othernode>.
624 783
625 # this node, executed from within a port context: 784 # this node, executed from within a port context:
626 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; 785 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
627 mon $server; 786 mon $server;
641 800
642sub _spawn { 801sub _spawn {
643 my $port = shift; 802 my $port = shift;
644 my $init = shift; 803 my $init = shift;
645 804
805 # rcv will create the actual port
646 local $SELF = "$NODE#$port"; 806 local $SELF = "$NODE#$port";
647 eval { 807 eval {
648 &{ load_func $init } 808 &{ load_func $init }
649 }; 809 };
650 _self_die if $@; 810 _self_die if $@;
651} 811}
652 812
653sub spawn(@) { 813sub spawn(@) {
654 my ($nodeid, undef) = split /#/, shift, 2; 814 my ($nodeid, undef) = split /#/, shift, 2;
655 815
656 my $id = "$RUNIQ." . $ID++; 816 my $id = $RUNIQ . ++$ID;
657 817
658 $_[0] =~ /::/ 818 $_[0] =~ /::/
659 or Carp::croak "spawn init function must be a fully-qualified name, caught"; 819 or Carp::croak "spawn init function must be a fully-qualified name, caught";
660 820
661 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_; 821 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
662 822
663 "$nodeid#$id" 823 "$nodeid#$id"
664} 824}
825
665 826
666=item after $timeout, @msg 827=item after $timeout, @msg
667 828
668=item after $timeout, $callback 829=item after $timeout, $callback
669 830
685 ? $action[0]() 846 ? $action[0]()
686 : snd @action; 847 : snd @action;
687 }; 848 };
688} 849}
689 850
851#=item $cb2 = timeout $seconds, $cb[, @args]
852
853=item cal $port, @msg, $callback[, $timeout]
854
855A simple form of RPC - sends a message to the given C<$port> with the
856given contents (C<@msg>), but adds a reply port to the message.
857
858The reply port is created temporarily just for the purpose of receiving
859the reply, and will be C<kil>ed when no longer needed.
860
861A reply message sent to the port is passed to the C<$callback> as-is.
862
863If an optional time-out (in seconds) is given and it is not C<undef>,
864then the callback will be called without any arguments after the time-out
865elapsed and the port is C<kil>ed.
866
867If no time-out is given (or it is C<undef>), then the local port will
868monitor the remote port instead, so it eventually gets cleaned-up.
869
870Currently this function returns the temporary port, but this "feature"
871might go in future versions unless you can make a convincing case that
872this is indeed useful for something.
873
874=cut
875
876sub cal(@) {
877 my $timeout = ref $_[-1] ? undef : pop;
878 my $cb = pop;
879
880 my $port = port {
881 undef $timeout;
882 kil $SELF;
883 &$cb;
884 };
885
886 if (defined $timeout) {
887 $timeout = AE::timer $timeout, 0, sub {
888 undef $timeout;
889 kil $port;
890 $cb->();
891 };
892 } else {
893 mon $_[0], sub {
894 kil $port;
895 $cb->();
896 };
897 }
898
899 push @_, $port;
900 &snd;
901
902 $port
903}
904
905=back
906
907=head1 DISTRIBUTED DATABASE
908
909AnyEvent::MP comes with a simple distributed database. The database will
910be mirrored asynchronously on all global nodes. Other nodes bind to one
911of the global nodes for their needs. Every node has a "local database"
912which contains all the values that are set locally. All local databases
913are merged together to form the global database, which can be queried.
914
915The database structure is that of a two-level hash - the database hash
916contains hashes which contain values, similarly to a perl hash of hashes,
917i.e.:
918
919 $DATABASE{$family}{$subkey} = $value
920
921The top level hash key is called "family", and the second-level hash key
922is called "subkey" or simply "key".
923
924The family must be alphanumeric, i.e. start with a letter and consist
925of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
926pretty much like Perl module names.
927
928As the family namespace is global, it is recommended to prefix family names
929with the name of the application or module using it.
930
931The subkeys must be non-empty strings, with no further restrictions.
932
933The values should preferably be strings, but other perl scalars should
934work as well (such as C<undef>, arrays and hashes).
935
936Every database entry is owned by one node - adding the same family/subkey
937combination on multiple nodes will not cause discomfort for AnyEvent::MP,
938but the result might be nondeterministic, i.e. the key might have
939different values on different nodes.
940
941Different subkeys in the same family can be owned by different nodes
942without problems, and in fact, this is the common method to create worker
943pools. For example, a worker port for image scaling might do this:
944
945 db_set my_image_scalers => $port;
946
947And clients looking for an image scaler will want to get the
948C<my_image_scalers> keys from time to time:
949
950 db_keys my_image_scalers => sub {
951 @ports = @{ $_[0] };
952 };
953
954Or better yet, they want to monitor the database family, so they always
955have a reasonable up-to-date copy:
956
957 db_mon my_image_scalers => sub {
958 @ports = keys %{ $_[0] };
959 };
960
961In general, you can set or delete single subkeys, but query and monitor
962whole families only.
963
964If you feel the need to monitor or query a single subkey, try giving it
965it's own family.
966
967=over
968
969=item db_set $family => $subkey [=> $value]
970
971Sets (or replaces) a key to the database - if C<$value> is omitted,
972C<undef> is used instead.
973
974=item db_del $family => $subkey...
975
976Deletes one or more subkeys from the database family.
977
978=item $guard = db_reg $family => $subkey [=> $value]
979
980Sets the key on the database and returns a guard. When the guard is
981destroyed, the key is deleted from the database. If C<$value> is missing,
982then C<undef> is used.
983
984=item db_family $family => $cb->(\%familyhash)
985
986Queries the named database C<$family> and call the callback with the
987family represented as a hash. You can keep and freely modify the hash.
988
989=item db_keys $family => $cb->(\@keys)
990
991Same as C<db_family>, except it only queries the family I<subkeys> and passes
992them as array reference to the callback.
993
994=item db_values $family => $cb->(\@values)
995
996Same as C<db_family>, except it only queries the family I<values> and passes them
997as array reference to the callback.
998
999=item $guard = db_mon $family => $cb->($familyhash, \@added, \@changed, \@deleted)
1000
1001Creates a monitor on the given database family. Each time a key is set
1002or or is deleted the callback is called with a hash containing the
1003database family and three lists of added, changed and deleted subkeys,
1004respectively. If no keys have changed then the array reference might be
1005C<undef> or even missing.
1006
1007If not called in void context, a guard object is returned that, when
1008destroyed, stops the monitor.
1009
1010The family hash reference and the key arrays belong to AnyEvent::MP and
1011B<must not be modified or stored> by the callback. When in doubt, make a
1012copy.
1013
1014As soon as possible after the monitoring starts, the callback will be
1015called with the intiial contents of the family, even if it is empty,
1016i.e. there will always be a timely call to the callback with the current
1017contents.
1018
1019It is possible that the callback is called with a change event even though
1020the subkey is already present and the value has not changed.
1021
1022The monitoring stops when the guard object is destroyed.
1023
1024Example: on every change to the family "mygroup", print out all keys.
1025
1026 my $guard = db_mon mygroup => sub {
1027 my ($family, $a, $c, $d) = @_;
1028 print "mygroup members: ", (join " ", keys %$family), "\n";
1029 };
1030
1031Exmaple: wait until the family "My::Module::workers" is non-empty.
1032
1033 my $guard; $guard = db_mon My::Module::workers => sub {
1034 my ($family, $a, $c, $d) = @_;
1035 return unless %$family;
1036 undef $guard;
1037 print "My::Module::workers now nonempty\n";
1038 };
1039
1040Example: print all changes to the family "AnyRvent::Fantasy::Module".
1041
1042 my $guard = db_mon AnyRvent::Fantasy::Module => sub {
1043 my ($family, $a, $c, $d) = @_;
1044
1045 print "+$_=$family->{$_}\n" for @$a;
1046 print "*$_=$family->{$_}\n" for @$c;
1047 print "-$_=$family->{$_}\n" for @$d;
1048 };
1049
1050=cut
1051
690=back 1052=back
691 1053
692=head1 AnyEvent::MP vs. Distributed Erlang 1054=head1 AnyEvent::MP vs. Distributed Erlang
693 1055
694AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 1056AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
695== aemp node, Erlang process == aemp port), so many of the documents and 1057== aemp node, Erlang process == aemp port), so many of the documents and
696programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 1058programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
697sample: 1059sample:
698 1060
699 http://www.Erlang.se/doc/programming_rules.shtml 1061 http://www.erlang.se/doc/programming_rules.shtml
700 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 1062 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
701 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 1063 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
702 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 1064 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
703 1065
704Despite the similarities, there are also some important differences: 1066Despite the similarities, there are also some important differences:
705 1067
706=over 4 1068=over 4
707 1069
708=item * Node IDs are arbitrary strings in AEMP. 1070=item * Node IDs are arbitrary strings in AEMP.
709 1071
710Erlang relies on special naming and DNS to work everywhere in the same 1072Erlang relies on special naming and DNS to work everywhere in the same
711way. AEMP relies on each node somehow knowing its own address(es) (e.g. by 1073way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
712configuraiton or DNS), but will otherwise discover other odes itself. 1074configuration or DNS), and possibly the addresses of some seed nodes, but
1075will otherwise discover other nodes (and their IDs) itself.
713 1076
714=item * Erlang has a "remote ports are like local ports" philosophy, AEMP 1077=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
715uses "local ports are like remote ports". 1078uses "local ports are like remote ports".
716 1079
717The failure modes for local ports are quite different (runtime errors 1080The failure modes for local ports are quite different (runtime errors
726ports being the special case/exception, where transport errors cannot 1089ports being the special case/exception, where transport errors cannot
727occur. 1090occur.
728 1091
729=item * Erlang uses processes and a mailbox, AEMP does not queue. 1092=item * Erlang uses processes and a mailbox, AEMP does not queue.
730 1093
731Erlang uses processes that selectively receive messages, and therefore 1094Erlang uses processes that selectively receive messages out of order, and
732needs a queue. AEMP is event based, queuing messages would serve no 1095therefore needs a queue. AEMP is event based, queuing messages would serve
733useful purpose. For the same reason the pattern-matching abilities of 1096no useful purpose. For the same reason the pattern-matching abilities
734AnyEvent::MP are more limited, as there is little need to be able to 1097of AnyEvent::MP are more limited, as there is little need to be able to
735filter messages without dequeing them. 1098filter messages without dequeuing them.
736 1099
737(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). 1100This is not a philosophical difference, but simply stems from AnyEvent::MP
1101being event-based, while Erlang is process-based.
1102
1103You cna have a look at L<Coro::MP> for a more Erlang-like process model on
1104top of AEMP and Coro threads.
738 1105
739=item * Erlang sends are synchronous, AEMP sends are asynchronous. 1106=item * Erlang sends are synchronous, AEMP sends are asynchronous.
740 1107
741Sending messages in Erlang is synchronous and blocks the process (and 1108Sending messages in Erlang is synchronous and blocks the process until
1109a conenction has been established and the message sent (and so does not
742so does not need a queue that can overflow). AEMP sends are immediate, 1110need a queue that can overflow). AEMP sends return immediately, connection
743connection establishment is handled in the background. 1111establishment is handled in the background.
744 1112
745=item * Erlang suffers from silent message loss, AEMP does not. 1113=item * Erlang suffers from silent message loss, AEMP does not.
746 1114
747Erlang makes few guarantees on messages delivery - messages can get lost 1115Erlang implements few guarantees on messages delivery - messages can get
748without any of the processes realising it (i.e. you send messages a, b, 1116lost without any of the processes realising it (i.e. you send messages a,
749and c, and the other side only receives messages a and c). 1117b, and c, and the other side only receives messages a and c).
750 1118
751AEMP guarantees correct ordering, and the guarantee that after one message 1119AEMP guarantees (modulo hardware errors) correct ordering, and the
752is lost, all following ones sent to the same port are lost as well, until 1120guarantee that after one message is lost, all following ones sent to the
753monitoring raises an error, so there are no silent "holes" in the message 1121same port are lost as well, until monitoring raises an error, so there are
754sequence. 1122no silent "holes" in the message sequence.
1123
1124If you want your software to be very reliable, you have to cope with
1125corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
1126simply tries to work better in common error cases, such as when a network
1127link goes down.
755 1128
756=item * Erlang can send messages to the wrong port, AEMP does not. 1129=item * Erlang can send messages to the wrong port, AEMP does not.
757 1130
758In Erlang it is quite likely that a node that restarts reuses a process ID 1131In Erlang it is quite likely that a node that restarts reuses an Erlang
759known to other nodes for a completely different process, causing messages 1132process ID known to other nodes for a completely different process,
760destined for that process to end up in an unrelated process. 1133causing messages destined for that process to end up in an unrelated
1134process.
761 1135
762AEMP never reuses port IDs, so old messages or old port IDs floating 1136AEMP does not reuse port IDs, so old messages or old port IDs floating
763around in the network will not be sent to an unrelated port. 1137around in the network will not be sent to an unrelated port.
764 1138
765=item * Erlang uses unprotected connections, AEMP uses secure 1139=item * Erlang uses unprotected connections, AEMP uses secure
766authentication and can use TLS. 1140authentication and can use TLS.
767 1141
770 1144
771=item * The AEMP protocol is optimised for both text-based and binary 1145=item * The AEMP protocol is optimised for both text-based and binary
772communications. 1146communications.
773 1147
774The AEMP protocol, unlike the Erlang protocol, supports both programming 1148The AEMP protocol, unlike the Erlang protocol, supports both programming
775language independent text-only protocols (good for debugging) and binary, 1149language independent text-only protocols (good for debugging), and binary,
776language-specific serialisers (e.g. Storable). By default, unless TLS is 1150language-specific serialisers (e.g. Storable). By default, unless TLS is
777used, the protocol is actually completely text-based. 1151used, the protocol is actually completely text-based.
778 1152
779It has also been carefully designed to be implementable in other languages 1153It has also been carefully designed to be implementable in other languages
780with a minimum of work while gracefully degrading functionality to make the 1154with a minimum of work while gracefully degrading functionality to make the
781protocol simple. 1155protocol simple.
782 1156
783=item * AEMP has more flexible monitoring options than Erlang. 1157=item * AEMP has more flexible monitoring options than Erlang.
784 1158
785In Erlang, you can chose to receive I<all> exit signals as messages 1159In Erlang, you can chose to receive I<all> exit signals as messages or
786or I<none>, there is no in-between, so monitoring single processes is 1160I<none>, there is no in-between, so monitoring single Erlang processes is
787difficult to implement. Monitoring in AEMP is more flexible than in 1161difficult to implement.
788Erlang, as one can choose between automatic kill, exit message or callback 1162
789on a per-process basis. 1163Monitoring in AEMP is more flexible than in Erlang, as one can choose
1164between automatic kill, exit message or callback on a per-port basis.
790 1165
791=item * Erlang tries to hide remote/local connections, AEMP does not. 1166=item * Erlang tries to hide remote/local connections, AEMP does not.
792 1167
793Monitoring in Erlang is not an indicator of process death/crashes, in the 1168Monitoring in Erlang is not an indicator of process death/crashes, in the
794same way as linking is (except linking is unreliable in Erlang). 1169same way as linking is (except linking is unreliable in Erlang).
816overhead, as well as having to keep a proxy object everywhere. 1191overhead, as well as having to keep a proxy object everywhere.
817 1192
818Strings can easily be printed, easily serialised etc. and need no special 1193Strings can easily be printed, easily serialised etc. and need no special
819procedures to be "valid". 1194procedures to be "valid".
820 1195
821And as a result, a miniport consists of a single closure stored in a 1196And as a result, a port with just a default receiver consists of a single
822global hash - it can't become much cheaper. 1197code reference stored in a global hash - it can't become much cheaper.
823 1198
824=item Why favour JSON, why not a real serialising format such as Storable? 1199=item Why favour JSON, why not a real serialising format such as Storable?
825 1200
826In fact, any AnyEvent::MP node will happily accept Storable as framing 1201In fact, any AnyEvent::MP node will happily accept Storable as framing
827format, but currently there is no way to make a node use Storable by 1202format, but currently there is no way to make a node use Storable by
843 1218
844L<AnyEvent::MP::Intro> - a gentle introduction. 1219L<AnyEvent::MP::Intro> - a gentle introduction.
845 1220
846L<AnyEvent::MP::Kernel> - more, lower-level, stuff. 1221L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
847 1222
848L<AnyEvent::MP::Global> - network maintainance and port groups, to find 1223L<AnyEvent::MP::Global> - network maintenance and port groups, to find
849your applications. 1224your applications.
1225
1226L<AnyEvent::MP::DataConn> - establish data connections between nodes.
1227
1228L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
1229all nodes.
850 1230
851L<AnyEvent>. 1231L<AnyEvent>.
852 1232
853=head1 AUTHOR 1233=head1 AUTHOR
854 1234

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines