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.48 by root, Thu Aug 13 02:59:42 2009 UTC vs.
Revision 1.80 by root, Fri Sep 4 22:30:29 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines