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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.38 by root, Fri Aug 7 22:55:18 2009 UTC vs.
Revision 1.73 by root, Mon Aug 31 11:08:25 2009 UTC

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.38 by root, Fri Aug 7 22:55:18 2009 UTC vs. Revision 1.73 by root, Mon Aug 31 11:08:25 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.38 by root, Fri Aug 7 22:55:18 2009 UTC vs.
Revision 1.73 by root, Mon Aug 31 11:08:25 2009 UTC