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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines