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.15 by root, Sun Aug 2 19:25:27 2009 UTC vs.
Revision 1.127 by root, Sat Mar 3 20:35:10 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
9 NODE # returns this node identifier
10 $NODE # contains this node identifier 9 $NODE # contains this node's node ID
10 NODE # returns this node's node ID
11 11
12 $SELF # receiving/own port id in rcv callbacks
13
14 # initialise the node so it can send/receive messages
15 configure;
16
17 # ports are message destinations
18
19 # sending messages
12 snd $port, type => data...; 20 snd $port, type => data...;
21 snd $port, @msg;
22 snd @msg_with_first_element_being_a_port;
13 23
14 rcv $port, smartmatch => $cb->($port, @msg); 24 # creating/using ports, the simple way
25 my $simple_port = port { my @msg = @_ };
15 26
16 # examples: 27 # creating/using ports, tagged message matching
28 my $port = port;
17 rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; 29 rcv $port, ping => sub { snd $_[0], "pong" };
18 rcv $port1, pong => sub { warn "pong received\n" }; 30 rcv $port, pong => sub { warn "pong received\n" };
19 snd $port2, ping => $port1;
20 31
21 # more, smarter, matches (_any_ is exported by this module) 32 # create a port on another node
22 rcv $port, [child_died => $pid] => sub { ... 33 my $port = spawn $node, $initfunc, @initdata;
23 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3 34
35 # destroy a port again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
39 # monitoring
40 mon $localport, $cb->(@msg) # callback is invoked on death
41 mon $localport, $otherport # kill otherport on abnormal death
42 mon $localport, $otherport, @msg # send message on death
43
44 # temporarily execute code in port context
45 peval $port, sub { die "kill the port!" };
46
47 # execute callbacks in $SELF port context
48 my $timer = AE::timer 1, 0, psub {
49 die "kill the port, delayed";
50 };
51
52=head1 CURRENT STATUS
53
54 bin/aemp - stable.
55 AnyEvent::MP - stable API, should work.
56 AnyEvent::MP::Intro - explains most concepts.
57 AnyEvent::MP::Kernel - mostly stable API.
58 AnyEvent::MP::Global - stable API.
24 59
25=head1 DESCRIPTION 60=head1 DESCRIPTION
26 61
27This module (-family) implements a simple message passing framework. 62This module (-family) implements a simple message passing framework.
28 63
29Despite its simplicity, you can securely message other processes running 64Despite its simplicity, you can securely message other processes running
30on the same or other hosts. 65on the same or other hosts, and you can supervise entities remotely.
31 66
32At the moment, this module family is severly brokena nd underdocumented, 67For an introduction to this module family, see the L<AnyEvent::MP::Intro>
33so do not use. This was uploaded mainly to resreve the CPAN namespace - 68manual page and the examples under F<eg/>.
34stay tuned!
35 69
36=head1 CONCEPTS 70=head1 CONCEPTS
37 71
38=over 4 72=over 4
39 73
40=item port 74=item port
41 75
42A port is something you can send messages to with the C<snd> function, and 76Not to be confused with a TCP port, a "port" is something you can send
43you can register C<rcv> handlers with. All C<rcv> handlers will receive 77messages to (with the C<snd> function).
44messages they match, messages will not be queued.
45 78
79Ports allow you to register C<rcv> handlers that can match all or just
80some messages. Messages send to ports will not be queued, regardless of
81anything was listening for them or not.
82
83Ports are represented by (printable) strings called "port IDs".
84
46=item port id - C<noderef#portname> 85=item port ID - C<nodeid#portname>
47 86
48A port id is always the noderef, a hash-mark (C<#>) as separator, followed 87A port ID is the concatenation of a node ID, a hash-mark (C<#>)
49by 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).
50 90
51=item node 91=item node
52 92
53A node is a single process containing at least one port - the node 93A node is a single process containing at least one port - the node port,
54port. You can send messages to node ports to let them create new ports, 94which enables nodes to manage each other remotely, and to create new
55among other things. 95ports.
56 96
57Initially, nodes are either private (single-process only) or hidden 97Nodes are either public (have one or more listening ports) or private
58(connected to a master node only). Only when they epxlicitly "become 98(no listening ports). Private nodes cannot talk to other private nodes
59public" can you send them messages from unrelated other nodes. 99currently, but all nodes can talk to public nodes.
60 100
61=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> 101Nodes is represented by (printable) strings called "node IDs".
62 102
103=item node ID - C<[A-Za-z0-9_\-.:]*>
104
63A noderef is a string that either uniquely identifies a given node (for 105A node ID is a string that uniquely identifies the node within a
64private and hidden nodes), or contains a recipe on how to reach a given 106network. Depending on the configuration used, node IDs can look like a
65node (for public nodes). 107hostname, a hostname and a port, or a random string. AnyEvent::MP itself
108doesn't interpret node IDs in any way except to uniquely identify a node.
109
110=item binds - C<ip:port>
111
112Nodes can only talk to each other by creating some kind of connection to
113each other. To do this, nodes should listen on one or more local transport
114endpoints - binds.
115
116Currently, only standard C<ip:port> specifications can be used, which
117specify TCP ports to listen on. So a bind is basically just a tcp socket
118in listening mode thta accepts conenctions form other nodes.
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
149=item seed IDs - C<host:port>
150
151Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
152TCP port) of nodes that should be used as seed nodes.
153
154=item global nodes
155
156An AEMP network needs a discovery service - nodes need to know how to
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).
66 170
67=back 171=back
68 172
69=head1 VARIABLES/FUNCTIONS 173=head1 VARIABLES/FUNCTIONS
70 174
72 176
73=cut 177=cut
74 178
75package AnyEvent::MP; 179package AnyEvent::MP;
76 180
181use AnyEvent::MP::Config ();
77use AnyEvent::MP::Base; 182use AnyEvent::MP::Kernel;
183use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
78 184
79use common::sense; 185use common::sense;
80 186
81use Carp (); 187use Carp ();
82 188
83use AE (); 189use AE ();
190use Guard ();
84 191
85use base "Exporter"; 192use base "Exporter";
86 193
87our $VERSION = '0.02'; 194our $VERSION = $AnyEvent::MP::Config::VERSION;
195
88our @EXPORT = qw( 196our @EXPORT = qw(
89 NODE $NODE $PORT snd rcv _any_ 197 NODE $NODE *SELF node_of after
90 create_port create_port_on 198 configure
91 create_miniport 199 snd rcv mon mon_guard kil psub peval spawn cal
92 become_slave become_public 200 port
201 db_set db_del db_reg
93); 202);
94 203
204our $SELF;
205
206sub _self_die() {
207 my $msg = $@;
208 $msg =~ s/\n+$// unless ref $msg;
209 kil $SELF, die => $msg;
210}
211
95=item NODE / $NODE 212=item $thisnode = NODE / $NODE
96 213
97The C<NODE ()> function and the C<$NODE> variable contain the noderef of 214The C<NODE> function returns, and the C<$NODE> variable contains, the node
98the local node. The value is initialised by a call to C<become_public> or 215ID of the node running in the current process. This value is initialised by
99C<become_slave>, after which all local port identifiers become invalid. 216a call to C<configure>.
100 217
218=item $nodeid = node_of $port
219
220Extracts and returns the node ID from a port ID or a node ID.
221
222=item configure $profile, key => value...
223
224=item configure key => value...
225
226Before a node can talk to other nodes on the network (i.e. enter
227"distributed mode") it has to configure itself - the minimum a node needs
228to know is its own name, and optionally it should know the addresses of
229some other nodes in the network to discover other nodes.
230
231This function configures a node - it must be called exactly once (or
232never) before calling other AnyEvent::MP functions.
233
234The key/value pairs are basically the same ones as documented for the
235F<aemp> command line utility (sans the set/del prefix), with these additions:
236
237=over 4
238
239=item norc => $boolean (default false)
240
241If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
242be consulted - all configuraiton options must be specified in the
243C<configure> call.
244
245=item force => $boolean (default false)
246
247IF true, then the values specified in the C<configure> will take
248precedence over any values configured via the rc file. The default is for
249the rc file to override any options specified in the program.
250
251=item secure => $pass->($nodeid)
252
253In addition to specifying a boolean, you can specify a code reference that
254is called for every remote execution attempt - the execution request is
255granted iff the callback returns a true value.
256
257See F<semp setsecure> for more info.
258
259=back
260
261=over 4
262
263=item step 1, gathering configuration from profiles
264
265The function first looks up a profile in the aemp configuration (see the
266L<aemp> commandline utility). The profile name can be specified via the
267named C<profile> parameter or can simply be the first parameter). If it is
268missing, then the nodename (F<uname -n>) will be used as profile name.
269
270The profile data is then gathered as follows:
271
272First, all remaining key => value pairs (all of which are conveniently
273undocumented at the moment) will be interpreted as configuration
274data. Then they will be overwritten by any values specified in the global
275default configuration (see the F<aemp> utility), then the chain of
276profiles chosen by the profile name (and any C<parent> attributes).
277
278That means that the values specified in the profile have highest priority
279and the values specified directly via C<configure> have lowest priority,
280and can only be used to specify defaults.
281
282If the profile specifies a node ID, then this will become the node ID of
283this process. If not, then the profile name will be used as node ID, with
284a unique randoms tring (C</%u>) appended.
285
286The node ID can contain some C<%> sequences that are expanded: C<%n>
287is expanded to the local nodename, C<%u> is replaced by a random
288strign to make the node unique. For example, the F<aemp> commandline
289utility uses C<aemp/%n/%u> as nodename, which might expand to
290C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
291
292=item step 2, bind listener sockets
293
294The next step is to look up the binds in the profile, followed by binding
295aemp protocol listeners on all binds specified (it is possible and valid
296to have no binds, meaning that the node cannot be contacted form the
297outside. This means the node cannot talk to other nodes that also have no
298binds, but it can still talk to all "normal" nodes).
299
300If the profile does not specify a binds list, then a default of C<*> is
301used, meaning the node will bind on a dynamically-assigned port on every
302local IP address it finds.
303
304=item step 3, connect to seed nodes
305
306As the last step, the seed ID list from the profile is passed to the
307L<AnyEvent::MP::Global> module, which will then use it to keep
308connectivity with at least one node at any point in time.
309
310=back
311
312Example: become a distributed node using the local node name as profile.
313This should be the most common form of invocation for "daemon"-type nodes.
314
315 configure
316
317Example: become a semi-anonymous node. This form is often used for
318commandline clients.
319
320 configure nodeid => "myscript/%n/%u";
321
322Example: configure a node using a profile called seed, which is suitable
323for a seed node as it binds on all local addresses on a fixed port (4040,
324customary for aemp).
325
326 # use the aemp commandline utility
327 # aemp profile seed binds '*:4040'
328
329 # then use it
330 configure profile => "seed";
331
332 # or simply use aemp from the shell again:
333 # aemp run profile seed
334
335 # or provide a nicer-to-remember nodeid
336 # aemp run profile seed nodeid "$(hostname)"
337
338=item $SELF
339
340Contains the current port id while executing C<rcv> callbacks or C<psub>
341blocks.
342
343=item *SELF, SELF, %SELF, @SELF...
344
345Due to some quirks in how perl exports variables, it is impossible to
346just export C<$SELF>, all the symbols named C<SELF> are exported by this
347module, but only C<$SELF> is currently used.
348
101=item snd $portid, type => @data 349=item snd $port, type => @data
102 350
103=item snd $portid, @msg 351=item snd $port, @msg
104 352
105Send the given message to the given port ID, which can identify either 353Send the given message to the given port, which can identify either a
106a local or a remote port, and can be either a string or soemthignt hat 354local or a remote port, and must be a port ID.
107stringifies a sa port ID (such as a port object :).
108 355
109While the message can be about anything, it is highly recommended to use a 356While the message can be almost anything, it is highly recommended to
110string as first element (a portid, or some word that indicates a request 357use a string as first element (a port ID, or some word that indicates a
111type etc.). 358request type etc.) and to consist if only simple perl values (scalars,
359arrays, hashes) - if you think you need to pass an object, think again.
112 360
113The message data effectively becomes read-only after a call to this 361The message data logically becomes read-only after a call to this
114function: modifying any argument is not allowed and can cause many 362function: modifying any argument (or values referenced by them) is
115problems. 363forbidden, as there can be considerable time between the call to C<snd>
364and the time the message is actually being serialised - in fact, it might
365never be copied as within the same process it is simply handed to the
366receiving port.
116 367
117The type of data you can transfer depends on the transport protocol: when 368The type of data you can transfer depends on the transport protocol: when
118JSON is used, then only strings, numbers and arrays and hashes consisting 369JSON is used, then only strings, numbers and arrays and hashes consisting
119of those are allowed (no objects). When Storable is used, then anything 370of those are allowed (no objects). When Storable is used, then anything
120that Storable can serialise and deserialise is allowed, and for the local 371that Storable can serialise and deserialise is allowed, and for the local
121node, anything can be passed. 372node, anything can be passed. Best rely only on the common denominator of
373these.
122 374
123=item $local_port = create_port 375=item $local_port = port
124 376
125Create a new local port object. See the next section for allowed methods. 377Create a new local port object and returns its port ID. Initially it has
378no callbacks set and will throw an error when it receives messages.
126 379
127=cut 380=item $local_port = port { my @msg = @_ }
128 381
129sub create_port { 382Creates a new local port, and returns its ID. Semantically the same as
130 my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID; 383creating a port and calling C<rcv $port, $callback> on it.
131 384
132 my $self = bless { 385The block will be called for every message received on the port, with the
133 id => "$NODE#$id", 386global variable C<$SELF> set to the port ID. Runtime errors will cause the
134 names => [$id], 387port to be C<kil>ed. The message will be passed as-is, no extra argument
135 }, "AnyEvent::MP::Port"; 388(i.e. no port ID) will be passed to the callback.
136 389
137 $AnyEvent::MP::Base::PORT{$id} = sub { 390If you want to stop/destroy the port, simply C<kil> it:
138 unshift @_, $self;
139 391
140 for (@{ $self->{rc0}{$_[1]} }) { 392 my $port = port {
141 $_ && &{$_->[0]} 393 my @msg = @_;
142 && undef $_; 394 ...
395 kil $SELF;
396 };
397
398=cut
399
400sub rcv($@);
401
402sub _kilme {
403 die "received message on port without callback";
404}
405
406sub port(;&) {
407 my $id = $UNIQ . ++$ID;
408 my $port = "$NODE#$id";
409
410 rcv $port, shift || \&_kilme;
411
412 $port
413}
414
415=item rcv $local_port, $callback->(@msg)
416
417Replaces the default callback on the specified port. There is no way to
418remove the default callback: use C<sub { }> to disable it, or better
419C<kil> the port when it is no longer needed.
420
421The global C<$SELF> (exported by this module) contains C<$port> while
422executing the callback. Runtime errors during callback execution will
423result in the port being C<kil>ed.
424
425The default callback received all messages not matched by a more specific
426C<tag> match.
427
428=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
429
430Register (or replace) callbacks to be called on messages starting with the
431given tag on the given port (and return the port), or unregister it (when
432C<$callback> is C<$undef> or missing). There can only be one callback
433registered for each tag.
434
435The original message will be passed to the callback, after the first
436element (the tag) has been removed. The callback will use the same
437environment as the default callback (see above).
438
439Example: create a port and bind receivers on it in one go.
440
441 my $port = rcv port,
442 msg1 => sub { ... },
443 msg2 => sub { ... },
444 ;
445
446Example: create a port, bind receivers and send it in a message elsewhere
447in one go:
448
449 snd $otherport, reply =>
450 rcv port,
451 msg1 => sub { ... },
452 ...
453 ;
454
455Example: temporarily register a rcv callback for a tag matching some port
456(e.g. for an rpc reply) and unregister it after a message was received.
457
458 rcv $port, $otherport => sub {
459 my @reply = @_;
460
461 rcv $SELF, $otherport;
462 };
463
464=cut
465
466sub rcv($@) {
467 my $port = shift;
468 my ($nodeid, $portid) = split /#/, $port, 2;
469
470 $NODE{$nodeid} == $NODE{""}
471 or Carp::croak "$port: rcv can only be called on local ports, caught";
472
473 while (@_) {
474 if (ref $_[0]) {
475 if (my $self = $PORT_DATA{$portid}) {
476 "AnyEvent::MP::Port" eq ref $self
477 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
478
479 $self->[0] = shift;
480 } else {
481 my $cb = shift;
482 $PORT{$portid} = sub {
483 local $SELF = $port;
484 eval { &$cb }; _self_die if $@;
485 };
486 }
487 } elsif (defined $_[0]) {
488 my $self = $PORT_DATA{$portid} ||= do {
489 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
490
491 $PORT{$portid} = sub {
492 local $SELF = $port;
493
494 if (my $cb = $self->[1]{$_[0]}) {
495 shift;
496 eval { &$cb }; _self_die if $@;
497 } else {
498 &{ $self->[0] };
499 }
500 };
501
502 $self
503 };
504
505 "AnyEvent::MP::Port" eq ref $self
506 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
507
508 my ($tag, $cb) = splice @_, 0, 2;
509
510 if (defined $cb) {
511 $self->[1]{$tag} = $cb;
512 } else {
513 delete $self->[1]{$tag};
514 }
143 } 515 }
516 }
144 517
145 for (@{ $self->{rcv}{$_[1]} }) { 518 $port
146 $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] 519}
147 && &{$_->[0]}
148 && undef $_;
149 }
150 520
151 for (@{ $self->{any} }) { 521=item peval $port, $coderef[, @args]
152 $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] 522
153 && &{$_->[0]} 523Evaluates the given C<$codref> within the contetx of C<$port>, that is,
154 && undef $_; 524when the code throews an exception the C<$port> will be killed.
155 } 525
526Any remaining args will be passed to the callback. Any return values will
527be returned to the caller.
528
529This is useful when you temporarily want to execute code in the context of
530a port.
531
532Example: create a port and run some initialisation code in it's context.
533
534 my $port = port { ... };
535
536 peval $port, sub {
537 init
538 or die "unable to init";
156 }; 539 };
157 540
158 $self
159}
160
161=item $portid = miniport { my @msg = @_; $finished }
162
163Creates a "mini port", that is, a very lightweight port without any
164pattern matching behind it, and returns its ID.
165
166The block will be called for every message received on the port. When the
167callback returns a true value its job is considered "done" and the port
168will be destroyed. Otherwise it will stay alive.
169
170The message will be passed as-is, no extra argument (ie.. no port id) will
171be passed to the callback.
172
173If you need the local port id in the callback, this works nicely:
174
175 my $port; $port = miniport {
176 snd $otherport, reply => $port;
177 };
178
179=cut 541=cut
180 542
181sub miniport(&) { 543sub peval($$) {
544 local $SELF = shift;
182 my $cb = shift; 545 my $cb = shift;
183 my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID;
184 546
185 $AnyEvent::MP::Base::PORT{$id} = sub { 547 if (wantarray) {
186 &$cb 548 my @res = eval { &$cb };
187 and delete $AnyEvent::MP::Base::PORT{$id}; 549 _self_die if $@;
188 }; 550 @res
189
190 "$NODE#$id"
191}
192
193package AnyEvent::MP::Port;
194
195=back
196
197=head1 METHODS FOR PORT OBJECTS
198
199=over 4
200
201=item "$port"
202
203A port object stringifies to its port ID, so can be used directly for
204C<snd> operations.
205
206=cut
207
208use overload
209 '""' => sub { $_[0]{id} },
210 fallback => 1;
211
212=item $port->rcv (type => $callback->($port, @msg))
213
214=item $port->rcv ($smartmatch => $callback->($port, @msg))
215
216=item $port->rcv ([$smartmatch...] => $callback->($port, @msg))
217
218Register a callback on the given port.
219
220The callback has to return a true value when its work is done, after
221which is will be removed, or a false value in which case it will stay
222registered.
223
224If the match is an array reference, then it will be matched against the
225first elements of the message, otherwise only the first element is being
226matched.
227
228Any element in the match that is specified as C<_any_> (a function
229exported by this module) matches any single element of the message.
230
231While not required, it is highly recommended that the first matching
232element is a string identifying the message. The one-string-only match is
233also the most efficient match (by far).
234
235=cut
236
237sub rcv($@) {
238 my ($self, $match, $cb) = @_;
239
240 if (!ref $match) {
241 push @{ $self->{rc0}{$match} }, [$cb];
242 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
243 my ($type, @match) = @$match;
244 @match
245 ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
246 : push @{ $self->{rc0}{$match->[0]} }, [$cb];
247 } else { 551 } else {
248 push @{ $self->{any} }, [$cb, $match]; 552 my $res = eval { &$cb };
553 _self_die if $@;
554 $res
249 } 555 }
250} 556}
251 557
252=item $port->register ($name) 558=item $closure = psub { BLOCK }
253 559
254Registers the given port under the well known name C<$name>. If the name 560Remembers C<$SELF> and creates a closure out of the BLOCK. When the
255already exists it is replaced. 561closure is executed, sets up the environment in the same way as in C<rcv>
562callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
256 563
257A port can only be registered under one well known name. 564The effect is basically as if it returned C<< sub { peval $SELF, sub {
565BLOCK }, @_ } >>.
258 566
259=cut 567This is useful when you register callbacks from C<rcv> callbacks:
260 568
261sub register { 569 rcv delayed_reply => sub {
262 my ($self, $name) = @_; 570 my ($delay, @reply) = @_;
571 my $timer = AE::timer $delay, 0, psub {
572 snd @reply, $SELF;
573 };
574 };
263 575
264 $self->{wkname} = $name; 576=cut
265 $AnyEvent::MP::Base::WKP{$name} = "$self"; 577
578sub psub(&) {
579 my $cb = shift;
580
581 my $port = $SELF
582 or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
583
584 sub {
585 local $SELF = $port;
586
587 if (wantarray) {
588 my @res = eval { &$cb };
589 _self_die if $@;
590 @res
591 } else {
592 my $res = eval { &$cb };
593 _self_die if $@;
594 $res
595 }
596 }
266} 597}
267 598
268=item $port->destroy 599=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
269 600
270Explicitly destroy/remove/nuke/vaporise the port. 601=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
271 602
272Ports are normally kept alive by there mere existance alone, and need to 603=item $guard = mon $port # kill $SELF when $port dies
273be destroyed explicitly.
274 604
275=cut 605=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
276 606
277sub destroy { 607Monitor the given port and do something when the port is killed or
278 my ($self) = @_; 608messages to it were lost, and optionally return a guard that can be used
609to stop monitoring again.
279 610
280 delete $AnyEvent::MP::Base::WKP{ $self->{wkname} }; 611In the first form (callback), the callback is simply called with any
612number of C<@reason> elements (no @reason means that the port was deleted
613"normally"). Note also that I<< the callback B<must> never die >>, so use
614C<eval> if unsure.
281 615
282 delete $AnyEvent::MP::Base::PORT{$_} 616In the second form (another port given), the other port (C<$rcvport>)
283 for @{ $self->{names} }; 617will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
618"normal" kils nothing happens, while under all other conditions, the other
619port is killed with the same reason.
620
621The third form (kill self) is the same as the second form, except that
622C<$rvport> defaults to C<$SELF>.
623
624In the last form (message), a message of the form C<@msg, @reason> will be
625C<snd>.
626
627Monitoring-actions are one-shot: once messages are lost (and a monitoring
628alert was raised), they are removed and will not trigger again.
629
630As a rule of thumb, monitoring requests should always monitor a port from
631a local port (or callback). The reason is that kill messages might get
632lost, just like any other message. Another less obvious reason is that
633even monitoring requests can get lost (for example, when the connection
634to the other node goes down permanently). When monitoring a port locally
635these problems do not exist.
636
637C<mon> effectively guarantees that, in the absence of hardware failures,
638after starting the monitor, either all messages sent to the port will
639arrive, or the monitoring action will be invoked after possible message
640loss has been detected. No messages will be lost "in between" (after
641the first lost message no further messages will be received by the
642port). After the monitoring action was invoked, further messages might get
643delivered again.
644
645Inter-host-connection timeouts and monitoring depend on the transport
646used. The only transport currently implemented is TCP, and AnyEvent::MP
647relies on TCP to detect node-downs (this can take 10-15 minutes on a
648non-idle connection, and usually around two hours for idle connections).
649
650This means that monitoring is good for program errors and cleaning up
651stuff eventually, but they are no replacement for a timeout when you need
652to ensure some maximum latency.
653
654Example: call a given callback when C<$port> is killed.
655
656 mon $port, sub { warn "port died because of <@_>\n" };
657
658Example: kill ourselves when C<$port> is killed abnormally.
659
660 mon $port;
661
662Example: send us a restart message when another C<$port> is killed.
663
664 mon $port, $self => "restart";
665
666=cut
667
668sub mon {
669 my ($nodeid, $port) = split /#/, shift, 2;
670
671 my $node = $NODE{$nodeid} || add_node $nodeid;
672
673 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
674
675 unless (ref $cb) {
676 if (@_) {
677 # send a kill info message
678 my (@msg) = ($cb, @_);
679 $cb = sub { snd @msg, @_ };
680 } else {
681 # simply kill other port
682 my $port = $cb;
683 $cb = sub { kil $port, @_ if @_ };
684 }
685 }
686
687 $node->monitor ($port, $cb);
688
689 defined wantarray
690 and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
284} 691}
285 692
693=item $guard = mon_guard $port, $ref, $ref...
694
695Monitors the given C<$port> and keeps the passed references. When the port
696is killed, the references will be freed.
697
698Optionally returns a guard that will stop the monitoring.
699
700This function is useful when you create e.g. timers or other watchers and
701want to free them when the port gets killed (note the use of C<psub>):
702
703 $port->rcv (start => sub {
704 my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
705 undef $timer if 0.9 < rand;
706 });
707 });
708
709=cut
710
711sub mon_guard {
712 my ($port, @refs) = @_;
713
714 #TODO: mon-less form?
715
716 mon $port, sub { 0 && @refs }
717}
718
719=item kil $port[, @reason]
720
721Kill the specified port with the given C<@reason>.
722
723If no C<@reason> is specified, then the port is killed "normally" -
724monitor callback will be invoked, but the kil will not cause linked ports
725(C<mon $mport, $lport> form) to get killed.
726
727If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
728form) get killed with the same reason.
729
730Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
731will be reported as reason C<< die => $@ >>.
732
733Transport/communication errors are reported as C<< transport_error =>
734$message >>.
735
736=cut
737
738=item $port = spawn $node, $initfunc[, @initdata]
739
740Creates a port on the node C<$node> (which can also be a port ID, in which
741case it's the node where that port resides).
742
743The port ID of the newly created port is returned immediately, and it is
744possible to immediately start sending messages or to monitor the port.
745
746After the port has been created, the init function is called on the remote
747node, in the same context as a C<rcv> callback. This function must be a
748fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
749specify a function in the main program, use C<::name>.
750
751If the function doesn't exist, then the node tries to C<require>
752the package, then the package above the package and so on (e.g.
753C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
754exists or it runs out of package names.
755
756The init function is then called with the newly-created port as context
757object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
758call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
759the port might not get created.
760
761A common idiom is to pass a local port, immediately monitor the spawned
762port, and in the remote init function, immediately monitor the passed
763local port. This two-way monitoring ensures that both ports get cleaned up
764when there is a problem.
765
766C<spawn> guarantees that the C<$initfunc> has no visible effects on the
767caller before C<spawn> returns (by delaying invocation when spawn is
768called for the local node).
769
770Example: spawn a chat server port on C<$othernode>.
771
772 # this node, executed from within a port context:
773 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
774 mon $server;
775
776 # init function on C<$othernode>
777 sub connect {
778 my ($srcport) = @_;
779
780 mon $srcport;
781
782 rcv $SELF, sub {
783 ...
784 };
785 }
786
787=cut
788
789sub _spawn {
790 my $port = shift;
791 my $init = shift;
792
793 # rcv will create the actual port
794 local $SELF = "$NODE#$port";
795 eval {
796 &{ load_func $init }
797 };
798 _self_die if $@;
799}
800
801sub spawn(@) {
802 my ($nodeid, undef) = split /#/, shift, 2;
803
804 my $id = $RUNIQ . ++$ID;
805
806 $_[0] =~ /::/
807 or Carp::croak "spawn init function must be a fully-qualified name, caught";
808
809 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
810
811 "$nodeid#$id"
812}
813
814
815=item after $timeout, @msg
816
817=item after $timeout, $callback
818
819Either sends the given message, or call the given callback, after the
820specified number of seconds.
821
822This is simply a utility function that comes in handy at times - the
823AnyEvent::MP author is not convinced of the wisdom of having it, though,
824so it may go away in the future.
825
826=cut
827
828sub after($@) {
829 my ($timeout, @action) = @_;
830
831 my $t; $t = AE::timer $timeout, 0, sub {
832 undef $t;
833 ref $action[0]
834 ? $action[0]()
835 : snd @action;
836 };
837}
838
839=item cal $port, @msg, $callback[, $timeout]
840
841A simple form of RPC - sends a message to the given C<$port> with the
842given contents (C<@msg>), but adds a reply port to the message.
843
844The reply port is created temporarily just for the purpose of receiving
845the reply, and will be C<kil>ed when no longer needed.
846
847A reply message sent to the port is passed to the C<$callback> as-is.
848
849If an optional time-out (in seconds) is given and it is not C<undef>,
850then the callback will be called without any arguments after the time-out
851elapsed and the port is C<kil>ed.
852
853If no time-out is given (or it is C<undef>), then the local port will
854monitor the remote port instead, so it eventually gets cleaned-up.
855
856Currently this function returns the temporary port, but this "feature"
857might go in future versions unless you can make a convincing case that
858this is indeed useful for something.
859
860=cut
861
862sub cal(@) {
863 my $timeout = ref $_[-1] ? undef : pop;
864 my $cb = pop;
865
866 my $port = port {
867 undef $timeout;
868 kil $SELF;
869 &$cb;
870 };
871
872 if (defined $timeout) {
873 $timeout = AE::timer $timeout, 0, sub {
874 undef $timeout;
875 kil $port;
876 $cb->();
877 };
878 } else {
879 mon $_[0], sub {
880 kil $port;
881 $cb->();
882 };
883 }
884
885 push @_, $port;
886 &snd;
887
888 $port
889}
890
286=back 891=back
287 892
288=head1 FUNCTIONS FOR NODES 893=head1 DISTRIBUTED DATABASE
894
895AnyEvent::MP comes with a simple distributed database. The database will
896be mirrored asynchronously at all global nodes. Other nodes bind to one of
897the global nodes for their needs.
898
899The database consists of a two-level hash - a hash contains a hash which
900contains values.
901
902The top level hash key is called "family", and the second-level hash key
903is called "subkey" or simply "key".
904
905The family must be alphanumeric, i.e. start with a letter and consist
906of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
907pretty much like Perl module names.
908
909As the family namespace is global, it is recommended to prefix family names
910with the name of the application or module using it.
911
912The subkeys must be non-empty strings, with no further restrictions.
913
914The values should preferably be strings, but other perl scalars should
915work as well (such as undef, arrays and hashes).
916
917Every database entry is owned by one node - adding the same family/subkey
918combination on multiple nodes will not cause discomfort for AnyEvent::MP,
919but the result might be nondeterministic, i.e. the key might have
920different values on different nodes.
921
922Different subkeys in the same family can be owned by different nodes
923without problems, and in fact, this is the common method to create worker
924pools. For example, a worker port for image scaling might do this:
925
926 db_set my_image_scalers => $port;
927
928And clients looking for an image scaler will want to get the
929C<my_image_scalers> keys:
930
931 db_keys "my_image_scalers" => 60 => sub {
932 #d##TODO#
933
934=over
935
936=item db_set $family => $subkey [=> $value]
937
938Sets (or replaces) a key to the database - if C<$value> is omitted,
939C<undef> is used instead.
940
941=item db_del $family => $subkey
942
943Deletes a key from the database.
944
945=item $guard = db_reg $family => $subkey [=> $value]
946
947Sets the key on the database and returns a guard. When the guard is
948destroyed, the key is deleted from the database. If C<$value> is missing,
949then C<undef> is used.
950
951=cut
952
953=back
954
955=head1 AnyEvent::MP vs. Distributed Erlang
956
957AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
958== aemp node, Erlang process == aemp port), so many of the documents and
959programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
960sample:
961
962 http://www.erlang.se/doc/programming_rules.shtml
963 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
964 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
965 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
966
967Despite the similarities, there are also some important differences:
289 968
290=over 4 969=over 4
291 970
292=item mon $noderef, $callback->($noderef, $status, $) 971=item * Node IDs are arbitrary strings in AEMP.
293 972
294Monitors the given noderef. 973Erlang relies on special naming and DNS to work everywhere in the same
974way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
975configuration or DNS), and possibly the addresses of some seed nodes, but
976will otherwise discover other nodes (and their IDs) itself.
295 977
296=item become_public endpoint... 978=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
979uses "local ports are like remote ports".
297 980
298Tells the node to become a public node, i.e. reachable from other nodes. 981The failure modes for local ports are quite different (runtime errors
982only) then for remote ports - when a local port dies, you I<know> it dies,
983when a connection to another node dies, you know nothing about the other
984port.
299 985
300If no arguments are given, or the first argument is C<undef>, then 986Erlang pretends remote ports are as reliable as local ports, even when
301AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the 987they are not.
302local nodename resolves to.
303 988
304Otherwise the first argument must be an array-reference with transport 989AEMP encourages a "treat remote ports differently" philosophy, with local
305endpoints ("ip:port", "hostname:port") or port numbers (in which case the 990ports being the special case/exception, where transport errors cannot
306local nodename is used as hostname). The endpoints are all resolved and 991occur.
307will become the node reference.
308 992
309=cut 993=item * Erlang uses processes and a mailbox, AEMP does not queue.
994
995Erlang uses processes that selectively receive messages out of order, and
996therefore needs a queue. AEMP is event based, queuing messages would serve
997no useful purpose. For the same reason the pattern-matching abilities
998of AnyEvent::MP are more limited, as there is little need to be able to
999filter messages without dequeuing them.
1000
1001This is not a philosophical difference, but simply stems from AnyEvent::MP
1002being event-based, while Erlang is process-based.
1003
1004You cna have a look at L<Coro::MP> for a more Erlang-like process model on
1005top of AEMP and Coro threads.
1006
1007=item * Erlang sends are synchronous, AEMP sends are asynchronous.
1008
1009Sending messages in Erlang is synchronous and blocks the process until
1010a conenction has been established and the message sent (and so does not
1011need a queue that can overflow). AEMP sends return immediately, connection
1012establishment is handled in the background.
1013
1014=item * Erlang suffers from silent message loss, AEMP does not.
1015
1016Erlang implements few guarantees on messages delivery - messages can get
1017lost without any of the processes realising it (i.e. you send messages a,
1018b, and c, and the other side only receives messages a and c).
1019
1020AEMP guarantees (modulo hardware errors) correct ordering, and the
1021guarantee that after one message is lost, all following ones sent to the
1022same port are lost as well, until monitoring raises an error, so there are
1023no silent "holes" in the message sequence.
1024
1025If you want your software to be very reliable, you have to cope with
1026corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
1027simply tries to work better in common error cases, such as when a network
1028link goes down.
1029
1030=item * Erlang can send messages to the wrong port, AEMP does not.
1031
1032In Erlang it is quite likely that a node that restarts reuses an Erlang
1033process ID known to other nodes for a completely different process,
1034causing messages destined for that process to end up in an unrelated
1035process.
1036
1037AEMP does not reuse port IDs, so old messages or old port IDs floating
1038around in the network will not be sent to an unrelated port.
1039
1040=item * Erlang uses unprotected connections, AEMP uses secure
1041authentication and can use TLS.
1042
1043AEMP can use a proven protocol - TLS - to protect connections and
1044securely authenticate nodes.
1045
1046=item * The AEMP protocol is optimised for both text-based and binary
1047communications.
1048
1049The AEMP protocol, unlike the Erlang protocol, supports both programming
1050language independent text-only protocols (good for debugging), and binary,
1051language-specific serialisers (e.g. Storable). By default, unless TLS is
1052used, the protocol is actually completely text-based.
1053
1054It has also been carefully designed to be implementable in other languages
1055with a minimum of work while gracefully degrading functionality to make the
1056protocol simple.
1057
1058=item * AEMP has more flexible monitoring options than Erlang.
1059
1060In Erlang, you can chose to receive I<all> exit signals as messages or
1061I<none>, there is no in-between, so monitoring single Erlang processes is
1062difficult to implement.
1063
1064Monitoring in AEMP is more flexible than in Erlang, as one can choose
1065between automatic kill, exit message or callback on a per-port basis.
1066
1067=item * Erlang tries to hide remote/local connections, AEMP does not.
1068
1069Monitoring in Erlang is not an indicator of process death/crashes, in the
1070same way as linking is (except linking is unreliable in Erlang).
1071
1072In AEMP, you don't "look up" registered port names or send to named ports
1073that might or might not be persistent. Instead, you normally spawn a port
1074on the remote node. The init function monitors you, and you monitor the
1075remote port. Since both monitors are local to the node, they are much more
1076reliable (no need for C<spawn_link>).
1077
1078This also saves round-trips and avoids sending messages to the wrong port
1079(hard to do in Erlang).
310 1080
311=back 1081=back
312 1082
313=head1 NODE MESSAGES 1083=head1 RATIONALE
314
315Nodes understand the following messages sent to them. Many of them take
316arguments called C<@reply>, which will simply be used to compose a reply
317message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
318the remaining arguments are simply the message data.
319 1084
320=over 4 1085=over 4
321 1086
322=cut 1087=item Why strings for port and node IDs, why not objects?
323 1088
324=item wkp => $name, @reply 1089We considered "objects", but found that the actual number of methods
1090that can be called are quite low. Since port and node IDs travel over
1091the network frequently, the serialising/deserialising would add lots of
1092overhead, as well as having to keep a proxy object everywhere.
325 1093
326Replies with the port ID of the specified well-known port, or C<undef>. 1094Strings can easily be printed, easily serialised etc. and need no special
1095procedures to be "valid".
327 1096
328=item devnull => ... 1097And as a result, a port with just a default receiver consists of a single
1098code reference stored in a global hash - it can't become much cheaper.
329 1099
330Generic data sink/CPU heat conversion. 1100=item Why favour JSON, why not a real serialising format such as Storable?
331 1101
332=item relay => $port, @msg 1102In fact, any AnyEvent::MP node will happily accept Storable as framing
1103format, but currently there is no way to make a node use Storable by
1104default (although all nodes will accept it).
333 1105
334Simply forwards the message to the given port. 1106The default framing protocol is JSON because a) JSON::XS is many times
1107faster for small messages and b) most importantly, after years of
1108experience we found that object serialisation is causing more problems
1109than it solves: Just like function calls, objects simply do not travel
1110easily over the network, mostly because they will always be a copy, so you
1111always have to re-think your design.
335 1112
336=item eval => $string[ @reply] 1113Keeping your messages simple, concentrating on data structures rather than
337 1114objects, will keep your messages clean, tidy and efficient.
338Evaluates the given string. If C<@reply> is given, then a message of the
339form C<@reply, $@, @evalres> is sent.
340
341Example: crash another node.
342
343 snd $othernode, eval => "exit";
344
345=item time => @reply
346
347Replies the the current node time to C<@reply>.
348
349Example: tell the current node to send the current time to C<$myport> in a
350C<timereply> message.
351
352 snd $NODE, time => $myport, timereply => 1, 2;
353 # => snd $myport, timereply => 1, 2, <time>
354 1115
355=back 1116=back
356 1117
357=head1 SEE ALSO 1118=head1 SEE ALSO
1119
1120L<AnyEvent::MP::Intro> - a gentle introduction.
1121
1122L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
1123
1124L<AnyEvent::MP::Global> - network maintenance and port groups, to find
1125your applications.
1126
1127L<AnyEvent::MP::DataConn> - establish data connections between nodes.
1128
1129L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
1130all nodes.
358 1131
359L<AnyEvent>. 1132L<AnyEvent>.
360 1133
361=head1 AUTHOR 1134=head1 AUTHOR
362 1135

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines