[ViewVC] Diff of: cvs/AnyEvent-MP/MP.pm

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.49 by root, Thu Aug 13 15:29:58 2009 UTC vs.
Revision 1.70 by root, Sun Aug 30 19:49:47 2009 UTC

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

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.49 by root, Thu Aug 13 15:29:58 2009 UTC vs. Revision 1.70 by root, Sun Aug 30 19:49:47 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.49 by root, Thu Aug 13 15:29:58 2009 UTC vs.
Revision 1.70 by root, Sun Aug 30 19:49:47 2009 UTC