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.49 by root, Thu Aug 13 15:29:58 2009 UTC vs.
Revision 1.148 by root, Mon Jun 20 16:58:30 2016 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::MP - multi-processing/message-passing framework 3AnyEvent::MP - erlang-style multi-processing/message-passing framework
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
9 $NODE # contains this node's noderef 9 $NODE # contains this node's node ID
10 NODE # returns this node's noderef 10 NODE # returns this node's node ID
11 NODE $port # returns the noderef of the port
12 11
13 $SELF # receiving/own port id in rcv callbacks 12 $SELF # receiving/own port id in rcv callbacks
14 13
15 # initialise the node so it can send/receive messages 14 # initialise the node so it can send/receive messages
16 initialise_node; # -OR- 15 configure;
17 initialise_node "localhost:4040"; # -OR-
18 initialise_node "slave/", "localhost:4040"
19 16
20 # ports are message endpoints 17 # ports are message destinations
21 18
22 # sending messages 19 # sending messages
23 snd $port, type => data...; 20 snd $port, type => data...;
24 snd $port, @msg; 21 snd $port, @msg;
25 snd @msg_with_first_element_being_a_port; 22 snd @msg_with_first_element_being_a_port;
26 23
27 # creating/using miniports 24 # creating/using ports, the simple way
28 my $miniport = port { my @msg = @_; 0 }; 25 my $simple_port = port { my @msg = @_ };
29 26
30 # creating/using full ports 27 # creating/using ports, tagged message matching
31 my $port = port; 28 my $port = port;
32 rcv $port, smartmatch => $cb->(@msg);
33 rcv $port, ping => sub { snd $_[0], "pong"; 0 }; 29 rcv $port, ping => sub { snd $_[0], "pong" };
34 rcv $port, pong => sub { warn "pong received\n"; 0 }; 30 rcv $port, pong => sub { warn "pong received\n" };
35
36 # more, smarter, matches (_any_ is exported by this module)
37 rcv $port, [child_died => $pid] => sub { ...
38 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
39 31
40 # create a port on another node 32 # create a port on another node
41 my $port = spawn $node, $initfunc, @initdata; 33 my $port = spawn $node, $initfunc, @initdata;
42 34
35 # destroy a port again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
43 # monitoring 39 # monitoring
44 mon $port, $cb->(@msg) # callback is invoked on death 40 mon $port, $cb->(@msg) # callback is invoked on death
45 mon $port, $otherport # kill otherport on abnormal death 41 mon $port, $localport # kill localport on abnormal death
46 mon $port, $otherport, @msg # send message on death 42 mon $port, $localport, @msg # send message on death
47 43
48=head1 CURRENT STATUS 44 # temporarily execute code in port context
45 peval $port, sub { die "kill the port!" };
49 46
50 AnyEvent::MP - stable API, should work 47 # execute callbacks in $SELF port context
51 AnyEvent::MP::Intro - outdated 48 my $timer = AE::timer 1, 0, psub {
52 AnyEvent::MP::Kernel - WIP 49 die "kill the port, delayed";
53 AnyEvent::MP::Transport - mostly stable 50 };
54 51
55 stay tuned. 52 # distributed database - modification
53 db_set $family => $subkey [=> $value] # add a subkey
54 db_del $family => $subkey... # delete one or more subkeys
55 db_reg $family => $port [=> $value] # register a port
56
57 # distributed database - queries
58 db_family $family => $cb->(\%familyhash)
59 db_keys $family => $cb->(\@keys)
60 db_values $family => $cb->(\@values)
61
62 # distributed database - monitoring a family
63 db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
56 64
57=head1 DESCRIPTION 65=head1 DESCRIPTION
58 66
59This module (-family) implements a simple message passing framework. 67This module (-family) implements a simple message passing framework.
60 68
61Despite its simplicity, you can securely message other processes running 69Despite its simplicity, you can securely message other processes running
62on the same or other hosts. 70on the same or other hosts, and you can supervise entities remotely.
63 71
64For an introduction to this module family, see the L<AnyEvent::MP::Intro> 72For an introduction to this module family, see the L<AnyEvent::MP::Intro>
65manual page. 73manual page and the examples under F<eg/>.
66
67At the moment, this module family is severly broken and underdocumented,
68so do not use. This was uploaded mainly to reserve the CPAN namespace -
69stay tuned!
70 74
71=head1 CONCEPTS 75=head1 CONCEPTS
72 76
73=over 4 77=over 4
74 78
75=item port 79=item port
76 80
77A port is something you can send messages to (with the C<snd> function). 81Not to be confused with a TCP port, a "port" is something you can send
82messages to (with the C<snd> function).
78 83
79Some ports allow you to register C<rcv> handlers that can match specific 84Ports allow you to register C<rcv> handlers that can match all or just
80messages. All C<rcv> handlers will receive messages they match, messages 85some messages. Messages send to ports will not be queued, regardless of
81will not be queued. 86anything was listening for them or not.
82 87
88Ports are represented by (printable) strings called "port IDs".
89
83=item port id - C<noderef#portname> 90=item port ID - C<nodeid#portname>
84 91
85A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as 92A port ID is the concatenation of a node ID, a hash-mark (C<#>)
86separator, and a port name (a printable string of unspecified format). An 93as separator, and a port name (a printable string of unspecified
87exception is the the node port, whose ID is identical to its node 94format created by AnyEvent::MP).
88reference.
89 95
90=item node 96=item node
91 97
92A node is a single process containing at least one port - the node 98A node is a single process containing at least one port - the node port,
93port. You can send messages to node ports to find existing ports or to 99which enables nodes to manage each other remotely, and to create new
94create new ports, among other things. 100ports.
95 101
96Nodes are either private (single-process only), slaves (connected to a 102Nodes are either public (have one or more listening ports) or private
97master node only) or public nodes (connectable from unrelated nodes). 103(no listening ports). Private nodes cannot talk to other private nodes
104currently, but all nodes can talk to public nodes.
98 105
99=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> 106Nodes is represented by (printable) strings called "node IDs".
100 107
101A node reference is a string that either simply identifies the node (for 108=item node ID - C<[A-Za-z0-9_\-.:]*>
102private and slave nodes), or contains a recipe on how to reach a given
103node (for public nodes).
104 109
105This recipe is simply a comma-separated list of C<address:port> pairs (for 110A node ID is a string that uniquely identifies the node within a
106TCP/IP, other protocols might look different). 111network. Depending on the configuration used, node IDs can look like a
112hostname, a hostname and a port, or a random string. AnyEvent::MP itself
113doesn't interpret node IDs in any way except to uniquely identify a node.
107 114
108Node references come in two flavours: resolved (containing only numerical 115=item binds - C<ip:port>
109addresses) or unresolved (where hostnames are used instead of addresses).
110 116
111Before using an unresolved node reference in a message you first have to 117Nodes can only talk to each other by creating some kind of connection to
112resolve it. 118each other. To do this, nodes should listen on one or more local transport
119endpoints - binds.
120
121Currently, only standard C<ip:port> specifications can be used, which
122specify TCP ports to listen on. So a bind is basically just a tcp socket
123in listening mode that accepts connections from other nodes.
124
125=item seed nodes
126
127When a node starts, it knows nothing about the network it is in - it
128needs to connect to at least one other node that is already in the
129network. These other nodes are called "seed nodes".
130
131Seed nodes themselves are not special - they are seed nodes only because
132some other node I<uses> them as such, but any node can be used as seed
133node for other nodes, and eahc node can use a different set of seed nodes.
134
135In addition to discovering the network, seed nodes are also used to
136maintain the network - all nodes using the same seed node are part of the
137same network. If a network is split into multiple subnets because e.g. the
138network link between the parts goes down, then using the same seed nodes
139for all nodes ensures that eventually the subnets get merged again.
140
141Seed nodes are expected to be long-running, and at least one seed node
142should always be available. They should also be relatively responsive - a
143seed node that blocks for long periods will slow down everybody else.
144
145For small networks, it's best if every node uses the same set of seed
146nodes. For large networks, it can be useful to specify "regional" seed
147nodes for most nodes in an area, and use all seed nodes as seed nodes for
148each other. What's important is that all seed nodes connections form a
149complete graph, so that the network cannot split into separate subnets
150forever.
151
152Seed nodes are represented by seed IDs.
153
154=item seed IDs - C<host:port>
155
156Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
157TCP port) of nodes that should be used as seed nodes.
158
159=item global nodes
160
161An AEMP network needs a discovery service - nodes need to know how to
162connect to other nodes they only know by name. In addition, AEMP offers a
163distributed "group database", which maps group names to a list of strings
164- for example, to register worker ports.
165
166A network needs at least one global node to work, and allows every node to
167be a global node.
168
169Any node that loads the L<AnyEvent::MP::Global> module becomes a global
170node and tries to keep connections to all other nodes. So while it can
171make sense to make every node "global" in small networks, it usually makes
172sense to only make seed nodes into global nodes in large networks (nodes
173keep connections to seed nodes and global nodes, so making them the same
174reduces overhead).
113 175
114=back 176=back
115 177
116=head1 VARIABLES/FUNCTIONS 178=head1 VARIABLES/FUNCTIONS
117 179
119 181
120=cut 182=cut
121 183
122package AnyEvent::MP; 184package AnyEvent::MP;
123 185
186use AnyEvent::MP::Config ();
124use AnyEvent::MP::Kernel; 187use AnyEvent::MP::Kernel;
188use AnyEvent::MP::Kernel qw(
189 %NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID
190 add_node load_func
191
192 NODE $NODE
193 configure
194 node_of port_is_local
195 snd kil
196 db_set db_del
197 db_mon db_family db_keys db_values
198);
125 199
126use common::sense; 200use common::sense;
127 201
128use Carp (); 202use Carp ();
129 203
130use AE (); 204use AnyEvent ();
205use Guard ();
131 206
132use base "Exporter"; 207use base "Exporter";
133 208
134our $VERSION = $AnyEvent::MP::Kernel::VERSION; 209our $VERSION = $AnyEvent::MP::Config::VERSION;
135 210
136our @EXPORT = qw( 211our @EXPORT = qw(
137 NODE $NODE *SELF node_of _any_ 212 NODE $NODE
138 resolve_node initialise_node 213 configure
139 snd rcv mon kil reg psub spawn 214 node_of port_is_local
140 port 215 snd kil
216 db_set db_del
217 db_mon db_family db_keys db_values
218
219 *SELF
220
221 port rcv mon mon_guard psub peval spawn cal
222 db_set db_del db_reg
223 db_mon db_family db_keys db_values
224
225 after
141); 226);
142 227
143our $SELF; 228our $SELF;
144 229
145sub _self_die() { 230sub _self_die() {
148 kil $SELF, die => $msg; 233 kil $SELF, die => $msg;
149} 234}
150 235
151=item $thisnode = NODE / $NODE 236=item $thisnode = NODE / $NODE
152 237
153The C<NODE> function returns, and the C<$NODE> variable contains 238The C<NODE> function returns, and the C<$NODE> variable contains, the node
154the noderef of the local node. The value is initialised by a call 239ID of the node running in the current process. This value is initialised by
155to C<become_public> or C<become_slave>, after which all local port 240a call to C<configure>.
156identifiers become invalid.
157 241
158=item $noderef = node_of $port 242=item $nodeid = node_of $port
159 243
160Extracts and returns the noderef from a portid or a noderef. 244Extracts and returns the node ID from a port ID or a node ID.
161 245
162=item initialise_node $noderef, $seednode, $seednode... 246=item $is_local = port_is_local $port
163 247
164=item initialise_node "slave/", $master, $master... 248Returns true iff the port is a local port.
165 249
250=item configure $profile, key => value...
251
252=item configure key => value...
253
166Before a node can talk to other nodes on the network it has to initialise 254Before a node can talk to other nodes on the network (i.e. enter
167itself - the minimum a node needs to know is it's own name, and optionally 255"distributed mode") it has to configure itself - the minimum a node needs
168it should know the noderefs of some other nodes in the network. 256to know is its own name, and optionally it should know the addresses of
257some other nodes in the network to discover other nodes.
169 258
170This function initialises a node - it must be called exactly once (or 259This function configures a node - it must be called exactly once (or
171never) before calling other AnyEvent::MP functions. 260never) before calling other AnyEvent::MP functions.
172 261
173All arguments (optionally except for the first) are noderefs, which can be 262The key/value pairs are basically the same ones as documented for the
174either resolved or unresolved. 263F<aemp> command line utility (sans the set/del prefix), with these additions:
175
176The first argument will be looked up in the configuration database first
177(if it is C<undef> then the current nodename will be used instead) to find
178the relevant configuration profile (see L<aemp>). If none is found then
179the default configuration is used. The configuration supplies additional
180seed/master nodes and can override the actual noderef.
181
182There are two types of networked nodes, public nodes and slave nodes:
183 264
184=over 4 265=over 4
185 266
186=item public nodes 267=item norc => $boolean (default false)
187 268
188For public nodes, C<$noderef> (supplied either directly to 269If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
189C<initialise_node> or indirectly via a profile or the nodename) must be a 270be consulted - all configuration options must be specified in the
190noderef (possibly unresolved, in which case it will be resolved). 271C<configure> call.
191 272
192After resolving, the node will bind itself on all endpoints and try to 273=item force => $boolean (default false)
193connect to all additional C<$seednodes> that are specified. Seednodes are
194optional and can be used to quickly bootstrap the node into an existing
195network.
196 274
197=item slave nodes 275IF true, then the values specified in the C<configure> will take
198 276precedence over any values configured via the rc file. The default is for
199When the C<$noderef> (either as given or overriden by the config file) 277the rc file to override any options specified in the program.
200is the special string C<slave/>, then the node will become a slave
201node. Slave nodes cannot be contacted from outside and will route most of
202their traffic to the master node that they attach to.
203
204At least one additional noderef is required (either by specifying it
205directly or because it is part of the configuration profile): The node
206will try to connect to all of them and will become a slave attached to the
207first node it can successfully connect to.
208 278
209=back 279=back
210 280
211This function will block until all nodes have been resolved and, for slave
212nodes, until it has successfully established a connection to a master
213server.
214
215Example: become a public node listening on the guessed noderef, or the one
216specified via C<aemp> for the current node. This should be the most common
217form of invocation for "daemon"-type nodes.
218
219 initialise_node;
220
221Example: become a slave node to any of the the seednodes specified via
222C<aemp>. This form is often used for commandline clients.
223
224 initialise_node "slave/";
225
226Example: become a slave node to any of the specified master servers. This
227form is also often used for commandline clients.
228
229 initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
230
231Example: become a public node, and try to contact some well-known master
232servers to become part of the network.
233
234 initialise_node undef, "master1", "master2";
235
236Example: become a public node listening on port C<4041>.
237
238 initialise_node 4041;
239
240Example: become a public node, only visible on localhost port 4044.
241
242 initialise_node "localhost:4044";
243
244=item $cv = resolve_node $noderef
245
246Takes an unresolved node reference that may contain hostnames and
247abbreviated IDs, resolves all of them and returns a resolved node
248reference.
249
250In addition to C<address:port> pairs allowed in resolved noderefs, the
251following forms are supported:
252
253=over 4 281=over 4
254 282
255=item the empty string 283=item step 1, gathering configuration from profiles
256 284
257An empty-string component gets resolved as if the default port (4040) was 285The function first looks up a profile in the aemp configuration (see the
258specified. 286L<aemp> commandline utility). The profile name can be specified via the
287named C<profile> parameter or can simply be the first parameter). If it is
288missing, then the nodename (F<uname -n>) will be used as profile name.
259 289
260=item naked port numbers (e.g. C<1234>) 290The profile data is then gathered as follows:
261 291
262These are resolved by prepending the local nodename and a colon, to be 292First, all remaining key => value pairs (all of which are conveniently
263further resolved. 293undocumented at the moment) will be interpreted as configuration
294data. Then they will be overwritten by any values specified in the global
295default configuration (see the F<aemp> utility), then the chain of
296profiles chosen by the profile name (and any C<parent> attributes).
264 297
265=item hostnames (e.g. C<localhost:1234>, C<localhost>) 298That means that the values specified in the profile have highest priority
299and the values specified directly via C<configure> have lowest priority,
300and can only be used to specify defaults.
266 301
267These are resolved by using AnyEvent::DNS to resolve them, optionally 302If the profile specifies a node ID, then this will become the node ID of
268looking up SRV records for the C<aemp=4040> port, if no port was 303this process. If not, then the profile name will be used as node ID, with
269specified. 304a unique randoms tring (C</%u>) appended.
305
306The node ID can contain some C<%> sequences that are expanded: C<%n>
307is expanded to the local nodename, C<%u> is replaced by a random
308strign to make the node unique. For example, the F<aemp> commandline
309utility uses C<aemp/%n/%u> as nodename, which might expand to
310C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
311
312=item step 2, bind listener sockets
313
314The next step is to look up the binds in the profile, followed by binding
315aemp protocol listeners on all binds specified (it is possible and valid
316to have no binds, meaning that the node cannot be contacted from the
317outside. This means the node cannot talk to other nodes that also have no
318binds, but it can still talk to all "normal" nodes).
319
320If the profile does not specify a binds list, then a default of C<*> is
321used, meaning the node will bind on a dynamically-assigned port on every
322local IP address it finds.
323
324=item step 3, connect to seed nodes
325
326As the last step, the seed ID list from the profile is passed to the
327L<AnyEvent::MP::Global> module, which will then use it to keep
328connectivity with at least one node at any point in time.
270 329
271=back 330=back
331
332Example: become a distributed node using the local node name as profile.
333This should be the most common form of invocation for "daemon"-type nodes.
334
335 configure
336
337Example: become a semi-anonymous node. This form is often used for
338commandline clients.
339
340 configure nodeid => "myscript/%n/%u";
341
342Example: configure a node using a profile called seed, which is suitable
343for a seed node as it binds on all local addresses on a fixed port (4040,
344customary for aemp).
345
346 # use the aemp commandline utility
347 # aemp profile seed binds '*:4040'
348
349 # then use it
350 configure profile => "seed";
351
352 # or simply use aemp from the shell again:
353 # aemp run profile seed
354
355 # or provide a nicer-to-remember nodeid
356 # aemp run profile seed nodeid "$(hostname)"
272 357
273=item $SELF 358=item $SELF
274 359
275Contains the current port id while executing C<rcv> callbacks or C<psub> 360Contains the current port id while executing C<rcv> callbacks or C<psub>
276blocks. 361blocks.
277 362
278=item SELF, %SELF, @SELF... 363=item *SELF, SELF, %SELF, @SELF...
279 364
280Due to some quirks in how perl exports variables, it is impossible to 365Due to some quirks in how perl exports variables, it is impossible to
281just export C<$SELF>, all the symbols called C<SELF> are exported by this 366just export C<$SELF>, all the symbols named C<SELF> are exported by this
282module, but only C<$SELF> is currently used. 367module, but only C<$SELF> is currently used.
283 368
284=item snd $port, type => @data 369=item snd $port, type => @data
285 370
286=item snd $port, @msg 371=item snd $port, @msg
287 372
288Send the given message to the given port ID, which can identify either 373Send the given message to the given port, which can identify either a
289a local or a remote port, and can be either a string or soemthignt hat 374local or a remote port, and must be a port ID.
290stringifies a sa port ID (such as a port object :).
291 375
292While the message can be about anything, it is highly recommended to use a 376While the message can be almost anything, it is highly recommended to
293string as first element (a portid, or some word that indicates a request 377use a string as first element (a port ID, or some word that indicates a
294type etc.). 378request type etc.) and to consist if only simple perl values (scalars,
379arrays, hashes) - if you think you need to pass an object, think again.
295 380
296The message data effectively becomes read-only after a call to this 381The message data logically becomes read-only after a call to this
297function: modifying any argument is not allowed and can cause many 382function: modifying any argument (or values referenced by them) is
298problems. 383forbidden, as there can be considerable time between the call to C<snd>
384and the time the message is actually being serialised - in fact, it might
385never be copied as within the same process it is simply handed to the
386receiving port.
299 387
300The type of data you can transfer depends on the transport protocol: when 388The type of data you can transfer depends on the transport protocol: when
301JSON is used, then only strings, numbers and arrays and hashes consisting 389JSON is used, then only strings, numbers and arrays and hashes consisting
302of those are allowed (no objects). When Storable is used, then anything 390of those are allowed (no objects). When Storable is used, then anything
303that Storable can serialise and deserialise is allowed, and for the local 391that Storable can serialise and deserialise is allowed, and for the local
304node, anything can be passed. 392node, anything can be passed. Best rely only on the common denominator of
393these.
305 394
306=item $local_port = port 395=item $local_port = port
307 396
308Create a new local port object that can be used either as a pattern 397Create a new local port object and returns its port ID. Initially it has
309matching port ("full port") or a single-callback port ("miniport"), 398no callbacks set and will throw an error when it receives messages.
310depending on how C<rcv> callbacks are bound to the object.
311 399
312=item $port = port { my @msg = @_; $finished } 400=item $local_port = port { my @msg = @_ }
313 401
314Creates a "miniport", that is, a very lightweight port without any pattern 402Creates a new local port, and returns its ID. Semantically the same as
315matching behind it, and returns its ID. Semantically the same as creating
316a port and calling C<rcv $port, $callback> on it. 403creating a port and calling C<rcv $port, $callback> on it.
317 404
318The block will be called for every message received on the port. When the 405The block will be called for every message received on the port, with the
319callback returns a true value its job is considered "done" and the port 406global variable C<$SELF> set to the port ID. Runtime errors will cause the
320will be destroyed. Otherwise it will stay alive. 407port to be C<kil>ed. The message will be passed as-is, no extra argument
408(i.e. no port ID) will be passed to the callback.
321 409
322The message will be passed as-is, no extra argument (i.e. no port id) will 410If you want to stop/destroy the port, simply C<kil> it:
323be passed to the callback.
324 411
325If you need the local port id in the callback, this works nicely: 412 my $port = port {
326 413 my @msg = @_;
327 my $port; $port = port { 414 ...
328 snd $otherport, reply => $port; 415 kil $SELF;
329 }; 416 };
330 417
331=cut 418=cut
332 419
333sub rcv($@); 420sub rcv($@);
334 421
422my $KILME = sub {
423 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g;
424 kil $SELF, unhandled_message => "no callback found for message '$tag'";
425};
426
335sub port(;&) { 427sub port(;&) {
336 my $id = "$UNIQ." . $ID++; 428 my $id = $UNIQ . ++$ID;
337 my $port = "$NODE#$id"; 429 my $port = "$NODE#$id";
338 430
339 if (@_) {
340 rcv $port, shift; 431 rcv $port, shift || $KILME;
341 } else {
342 $PORT{$id} = sub { }; # nop
343 }
344 432
345 $port 433 $port
346} 434}
347 435
348=item reg $port, $name
349
350=item reg $name
351
352Registers the given port (or C<$SELF><<< if missing) under the name
353C<$name>. If the name already exists it is replaced.
354
355A port can only be registered under one well known name.
356
357A port automatically becomes unregistered when it is killed.
358
359=cut
360
361sub reg(@) {
362 my $port = @_ > 1 ? shift : $SELF || Carp::croak 'reg: called with one argument only, but $SELF not set,';
363
364 $REG{$_[0]} = $port;
365}
366
367=item rcv $port, $callback->(@msg) 436=item rcv $local_port, $callback->(@msg)
368 437
369Replaces the callback on the specified miniport (after converting it to 438Replaces the default callback on the specified port. There is no way to
370one if required). 439remove the default callback: use C<sub { }> to disable it, or better
371 440C<kil> the port when it is no longer needed.
372=item rcv $port, tagstring => $callback->(@msg), ...
373
374=item rcv $port, $smartmatch => $callback->(@msg), ...
375
376=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
377
378Register callbacks to be called on matching messages on the given full
379port (after converting it to one if required) and return the port.
380
381The callback has to return a true value when its work is done, after
382which is will be removed, or a false value in which case it will stay
383registered.
384 441
385The global C<$SELF> (exported by this module) contains C<$port> while 442The global C<$SELF> (exported by this module) contains C<$port> while
386executing the callback. 443executing the callback. Runtime errors during callback execution will
444result in the port being C<kil>ed.
387 445
388Runtime errors during callback execution will result in the port being 446The default callback receives all messages not matched by a more specific
389C<kil>ed. 447C<tag> match.
390 448
391If the match is an array reference, then it will be matched against the 449=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
392first elements of the message, otherwise only the first element is being
393matched.
394 450
395Any element in the match that is specified as C<_any_> (a function 451Register (or replace) callbacks to be called on messages starting with the
396exported by this module) matches any single element of the message. 452given tag on the given port (and return the port), or unregister it (when
453C<$callback> is C<$undef> or missing). There can only be one callback
454registered for each tag.
397 455
398While not required, it is highly recommended that the first matching 456The original message will be passed to the callback, after the first
399element is a string identifying the message. The one-string-only match is 457element (the tag) has been removed. The callback will use the same
400also the most efficient match (by far). 458environment as the default callback (see above).
401 459
402Example: create a port and bind receivers on it in one go. 460Example: create a port and bind receivers on it in one go.
403 461
404 my $port = rcv port, 462 my $port = rcv port,
405 msg1 => sub { ...; 0 }, 463 msg1 => sub { ... },
406 msg2 => sub { ...; 0 }, 464 msg2 => sub { ... },
407 ; 465 ;
408 466
409Example: create a port, bind receivers and send it in a message elsewhere 467Example: create a port, bind receivers and send it in a message elsewhere
410in one go: 468in one go:
411 469
412 snd $otherport, reply => 470 snd $otherport, reply =>
413 rcv port, 471 rcv port,
414 msg1 => sub { ...; 0 }, 472 msg1 => sub { ... },
415 ... 473 ...
416 ; 474 ;
417 475
476Example: temporarily register a rcv callback for a tag matching some port
477(e.g. for an rpc reply) and unregister it after a message was received.
478
479 rcv $port, $otherport => sub {
480 my @reply = @_;
481
482 rcv $SELF, $otherport;
483 };
484
418=cut 485=cut
419 486
420sub rcv($@) { 487sub rcv($@) {
421 my $port = shift; 488 my $port = shift;
422 my ($noderef, $portid) = split /#/, $port, 2; 489 my ($nodeid, $portid) = split /#/, $port, 2;
423 490
424 ($NODE{$noderef} || add_node $noderef) == $NODE{""} 491 $nodeid eq $NODE
425 or Carp::croak "$port: rcv can only be called on local ports, caught"; 492 or Carp::croak "$port: rcv can only be called on local ports, caught";
426 493
427 if (@_ == 1) { 494 while (@_) {
495 if (ref $_[0]) {
496 if (my $self = $PORT_DATA{$portid}) {
497 "AnyEvent::MP::Port" eq ref $self
498 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
499
500 $self->[0] = shift;
501 } else {
428 my $cb = shift; 502 my $cb = shift;
429 delete $PORT_DATA{$portid};
430 $PORT{$portid} = sub { 503 $PORT{$portid} = sub {
431 local $SELF = $port; 504 local $SELF = $port;
432 eval { 505 eval { &$cb }; _self_die if $@;
433 &$cb 506 };
434 and kil $port;
435 }; 507 }
436 _self_die if $@; 508 } elsif (defined $_[0]) {
437 };
438 } else {
439 my $self = $PORT_DATA{$portid} ||= do { 509 my $self = $PORT_DATA{$portid} ||= do {
440 my $self = bless { 510 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
441 id => $port,
442 }, "AnyEvent::MP::Port";
443 511
444 $PORT{$portid} = sub { 512 $PORT{$portid} = sub {
445 local $SELF = $port; 513 local $SELF = $port;
446 514
447 eval {
448 for (@{ $self->{rc0}{$_[0]} }) { 515 if (my $cb = $self->[1]{$_[0]}) {
449 $_ && &{$_->[0]} 516 shift;
450 && undef $_; 517 eval { &$cb }; _self_die if $@;
451 } 518 } else {
452
453 for (@{ $self->{rcv}{$_[0]} }) {
454 $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
455 && &{$_->[0]} 519 &{ $self->[0] };
456 && undef $_;
457 }
458
459 for (@{ $self->{any} }) {
460 $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
461 && &{$_->[0]}
462 && undef $_;
463 } 520 }
464 }; 521 };
465 _self_die if $@; 522
523 $self
466 }; 524 };
467 525
468 $self
469 };
470
471 "AnyEvent::MP::Port" eq ref $self 526 "AnyEvent::MP::Port" eq ref $self
472 or Carp::croak "$port: rcv can only be called on message matching ports, caught"; 527 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
473 528
474 while (@_) {
475 my ($match, $cb) = splice @_, 0, 2; 529 my ($tag, $cb) = splice @_, 0, 2;
476 530
477 if (!ref $match) { 531 if (defined $cb) {
478 push @{ $self->{rc0}{$match} }, [$cb]; 532 $self->[1]{$tag} = $cb;
479 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
480 my ($type, @match) = @$match;
481 @match
482 ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
483 : push @{ $self->{rc0}{$match->[0]} }, [$cb];
484 } else { 533 } else {
485 push @{ $self->{any} }, [$cb, $match]; 534 delete $self->[1]{$tag};
486 } 535 }
487 } 536 }
488 } 537 }
489 538
490 $port 539 $port
491} 540}
492 541
542=item peval $port, $coderef[, @args]
543
544Evaluates the given C<$codref> within the contetx of C<$port>, that is,
545when the code throws an exception the C<$port> will be killed.
546
547Any remaining args will be passed to the callback. Any return values will
548be returned to the caller.
549
550This is useful when you temporarily want to execute code in the context of
551a port.
552
553Example: create a port and run some initialisation code in it's context.
554
555 my $port = port { ... };
556
557 peval $port, sub {
558 init
559 or die "unable to init";
560 };
561
562=cut
563
564sub peval($$) {
565 local $SELF = shift;
566 my $cb = shift;
567
568 if (wantarray) {
569 my @res = eval { &$cb };
570 _self_die if $@;
571 @res
572 } else {
573 my $res = eval { &$cb };
574 _self_die if $@;
575 $res
576 }
577}
578
493=item $closure = psub { BLOCK } 579=item $closure = psub { BLOCK }
494 580
495Remembers C<$SELF> and creates a closure out of the BLOCK. When the 581Remembers C<$SELF> and creates a closure out of the BLOCK. When the
496closure is executed, sets up the environment in the same way as in C<rcv> 582closure is executed, sets up the environment in the same way as in C<rcv>
497callbacks, i.e. runtime errors will cause the port to get C<kil>ed. 583callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
584
585The effect is basically as if it returned C<< sub { peval $SELF, sub {
586BLOCK }, @_ } >>.
498 587
499This is useful when you register callbacks from C<rcv> callbacks: 588This is useful when you register callbacks from C<rcv> callbacks:
500 589
501 rcv delayed_reply => sub { 590 rcv delayed_reply => sub {
502 my ($delay, @reply) = @_; 591 my ($delay, @reply) = @_;
526 $res 615 $res
527 } 616 }
528 } 617 }
529} 618}
530 619
531=item $guard = mon $port, $cb->(@reason) 620=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
532 621
533=item $guard = mon $port, $rcvport 622=item $guard = mon $port # kill $SELF when $port dies
534 623
535=item $guard = mon $port 624=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
536 625
537=item $guard = mon $port, $rcvport, @msg 626=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
538 627
539Monitor the given port and do something when the port is killed or 628Monitor the given port and do something when the port is killed or
540messages to it were lost, and optionally return a guard that can be used 629messages to it were lost, and optionally return a guard that can be used
541to stop monitoring again. 630to stop monitoring again.
542 631
632The first two forms distinguish between "normal" and "abnormal" kil's:
633
634In the first form (another port given), if the C<$port> is C<kil>'ed with
635a non-empty reason, the other port (C<$rcvport>) will be kil'ed with the
636same reason. That is, on "normal" kil's nothing happens, while under all
637other conditions, the other port is killed with the same reason.
638
639The second form (kill self) is the same as the first form, except that
640C<$rvport> defaults to C<$SELF>.
641
642The remaining forms don't distinguish between "normal" and "abnormal" kil's
643- it's up to the callback or receiver to check whether the C<@reason> is
644empty and act accordingly.
645
646In the third form (callback), the callback is simply called with any
647number of C<@reason> elements (empty @reason means that the port was deleted
648"normally"). Note also that I<< the callback B<must> never die >>, so use
649C<eval> if unsure.
650
651In the last form (message), a message of the form C<$rcvport, @msg,
652@reason> will be C<snd>.
653
654Monitoring-actions are one-shot: once messages are lost (and a monitoring
655alert was raised), they are removed and will not trigger again, even if it
656turns out that the port is still alive.
657
658As a rule of thumb, monitoring requests should always monitor a remote
659port locally (using a local C<$rcvport> or a callback). The reason is that
660kill messages might get lost, just like any other message. Another less
661obvious reason is that even monitoring requests can get lost (for example,
662when the connection to the other node goes down permanently). When
663monitoring a port locally these problems do not exist.
664
543C<mon> effectively guarantees that, in the absence of hardware failures, 665C<mon> effectively guarantees that, in the absence of hardware failures,
544that after starting the monitor, either all messages sent to the port 666after starting the monitor, either all messages sent to the port will
545will arrive, or the monitoring action will be invoked after possible 667arrive, or the monitoring action will be invoked after possible message
546message loss has been detected. No messages will be lost "in between" 668loss has been detected. No messages will be lost "in between" (after
547(after the first lost message no further messages will be received by the 669the first lost message no further messages will be received by the
548port). After the monitoring action was invoked, further messages might get 670port). After the monitoring action was invoked, further messages might get
549delivered again. 671delivered again.
550 672
551In the first form (callback), the callback is simply called with any 673Inter-host-connection timeouts and monitoring depend on the transport
552number of C<@reason> elements (no @reason means that the port was deleted 674used. The only transport currently implemented is TCP, and AnyEvent::MP
553"normally"). Note also that I<< the callback B<must> never die >>, so use 675relies on TCP to detect node-downs (this can take 10-15 minutes on a
554C<eval> if unsure. 676non-idle connection, and usually around two hours for idle connections).
555 677
556In the second form (another port given), the other port (C<$rcvport>) 678This means that monitoring is good for program errors and cleaning up
557will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on 679stuff eventually, but they are no replacement for a timeout when you need
558"normal" kils nothing happens, while under all other conditions, the other 680to ensure some maximum latency.
559port is killed with the same reason.
560
561The third form (kill self) is the same as the second form, except that
562C<$rvport> defaults to C<$SELF>.
563
564In the last form (message), a message of the form C<@msg, @reason> will be
565C<snd>.
566
567As a rule of thumb, monitoring requests should always monitor a port from
568a local port (or callback). The reason is that kill messages might get
569lost, just like any other message. Another less obvious reason is that
570even monitoring requests can get lost (for exmaple, when the connection
571to the other node goes down permanently). When monitoring a port locally
572these problems do not exist.
573 681
574Example: call a given callback when C<$port> is killed. 682Example: call a given callback when C<$port> is killed.
575 683
576 mon $port, sub { warn "port died because of <@_>\n" }; 684 mon $port, sub { warn "port died because of <@_>\n" };
577 685
584 mon $port, $self => "restart"; 692 mon $port, $self => "restart";
585 693
586=cut 694=cut
587 695
588sub mon { 696sub mon {
589 my ($noderef, $port) = split /#/, shift, 2; 697 my ($nodeid, $port) = split /#/, shift, 2;
590 698
591 my $node = $NODE{$noderef} || add_node $noderef; 699 my $node = $NODE{$nodeid} || add_node $nodeid;
592 700
593 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,'; 701 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
594 702
595 unless (ref $cb) { 703 unless (ref $cb) {
596 if (@_) { 704 if (@_) {
605 } 713 }
606 714
607 $node->monitor ($port, $cb); 715 $node->monitor ($port, $cb);
608 716
609 defined wantarray 717 defined wantarray
610 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 718 and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
611} 719}
612 720
613=item $guard = mon_guard $port, $ref, $ref... 721=item $guard = mon_guard $port, $ref, $ref...
614 722
615Monitors the given C<$port> and keeps the passed references. When the port 723Monitors the given C<$port> and keeps the passed references. When the port
616is killed, the references will be freed. 724is killed, the references will be freed.
617 725
618Optionally returns a guard that will stop the monitoring. 726Optionally returns a guard that will stop the monitoring.
619 727
620This function is useful when you create e.g. timers or other watchers and 728This function is useful when you create e.g. timers or other watchers and
621want to free them when the port gets killed: 729want to free them when the port gets killed (note the use of C<psub>):
622 730
623 $port->rcv (start => sub { 731 $port->rcv (start => sub {
624 my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub { 732 my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
625 undef $timer if 0.9 < rand; 733 undef $timer if 0.9 < rand;
626 }); 734 });
627 }); 735 });
628 736
629=cut 737=cut
638 746
639=item kil $port[, @reason] 747=item kil $port[, @reason]
640 748
641Kill the specified port with the given C<@reason>. 749Kill the specified port with the given C<@reason>.
642 750
643If no C<@reason> is specified, then the port is killed "normally" (linked 751If no C<@reason> is specified, then the port is killed "normally" -
644ports will not be kileld, or even notified). 752monitor callback will be invoked, but the kil will not cause linked ports
753(C<mon $mport, $lport> form) to get killed.
645 754
646Otherwise, linked ports get killed with the same reason (second form of 755If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
647C<mon>, see below). 756form) get killed with the same reason.
648 757
649Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks 758Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
650will be reported as reason C<< die => $@ >>. 759will be reported as reason C<< die => $@ >>.
651 760
652Transport/communication errors are reported as C<< transport_error => 761Transport/communication errors are reported as C<< transport_error =>
653$message >>. 762$message >>.
654 763
655=cut 764Common idioms:
765
766 # silently remove yourself, do not kill linked ports
767 kil $SELF;
768
769 # report a failure in some detail
770 kil $SELF, failure_mode_1 => "it failed with too high temperature";
771
772 # do not waste much time with killing, just die when something goes wrong
773 open my $fh, "<file"
774 or die "file: $!";
656 775
657=item $port = spawn $node, $initfunc[, @initdata] 776=item $port = spawn $node, $initfunc[, @initdata]
658 777
659Creates a port on the node C<$node> (which can also be a port ID, in which 778Creates a port on the node C<$node> (which can also be a port ID, in which
660case it's the node where that port resides). 779case it's the node where that port resides).
661 780
662The port ID of the newly created port is return immediately, and it is 781The port ID of the newly created port is returned immediately, and it is
663permissible to immediately start sending messages or monitor the port. 782possible to immediately start sending messages or to monitor the port.
664 783
665After the port has been created, the init function is 784After the port has been created, the init function is called on the remote
666called. This function must be a fully-qualified function name 785node, in the same context as a C<rcv> callback. This function must be a
667(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main 786fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
668program, use C<::name>. 787specify a function in the main program, use C<::name>.
669 788
670If the function doesn't exist, then the node tries to C<require> 789If the function doesn't exist, then the node tries to C<require>
671the package, then the package above the package and so on (e.g. 790the package, then the package above the package and so on (e.g.
672C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function 791C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
673exists or it runs out of package names. 792exists or it runs out of package names.
674 793
675The init function is then called with the newly-created port as context 794The init function is then called with the newly-created port as context
676object (C<$SELF>) and the C<@initdata> values as arguments. 795object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
796call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
797the port might not get created.
677 798
678A common idiom is to pass your own port, monitor the spawned port, and 799A common idiom is to pass a local port, immediately monitor the spawned
679in the init function, monitor the original port. This two-way monitoring 800port, and in the remote init function, immediately monitor the passed
680ensures that both ports get cleaned up when there is a problem. 801local port. This two-way monitoring ensures that both ports get cleaned up
802when there is a problem.
803
804C<spawn> guarantees that the C<$initfunc> has no visible effects on the
805caller before C<spawn> returns (by delaying invocation when spawn is
806called for the local node).
681 807
682Example: spawn a chat server port on C<$othernode>. 808Example: spawn a chat server port on C<$othernode>.
683 809
684 # this node, executed from within a port context: 810 # this node, executed from within a port context:
685 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; 811 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
700 826
701sub _spawn { 827sub _spawn {
702 my $port = shift; 828 my $port = shift;
703 my $init = shift; 829 my $init = shift;
704 830
831 # rcv will create the actual port
705 local $SELF = "$NODE#$port"; 832 local $SELF = "$NODE#$port";
706 eval { 833 eval {
707 &{ load_func $init } 834 &{ load_func $init }
708 }; 835 };
709 _self_die if $@; 836 _self_die if $@;
710} 837}
711 838
712sub spawn(@) { 839sub spawn(@) {
713 my ($noderef, undef) = split /#/, shift, 2; 840 my ($nodeid, undef) = split /#/, shift, 2;
714 841
715 my $id = "$RUNIQ." . $ID++; 842 my $id = $RUNIQ . ++$ID;
716 843
717 $_[0] =~ /::/ 844 $_[0] =~ /::/
718 or Carp::croak "spawn init function must be a fully-qualified name, caught"; 845 or Carp::croak "spawn init function must be a fully-qualified name, caught";
719 846
720 ($NODE{$noderef} || add_node $noderef) 847 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
721 ->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
722 848
723 "$noderef#$id" 849 "$nodeid#$id"
724} 850}
725 851
852
853=item after $timeout, @msg
854
855=item after $timeout, $callback
856
857Either sends the given message, or call the given callback, after the
858specified number of seconds.
859
860This is simply a utility function that comes in handy at times - the
861AnyEvent::MP author is not convinced of the wisdom of having it, though,
862so it may go away in the future.
863
864=cut
865
866sub after($@) {
867 my ($timeout, @action) = @_;
868
869 my $t; $t = AE::timer $timeout, 0, sub {
870 undef $t;
871 ref $action[0]
872 ? $action[0]()
873 : snd @action;
874 };
875}
876
877#=item $cb2 = timeout $seconds, $cb[, @args]
878
879=item cal $port, @msg, $callback[, $timeout]
880
881A simple form of RPC - sends a message to the given C<$port> with the
882given contents (C<@msg>), but adds a reply port to the message.
883
884The reply port is created temporarily just for the purpose of receiving
885the reply, and will be C<kil>ed when no longer needed.
886
887A reply message sent to the port is passed to the C<$callback> as-is.
888
889If an optional time-out (in seconds) is given and it is not C<undef>,
890then the callback will be called without any arguments after the time-out
891elapsed and the port is C<kil>ed.
892
893If no time-out is given (or it is C<undef>), then the local port will
894monitor the remote port instead, so it eventually gets cleaned-up.
895
896Currently this function returns the temporary port, but this "feature"
897might go in future versions unless you can make a convincing case that
898this is indeed useful for something.
899
900=cut
901
902sub cal(@) {
903 my $timeout = ref $_[-1] ? undef : pop;
904 my $cb = pop;
905
906 my $port = port {
907 undef $timeout;
908 kil $SELF;
909 &$cb;
910 };
911
912 if (defined $timeout) {
913 $timeout = AE::timer $timeout, 0, sub {
914 undef $timeout;
915 kil $port;
916 $cb->();
917 };
918 } else {
919 mon $_[0], sub {
920 kil $port;
921 $cb->();
922 };
923 }
924
925 push @_, $port;
926 &snd;
927
928 $port
929}
930
726=back 931=back
727 932
728=head1 NODE MESSAGES 933=head1 DISTRIBUTED DATABASE
729 934
730Nodes understand the following messages sent to them. Many of them take 935AnyEvent::MP comes with a simple distributed database. The database will
731arguments called C<@reply>, which will simply be used to compose a reply 936be mirrored asynchronously on all global nodes. Other nodes bind to one
732message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and 937of the global nodes for their needs. Every node has a "local database"
733the remaining arguments are simply the message data. 938which contains all the values that are set locally. All local databases
939are merged together to form the global database, which can be queried.
734 940
735While other messages exist, they are not public and subject to change. 941The database structure is that of a two-level hash - the database hash
942contains hashes which contain values, similarly to a perl hash of hashes,
943i.e.:
736 944
945 $DATABASE{$family}{$subkey} = $value
946
947The top level hash key is called "family", and the second-level hash key
948is called "subkey" or simply "key".
949
950The family must be alphanumeric, i.e. start with a letter and consist
951of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
952pretty much like Perl module names.
953
954As the family namespace is global, it is recommended to prefix family names
955with the name of the application or module using it.
956
957The subkeys must be non-empty strings, with no further restrictions.
958
959The values should preferably be strings, but other perl scalars should
960work as well (such as C<undef>, arrays and hashes).
961
962Every database entry is owned by one node - adding the same family/subkey
963combination on multiple nodes will not cause discomfort for AnyEvent::MP,
964but the result might be nondeterministic, i.e. the key might have
965different values on different nodes.
966
967Different subkeys in the same family can be owned by different nodes
968without problems, and in fact, this is the common method to create worker
969pools. For example, a worker port for image scaling might do this:
970
971 db_set my_image_scalers => $port;
972
973And clients looking for an image scaler will want to get the
974C<my_image_scalers> keys from time to time:
975
976 db_keys my_image_scalers => sub {
977 @ports = @{ $_[0] };
978 };
979
980Or better yet, they want to monitor the database family, so they always
981have a reasonable up-to-date copy:
982
983 db_mon my_image_scalers => sub {
984 @ports = keys %{ $_[0] };
985 };
986
987In general, you can set or delete single subkeys, but query and monitor
988whole families only.
989
990If you feel the need to monitor or query a single subkey, try giving it
991it's own family.
992
737=over 4 993=over
994
995=item $guard = db_set $family => $subkey [=> $value]
996
997Sets (or replaces) a key to the database - if C<$value> is omitted,
998C<undef> is used instead.
999
1000When called in non-void context, C<db_set> returns a guard that
1001automatically calls C<db_del> when it is destroyed.
1002
1003=item db_del $family => $subkey...
1004
1005Deletes one or more subkeys from the database family.
1006
1007=item $guard = db_reg $family => $port => $value
1008
1009=item $guard = db_reg $family => $port
1010
1011=item $guard = db_reg $family
1012
1013Registers a port in the given family and optionally returns a guard to
1014remove it.
1015
1016This function basically does the same as:
1017
1018 db_set $family => $port => $value
1019
1020Except that the port is monitored and automatically removed from the
1021database family when it is kil'ed.
1022
1023If C<$value> is missing, C<undef> is used. If C<$port> is missing, then
1024C<$SELF> is used.
1025
1026This function is most useful to register a port in some port group (which
1027is just another name for a database family), and have it removed when the
1028port is gone. This works best when the port is a local port.
738 1029
739=cut 1030=cut
740 1031
741=item lookup => $name, @reply 1032sub db_reg($$;$) {
1033 my $family = shift;
1034 my $port = @_ ? shift : $SELF;
742 1035
743Replies with the port ID of the specified well-known port, or C<undef>. 1036 my $clr = sub { db_del $family => $port };
1037 mon $port, $clr;
744 1038
745=item devnull => ... 1039 db_set $family => $port => $_[0];
746 1040
747Generic data sink/CPU heat conversion. 1041 defined wantarray
1042 and &Guard::guard ($clr)
1043}
748 1044
749=item relay => $port, @msg 1045=item db_family $family => $cb->(\%familyhash)
750 1046
751Simply forwards the message to the given port. 1047Queries the named database C<$family> and call the callback with the
1048family represented as a hash. You can keep and freely modify the hash.
752 1049
753=item eval => $string[ @reply] 1050=item db_keys $family => $cb->(\@keys)
754 1051
755Evaluates the given string. If C<@reply> is given, then a message of the 1052Same as C<db_family>, except it only queries the family I<subkeys> and passes
756form C<@reply, $@, @evalres> is sent. 1053them as array reference to the callback.
757 1054
758Example: crash another node. 1055=item db_values $family => $cb->(\@values)
759 1056
760 snd $othernode, eval => "exit"; 1057Same as C<db_family>, except it only queries the family I<values> and passes them
1058as array reference to the callback.
761 1059
762=item time => @reply 1060=item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
763 1061
764Replies the the current node time to C<@reply>. 1062Creates a monitor on the given database family. Each time a key is
1063set or is deleted the callback is called with a hash containing the
1064database family and three lists of added, changed and deleted subkeys,
1065respectively. If no keys have changed then the array reference might be
1066C<undef> or even missing.
765 1067
766Example: tell the current node to send the current time to C<$myport> in a 1068If not called in void context, a guard object is returned that, when
767C<timereply> message. 1069destroyed, stops the monitor.
768 1070
769 snd $NODE, time => $myport, timereply => 1, 2; 1071The family hash reference and the key arrays belong to AnyEvent::MP and
770 # => snd $myport, timereply => 1, 2, <time> 1072B<must not be modified or stored> by the callback. When in doubt, make a
1073copy.
1074
1075As soon as possible after the monitoring starts, the callback will be
1076called with the intiial contents of the family, even if it is empty,
1077i.e. there will always be a timely call to the callback with the current
1078contents.
1079
1080It is possible that the callback is called with a change event even though
1081the subkey is already present and the value has not changed.
1082
1083The monitoring stops when the guard object is destroyed.
1084
1085Example: on every change to the family "mygroup", print out all keys.
1086
1087 my $guard = db_mon mygroup => sub {
1088 my ($family, $a, $c, $d) = @_;
1089 print "mygroup members: ", (join " ", keys %$family), "\n";
1090 };
1091
1092Exmaple: wait until the family "My::Module::workers" is non-empty.
1093
1094 my $guard; $guard = db_mon My::Module::workers => sub {
1095 my ($family, $a, $c, $d) = @_;
1096 return unless %$family;
1097 undef $guard;
1098 print "My::Module::workers now nonempty\n";
1099 };
1100
1101Example: print all changes to the family "AnyEvent::Fantasy::Module".
1102
1103 my $guard = db_mon AnyEvent::Fantasy::Module => sub {
1104 my ($family, $a, $c, $d) = @_;
1105
1106 print "+$_=$family->{$_}\n" for @$a;
1107 print "*$_=$family->{$_}\n" for @$c;
1108 print "-$_=$family->{$_}\n" for @$d;
1109 };
1110
1111=cut
771 1112
772=back 1113=back
773 1114
774=head1 AnyEvent::MP vs. Distributed Erlang 1115=head1 AnyEvent::MP vs. Distributed Erlang
775 1116
776AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 1117AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
777== aemp node, Erlang process == aemp port), so many of the documents and 1118== aemp node, Erlang process == aemp port), so many of the documents and
778programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 1119programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
779sample: 1120sample:
780 1121
781 http://www.Erlang.se/doc/programming_rules.shtml 1122 http://www.erlang.se/doc/programming_rules.shtml
782 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 1123 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
783 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 1124 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
784 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 1125 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
785 1126
786Despite the similarities, there are also some important differences: 1127Despite the similarities, there are also some important differences:
787 1128
788=over 4 1129=over 4
789 1130
790=item * Node references contain the recipe on how to contact them. 1131=item * Node IDs are arbitrary strings in AEMP.
791 1132
792Erlang relies on special naming and DNS to work everywhere in the 1133Erlang relies on special naming and DNS to work everywhere in the same
793same way. AEMP relies on each node knowing it's own address(es), with 1134way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
794convenience functionality. 1135configuration or DNS), and possibly the addresses of some seed nodes, but
1136will otherwise discover other nodes (and their IDs) itself.
795 1137
796This means that AEMP requires a less tightly controlled environment at the 1138=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
797cost of longer node references and a slightly higher management overhead. 1139uses "local ports are like remote ports".
1140
1141The failure modes for local ports are quite different (runtime errors
1142only) then for remote ports - when a local port dies, you I<know> it dies,
1143when a connection to another node dies, you know nothing about the other
1144port.
1145
1146Erlang pretends remote ports are as reliable as local ports, even when
1147they are not.
1148
1149AEMP encourages a "treat remote ports differently" philosophy, with local
1150ports being the special case/exception, where transport errors cannot
1151occur.
798 1152
799=item * Erlang uses processes and a mailbox, AEMP does not queue. 1153=item * Erlang uses processes and a mailbox, AEMP does not queue.
800 1154
801Erlang uses processes that selctively receive messages, and therefore 1155Erlang uses processes that selectively receive messages out of order, and
802needs a queue. AEMP is event based, queuing messages would serve no useful 1156therefore needs a queue. AEMP is event based, queuing messages would serve
803purpose. 1157no useful purpose. For the same reason the pattern-matching abilities
1158of AnyEvent::MP are more limited, as there is little need to be able to
1159filter messages without dequeuing them.
804 1160
805(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP). 1161This is not a philosophical difference, but simply stems from AnyEvent::MP
1162being event-based, while Erlang is process-based.
1163
1164You can have a look at L<Coro::MP> for a more Erlang-like process model on
1165top of AEMP and Coro threads.
806 1166
807=item * Erlang sends are synchronous, AEMP sends are asynchronous. 1167=item * Erlang sends are synchronous, AEMP sends are asynchronous.
808 1168
809Sending messages in Erlang is synchronous and blocks the process. AEMP 1169Sending messages in Erlang is synchronous and blocks the process until
810sends are immediate, connection establishment is handled in the 1170a connection has been established and the message sent (and so does not
811background. 1171need a queue that can overflow). AEMP sends return immediately, connection
1172establishment is handled in the background.
812 1173
813=item * Erlang can silently lose messages, AEMP cannot. 1174=item * Erlang suffers from silent message loss, AEMP does not.
814 1175
815Erlang makes few guarantees on messages delivery - messages can get lost 1176Erlang implements few guarantees on messages delivery - messages can get
816without any of the processes realising it (i.e. you send messages a, b, 1177lost without any of the processes realising it (i.e. you send messages a,
817and c, and the other side only receives messages a and c). 1178b, and c, and the other side only receives messages a and c).
818 1179
819AEMP guarantees correct ordering, and the guarantee that there are no 1180AEMP guarantees (modulo hardware errors) correct ordering, and the
1181guarantee that after one message is lost, all following ones sent to the
1182same port are lost as well, until monitoring raises an error, so there are
820holes in the message sequence. 1183no silent "holes" in the message sequence.
821 1184
822=item * In Erlang, processes can be declared dead and later be found to be 1185If you want your software to be very reliable, you have to cope with
823alive. 1186corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
824 1187simply tries to work better in common error cases, such as when a network
825In Erlang it can happen that a monitored process is declared dead and 1188link goes down.
826linked processes get killed, but later it turns out that the process is
827still alive - and can receive messages.
828
829In AEMP, when port monitoring detects a port as dead, then that port will
830eventually be killed - it cannot happen that a node detects a port as dead
831and then later sends messages to it, finding it is still alive.
832 1189
833=item * Erlang can send messages to the wrong port, AEMP does not. 1190=item * Erlang can send messages to the wrong port, AEMP does not.
834 1191
835In Erlang it is quite possible that a node that restarts reuses a process 1192In Erlang it is quite likely that a node that restarts reuses an Erlang
836ID known to other nodes for a completely different process, causing 1193process ID known to other nodes for a completely different process,
837messages destined for that process to end up in an unrelated process. 1194causing messages destined for that process to end up in an unrelated
1195process.
838 1196
839AEMP never reuses port IDs, so old messages or old port IDs floating 1197AEMP does not reuse port IDs, so old messages or old port IDs floating
840around in the network will not be sent to an unrelated port. 1198around in the network will not be sent to an unrelated port.
841 1199
842=item * Erlang uses unprotected connections, AEMP uses secure 1200=item * Erlang uses unprotected connections, AEMP uses secure
843authentication and can use TLS. 1201authentication and can use TLS.
844 1202
845AEMP can use a proven protocol - SSL/TLS - to protect connections and 1203AEMP can use a proven protocol - TLS - to protect connections and
846securely authenticate nodes. 1204securely authenticate nodes.
847 1205
848=item * The AEMP protocol is optimised for both text-based and binary 1206=item * The AEMP protocol is optimised for both text-based and binary
849communications. 1207communications.
850 1208
851The AEMP protocol, unlike the Erlang protocol, supports both 1209The AEMP protocol, unlike the Erlang protocol, supports both programming
852language-independent text-only protocols (good for debugging) and binary, 1210language independent text-only protocols (good for debugging), and binary,
853language-specific serialisers (e.g. Storable). 1211language-specific serialisers (e.g. Storable). By default, unless TLS is
1212used, the protocol is actually completely text-based.
854 1213
855It has also been carefully designed to be implementable in other languages 1214It has also been carefully designed to be implementable in other languages
856with a minimum of work while gracefully degrading fucntionality to make the 1215with a minimum of work while gracefully degrading functionality to make the
857protocol simple. 1216protocol simple.
858 1217
859=item * AEMP has more flexible monitoring options than Erlang. 1218=item * AEMP has more flexible monitoring options than Erlang.
860 1219
861In Erlang, you can chose to receive I<all> exit signals as messages 1220In Erlang, you can chose to receive I<all> exit signals as messages or
862or I<none>, there is no in-between, so monitoring single processes is 1221I<none>, there is no in-between, so monitoring single Erlang processes is
863difficult to implement. Monitoring in AEMP is more flexible than in 1222difficult to implement.
864Erlang, as one can choose between automatic kill, exit message or callback 1223
865on a per-process basis. 1224Monitoring in AEMP is more flexible than in Erlang, as one can choose
1225between automatic kill, exit message or callback on a per-port basis.
866 1226
867=item * Erlang tries to hide remote/local connections, AEMP does not. 1227=item * Erlang tries to hide remote/local connections, AEMP does not.
868 1228
869Monitoring in Erlang is not an indicator of process death/crashes, 1229Monitoring in Erlang is not an indicator of process death/crashes, in the
870as linking is (except linking is unreliable in Erlang). 1230same way as linking is (except linking is unreliable in Erlang).
871 1231
872In AEMP, you don't "look up" registered port names or send to named ports 1232In AEMP, you don't "look up" registered port names or send to named ports
873that might or might not be persistent. Instead, you normally spawn a port 1233that might or might not be persistent. Instead, you normally spawn a port
874on the remote node. The init function monitors the you, and you monitor 1234on the remote node. The init function monitors you, and you monitor the
875the remote port. Since both monitors are local to the node, they are much 1235remote port. Since both monitors are local to the node, they are much more
876more reliable. 1236reliable (no need for C<spawn_link>).
877 1237
878This also saves round-trips and avoids sending messages to the wrong port 1238This also saves round-trips and avoids sending messages to the wrong port
879(hard to do in Erlang). 1239(hard to do in Erlang).
880 1240
881=back 1241=back
882 1242
883=head1 RATIONALE 1243=head1 RATIONALE
884 1244
885=over 4 1245=over 4
886 1246
887=item Why strings for ports and noderefs, why not objects? 1247=item Why strings for port and node IDs, why not objects?
888 1248
889We considered "objects", but found that the actual number of methods 1249We considered "objects", but found that the actual number of methods
890thatc an be called are very low. Since port IDs and noderefs travel over 1250that can be called are quite low. Since port and node IDs travel over
891the network frequently, the serialising/deserialising would add lots of 1251the network frequently, the serialising/deserialising would add lots of
892overhead, as well as having to keep a proxy object. 1252overhead, as well as having to keep a proxy object everywhere.
893 1253
894Strings can easily be printed, easily serialised etc. and need no special 1254Strings can easily be printed, easily serialised etc. and need no special
895procedures to be "valid". 1255procedures to be "valid".
896 1256
897And a a miniport consists of a single closure stored in a global hash - it 1257And as a result, a port with just a default receiver consists of a single
898can't become much cheaper. 1258code reference stored in a global hash - it can't become much cheaper.
899 1259
900=item Why favour JSON, why not real serialising format such as Storable? 1260=item Why favour JSON, why not a real serialising format such as Storable?
901 1261
902In fact, any AnyEvent::MP node will happily accept Storable as framing 1262In fact, any AnyEvent::MP node will happily accept Storable as framing
903format, but currently there is no way to make a node use Storable by 1263format, but currently there is no way to make a node use Storable by
904default. 1264default (although all nodes will accept it).
905 1265
906The default framing protocol is JSON because a) JSON::XS is many times 1266The default framing protocol is JSON because a) JSON::XS is many times
907faster for small messages and b) most importantly, after years of 1267faster for small messages and b) most importantly, after years of
908experience we found that object serialisation is causing more problems 1268experience we found that object serialisation is causing more problems
909than it gains: Just like function calls, objects simply do not travel 1269than it solves: Just like function calls, objects simply do not travel
910easily over the network, mostly because they will always be a copy, so you 1270easily over the network, mostly because they will always be a copy, so you
911always have to re-think your design. 1271always have to re-think your design.
912 1272
913Keeping your messages simple, concentrating on data structures rather than 1273Keeping your messages simple, concentrating on data structures rather than
914objects, will keep your messages clean, tidy and efficient. 1274objects, will keep your messages clean, tidy and efficient.
915 1275
916=back 1276=back
917 1277
1278=head1 PORTING FROM AnyEvent::MP VERSION 1.X
1279
1280AEMP version 2 has a few major incompatible changes compared to version 1:
1281
1282=over 4
1283
1284=item AnyEvent::MP::Global no longer has group management functions.
1285
1286At least not officially - the grp_* functions are still exported and might
1287work, but they will be removed in some later release.
1288
1289AnyEvent::MP now comes with a distributed database that is more
1290powerful. Its database families map closely to port groups, but the API
1291has changed (the functions are also now exported by AnyEvent::MP). Here is
1292a rough porting guide:
1293
1294 grp_reg $group, $port # old
1295 db_reg $group, $port # new
1296
1297 $list = grp_get $group # old
1298 db_keys $group, sub { my $list = shift } # new
1299
1300 grp_mon $group, $cb->(\@ports, $add, $del) # old
1301 db_mon $group, $cb->(\%ports, $add, $change, $del) # new
1302
1303C<grp_reg> is a no-brainer (just replace by C<db_reg>), but C<grp_get> is
1304no longer instant, because the local node might not have a copy of the
1305group. You can either modify your code to allow for a callback, or use
1306C<db_mon> to keep an updated copy of the group:
1307
1308 my $local_group_copy;
1309 db_mon $group => sub { $local_group_copy = $_[0] };
1310
1311 # now "keys %$local_group_copy" always returns the most up-to-date
1312 # list of ports in the group.
1313
1314C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon>
1315passes a hash as first argument, and an extra C<$chg> argument that can be
1316ignored:
1317
1318 db_mon $group => sub {
1319 my ($ports, $add, $chg, $lde) = @_;
1320 $ports = [keys %$ports];
1321
1322 # now $ports, $add and $del are the same as
1323 # were originally passed by grp_mon.
1324 ...
1325 };
1326
1327=item Nodes not longer connect to all other nodes.
1328
1329In AEMP 1.x, every node automatically loads the L<AnyEvent::MP::Global>
1330module, which in turn would create connections to all other nodes in the
1331network (helped by the seed nodes).
1332
1333In version 2.x, global nodes still connect to all other global nodes, but
1334other nodes don't - now every node either is a global node itself, or
1335attaches itself to another global node.
1336
1337If a node isn't a global node itself, then it attaches itself to one
1338of its seed nodes. If that seed node isn't a global node yet, it will
1339automatically be upgraded to a global node.
1340
1341So in many cases, nothing needs to be changed - one just has to make sure
1342that all seed nodes are meshed together with the other seed nodes (as with
1343AEMP 1.x), and other nodes specify them as seed nodes. This is most easily
1344achieved by specifying the same set of seed nodes for all nodes in the
1345network.
1346
1347Not opening a connection to every other node is usually an advantage,
1348except when you need the lower latency of an already established
1349connection. To ensure a node establishes a connection to another node,
1350you can monitor the node port (C<mon $node, ...>), which will attempt to
1351create the connection (and notify you when the connection fails).
1352
1353=item Listener-less nodes (nodes without binds) are gone.
1354
1355And are not coming back, at least not in their old form. If no C<binds>
1356are specified for a node, AnyEvent::MP assumes a default of C<*:*>.
1357
1358There are vague plans to implement some form of routing domains, which
1359might or might not bring back listener-less nodes, but don't count on it.
1360
1361The fact that most connections are now optional somewhat mitigates this,
1362as a node can be effectively unreachable from the outside without any
1363problems, as long as it isn't a global node and only reaches out to other
1364nodes (as opposed to being contacted from other nodes).
1365
1366=item $AnyEvent::MP::Kernel::WARN has gone.
1367
1368AnyEvent has acquired a logging framework (L<AnyEvent::Log>), and AEMP now
1369uses this, and so should your programs.
1370
1371Every module now documents what kinds of messages it generates, with
1372AnyEvent::MP acting as a catch all.
1373
1374On the positive side, this means that instead of setting
1375C<PERL_ANYEVENT_MP_WARNLEVEL>, you can get away by setting C<AE_VERBOSE> -
1376much less to type.
1377
1378=back
1379
1380=head1 LOGGING
1381
1382AnyEvent::MP does not normally log anything by itself, but since it is the
1383root of the contetx hierarchy for AnyEvent::MP modules, it will receive
1384all log messages by submodules.
1385
918=head1 SEE ALSO 1386=head1 SEE ALSO
1387
1388L<AnyEvent::MP::Intro> - a gentle introduction.
1389
1390L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
1391
1392L<AnyEvent::MP::Global> - network maintenance and port groups, to find
1393your applications.
1394
1395L<AnyEvent::MP::DataConn> - establish data connections between nodes.
1396
1397L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
1398all nodes.
919 1399
920L<AnyEvent>. 1400L<AnyEvent>.
921 1401
922=head1 AUTHOR 1402=head1 AUTHOR
923 1403

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines