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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines