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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines