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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC vs.
Revision 1.71 by root, Sun Aug 30 19:52:56 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	initialise_node;
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 = @_; 0 };
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"; 0 };
29	rcv $port, pong => sub { warn "pong received\n"; 0 };	31	rcv $port, pong => sub { warn "pong received\n"; 0 };
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	initialise_node
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<initialise_node>.
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 initialise_node $profile_name, 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 initialise 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 initialises 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.	176	The first argument is a profile name. If it is C<undef> or missing, then
		177	the current nodename will be used instead (i.e. F<uname -n>).
159		178
160	There are two types of networked nodes, public nodes and slave nodes:	179	The function first looks up the profile in the aemp configuration (see the
		180	L<aemp> commandline utility). the profile is calculated as follows:
161		181
162	=over 4	182	First, all remaining key => value pairs (all of which are conviniently
		183	undocumented at the moment) will be used. Then they will be overwritten by
		184	any values specified in the global default configuration (see the F<aemp>
		185	utility), then the chain of profiles selected, if any. That means that
		186	the values specified in the profile have highest priority and the values
		187	specified via C<initialise_node> have lowest priority.
163		188
164	=item public nodes	189	If the profile specifies a node ID, then this will become the node ID of
		190	this process. If not, then the profile name will be used as node ID. The
		191	special node ID of C<anon/> will be replaced by a random node ID.
165		192
166	For public nodes, C<$noderef> must either be a (possibly unresolved)	193	The next step is to look up the binds in the profile, followed by binding
167	noderef, in which case it will be resolved, or C<undef> (or missing), in	194	aemp protocol listeners on all binds specified (it is possible and valid
168	which case the noderef will be guessed.	195	to have no binds, meaning that the node cannot be contacted form the
		196	outside. This means the node cannot talk to other nodes that also have no
		197	binds, but it can still talk to all "normal" nodes).
169		198
170	Afterwards, the node will bind itself on all endpoints and try to connect	199	If the profile does not specify a binds list, then a default of C<*> is
171	to all additional C<$seednodes> that are specified. Seednodes are optional	200	used.
172	and can be used to quickly bootstrap the node into an existing network.
173		201
174	=item slave nodes	202	Lastly, the seeds list from the profile is passed to the
		203	L<AnyEvent::MP::Global> module, which will then use it to keep
		204	connectivity with at least on of those seed nodes at any point in time.
175		205
176	When the C<$noderef> is the special string C<slave/>, then the node will	206	Example: become a distributed node listening on the guessed noderef, or
177	become a slave node. Slave nodes cannot be contacted from outside and will	207	the one specified via C<aemp> for the current node. This should be the
178	route most of their traffic to the master node that they attach to.	208	most common form of invocation for "daemon"-type nodes.
179
180	At least one additional noderef is required: The node will try to connect
181	to all of them and will become a slave attached to the first node it can
182	successfully connect to.
183
184	=back
185
186	This function will block until all nodes have been resolved and, for slave
187	nodes, until it has successfully established a connection to a master
188	server.
189
190	Example: become a public node listening on the default node.
191		209
192	initialise_node;	210	initialise_node;
193		211
194	Example: become a public node, and try to contact some well-known master	212	Example: become an anonymous node. This form is often used for commandline
195	servers to become part of the network.	213	clients.
196		214
197	initialise_node undef, "master1", "master2";
198
199	Example: become a public node listening on port C<4041>.
200
201	initialise_node 4041;	215	initialise_node "anon/";
202		216
203	Example: become a public node, only visible on localhost port 4044.	217	Example: become a distributed node. If there is no profile of the given
		218	name, or no binds list was specified, resolve C<localhost:4044> and bind
		219	on the resulting addresses.
204		220
205	initialise_node "locahost:4044";	221	initialise_node "localhost:4044";
206
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		222
240	=item $SELF	223	=item $SELF
241		224
242	Contains the current port id while executing C<rcv> callbacks or C<psub>	225	Contains the current port id while executing C<rcv> callbacks or C<psub>
243	blocks.	226	blocks.
244		227
245	=item SELF, %SELF, @SELF...	228	=item *SELF, SELF, %SELF, @SELF...
246		229
247	Due to some quirks in how perl exports variables, it is impossible to	230	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	231	just export C<$SELF>, all the symbols named C<SELF> are exported by this
249	module, but only C<$SELF> is currently used.	232	module, but only C<$SELF> is currently used.
250		233
251	=item snd $port, type => @data	234	=item snd $port, type => @data
252		235
253	=item snd $port, @msg	236	=item snd $port, @msg
254		237
255	Send the given message to the given port ID, which can identify either	238	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	239	local or a remote port, and must be a port ID.
257	stringifies a sa port ID (such as a port object :).
258		240
259	While the message can be about anything, it is highly recommended to use a	241	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	242	use a string as first element (a port ID, or some word that indicates a
261	type etc.).	243	request type etc.) and to consist if only simple perl values (scalars,
		244	arrays, hashes) - if you think you need to pass an object, think again.
262		245
263	The message data effectively becomes read-only after a call to this	246	The message data logically becomes read-only after a call to this
264	function: modifying any argument is not allowed and can cause many	247	function: modifying any argument (or values referenced by them) is
265	problems.	248	forbidden, as there can be considerable time between the call to C<snd>
		249	and the time the message is actually being serialised - in fact, it might
		250	never be copied as within the same process it is simply handed to the
		251	receiving port.
266		252
267	The type of data you can transfer depends on the transport protocol: when	253	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	254	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	255	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	256	that Storable can serialise and deserialise is allowed, and for the local
271	node, anything can be passed.	257	node, anything can be passed. Best rely only on the common denominator of
		258	these.
272		259
273	=item $local_port = port	260	=item $local_port = port
274		261
275	Create a new local port object that can be used either as a pattern	262	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"),	263	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		264
279	=item $port = port { my @msg = @_; $finished }	265	=item $local_port = port { my @msg = @_ }
280		266
281	Creates a "miniport", that is, a very lightweight port without any pattern	267	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.	268	creating a port and calling C<rcv $port, $callback> on it.
284		269
285	The block will be called for every message received on the port. When the	270	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	271	global variable C<$SELF> set to the port ID. Runtime errors will cause the
287	will be destroyed. Otherwise it will stay alive.	272	port to be C<kil>ed. The message will be passed as-is, no extra argument
		273	(i.e. no port ID) will be passed to the callback.
288		274
289	The message will be passed as-is, no extra argument (i.e. no port id) will	275	If you want to stop/destroy the port, simply C<kil> it:
290	be passed to the callback.
291		276
292	If you need the local port id in the callback, this works nicely:	277	my $port = port {
293		278	my @msg = @_;
294	my $port; $port = port {	279	...
295	snd $otherport, reply => $port;	280	kil $SELF;
296	};	281	};
297		282
298	=cut	283	=cut
299		284
300	sub rcv($@);	285	sub rcv($@);
		286
		287	sub _kilme {
		288	die "received message on port without callback";
		289	}
301		290
302	sub port(;&) {	291	sub port(;&) {
303	my $id = "$UNIQ." . $ID++;	292	my $id = "$UNIQ." . $ID++;
304	my $port = "$NODE#$id";	293	my $port = "$NODE#$id";
305		294
306	if (@_) {	295	rcv $port, shift \|\| \&_kilme;
307	rcv $port, shift;
308	} else {
309	$PORT{$id} = sub { }; # nop
310	}
311		296
312	$port	297	$port
313	}	298	}
314		299
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)	300	=item rcv $local_port, $callback->(@msg)
335		301
336	Replaces the callback on the specified miniport (after converting it to	302	Replaces the default callback on the specified port. There is no way to
337	one if required).	303	remove the default callback: use C<sub { }> to disable it, or better
338		304	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		305
352	The global C<$SELF> (exported by this module) contains C<$port> while	306	The global C<$SELF> (exported by this module) contains C<$port> while
353	executing the callback.	307	executing the callback. Runtime errors during callback execution will
		308	result in the port being C<kil>ed.
354		309
355	Runtime errors during callback execution will result in the port being	310	The default callback received all messages not matched by a more specific
356	C<kil>ed.	311	C<tag> match.
357		312
358	If the match is an array reference, then it will be matched against the	313	=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		314
362	Any element in the match that is specified as C<_any_> (a function	315	Register (or replace) callbacks to be called on messages starting with the
363	exported by this module) matches any single element of the message.	316	given tag on the given port (and return the port), or unregister it (when
		317	C<$callback> is C<$undef> or missing). There can only be one callback
		318	registered for each tag.
364		319
365	While not required, it is highly recommended that the first matching	320	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	321	element (the tag) has been removed. The callback will use the same
367	also the most efficient match (by far).	322	environment as the default callback (see above).
368		323
369	Example: create a port and bind receivers on it in one go.	324	Example: create a port and bind receivers on it in one go.
370		325
371	my $port = rcv port,	326	my $port = rcv port,
372	msg1 => sub { ...; 0 },	327	msg1 => sub { ... },
373	msg2 => sub { ...; 0 },	328	msg2 => sub { ... },
374	;	329	;
375		330
376	Example: create a port, bind receivers and send it in a message elsewhere	331	Example: create a port, bind receivers and send it in a message elsewhere
377	in one go:	332	in one go:
378		333
379	snd $otherport, reply =>	334	snd $otherport, reply =>
380	rcv port,	335	rcv port,
381	msg1 => sub { ...; 0 },	336	msg1 => sub { ... },
382	...	337	...
383	;	338	;
		339
		340	Example: temporarily register a rcv callback for a tag matching some port
		341	(e.g. for a rpc reply) and unregister it after a message was received.
		342
		343	rcv $port, $otherport => sub {
		344	my @reply = @_;
		345
		346	rcv $SELF, $otherport;
		347	};
384		348
385	=cut	349	=cut
386		350
387	sub rcv($@) {	351	sub rcv($@) {
388	my $port = shift;	352	my $port = shift;
389	my ($noderef, $portid) = split /#/, $port, 2;	353	my ($noderef, $portid) = split /#/, $port, 2;
390		354
391	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}	355	$NODE{$noderef} == $NODE{""}
392	or Carp::croak "$port: rcv can only be called on local ports, caught";	356	or Carp::croak "$port: rcv can only be called on local ports, caught";
393		357
394	if (@_ == 1) {	358	while (@_) {
		359	if (ref $_[0]) {
		360	if (my $self = $PORT_DATA{$portid}) {
		361	"AnyEvent::MP::Port" eq ref $self
		362	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		363
		364	$self->[2] = shift;
		365	} else {
395	my $cb = shift;	366	my $cb = shift;
396	delete $PORT_DATA{$portid};
397	$PORT{$portid} = sub {	367	$PORT{$portid} = sub {
398	local $SELF = $port;	368	local $SELF = $port;
399	eval {	369	eval { &$cb }; _self_die if $@;
400	&$cb	370	};
401	and kil $port;
402	};	371	}
403	_self_die if $@;	372	} elsif (defined $_[0]) {
404	};
405	} else {
406	my $self = $PORT_DATA{$portid} \|\|= do {	373	my $self = $PORT_DATA{$portid} \|\|= do {
407	my $self = bless {	374	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
408	id => $port,
409	}, "AnyEvent::MP::Port";
410		375
411	$PORT{$portid} = sub {	376	$PORT{$portid} = sub {
412	local $SELF = $port;	377	local $SELF = $port;
413		378
414	eval {
415	for (@{ $self->{rc0}{$_[0]} }) {	379	if (my $cb = $self->[1]{$_[0]}) {
416	$_ && &{$_->[0]}	380	shift;
417	&& undef $_;	381	eval { &$cb }; _self_die if $@;
418	}	382	} else {
419
420	for (@{ $self->{rcv}{$_[0]} }) {
421	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
422	&& &{$_->[0]}	383	&{ $self->[0] };
423	&& undef $_;
424	}
425
426	for (@{ $self->{any} }) {
427	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
428	&& &{$_->[0]}
429	&& undef $_;
430	}	384	}
431	};	385	};
432	_self_die if $@;	386
		387	$self
433	};	388	};
434		389
435	$self
436	};
437
438	"AnyEvent::MP::Port" eq ref $self	390	"AnyEvent::MP::Port" eq ref $self
439	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	391	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
440		392
441	while (@_) {
442	my ($match, $cb) = splice @_, 0, 2;	393	my ($tag, $cb) = splice @_, 0, 2;
443		394
444	if (!ref $match) {	395	if (defined $cb) {
445	push @{ $self->{rc0}{$match} }, [$cb];	396	$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 {	397	} else {
452	push @{ $self->{any} }, [$cb, $match];	398	delete $self->[1]{$tag};
453	}	399	}
454	}	400	}
455	}	401	}
456		402
457	$port	403	$port
…		…
493	$res	439	$res
494	}	440	}
495	}	441	}
496	}	442	}
497		443
498	=item $guard = mon $port, $cb->(@reason)	444	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
499		445
500	=item $guard = mon $port, $rcvport	446	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
501		447
502	=item $guard = mon $port	448	=item $guard = mon $port # kill $SELF when $port dies
503		449
504	=item $guard = mon $port, $rcvport, @msg	450	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
505		451
506	Monitor the given port and do something when the port is killed, and	452	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.	453	messages to it were lost, and optionally return a guard that can be used
		454	to stop monitoring again.
		455
		456	C<mon> effectively guarantees that, in the absence of hardware failures,
		457	after starting the monitor, either all messages sent to the port will
		458	arrive, or the monitoring action will be invoked after possible message
		459	loss has been detected. No messages will be lost "in between" (after
		460	the first lost message no further messages will be received by the
		461	port). After the monitoring action was invoked, further messages might get
		462	delivered again.
		463
		464	Note that monitoring-actions are one-shot: once messages are lost (and a
		465	monitoring alert was raised), they are removed and will not trigger again.
508		466
509	In the first form (callback), the callback is simply called with any	467	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	468	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	469	"normally"). Note also that I<< the callback B<must> never die >>, so use
512	C<eval> if unsure.	470	C<eval> if unsure.
513		471
514	In the second form (another port given), the other port (C<$rcvport)	472	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	473	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	474	"normal" kils nothing happens, while under all other conditions, the other
517	port is killed with the same reason.	475	port is killed with the same reason.
518		476
519	The third form (kill self) is the same as the second form, except that	477	The third form (kill self) is the same as the second form, except that
…		…
574	is killed, the references will be freed.	532	is killed, the references will be freed.
575		533
576	Optionally returns a guard that will stop the monitoring.	534	Optionally returns a guard that will stop the monitoring.
577		535
578	This function is useful when you create e.g. timers or other watchers and	536	This function is useful when you create e.g. timers or other watchers and
579	want to free them when the port gets killed:	537	want to free them when the port gets killed (note the use of C<psub>):
580		538
581	$port->rcv (start => sub {	539	$port->rcv (start => sub {
582	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {	540	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
583	undef $timer if 0.9 < rand;	541	undef $timer if 0.9 < rand;
584	});	542	});
585	});	543	});
586		544
587	=cut	545	=cut
…		…
596		554
597	=item kil $port[, @reason]	555	=item kil $port[, @reason]
598		556
599	Kill the specified port with the given C<@reason>.	557	Kill the specified port with the given C<@reason>.
600		558
601	If no C<@reason> is specified, then the port is killed "normally" (linked	559	If no C<@reason> is specified, then the port is killed "normally" (ports
602	ports will not be kileld, or even notified).	560	monitoring other ports will not necessarily die because a port dies
		561	"normally").
603		562
604	Otherwise, linked ports get killed with the same reason (second form of	563	Otherwise, linked ports get killed with the same reason (second form of
605	C<mon>, see below).	564	C<mon>, see above).
606		565
607	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	566	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
608	will be reported as reason C<< die => $@ >>.	567	will be reported as reason C<< die => $@ >>.
609		568
610	Transport/communication errors are reported as C<< transport_error =>	569	Transport/communication errors are reported as C<< transport_error =>
…		…
615	=item $port = spawn $node, $initfunc[, @initdata]	574	=item $port = spawn $node, $initfunc[, @initdata]
616		575
617	Creates a port on the node C<$node> (which can also be a port ID, in which	576	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).	577	case it's the node where that port resides).
619		578
620	The port ID of the newly created port is return immediately, and it is	579	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.	580	possible to immediately start sending messages or to monitor the port.
622		581
623	After the port has been created, the init function is	582	After the port has been created, the init function is called on the remote
624	called. This function must be a fully-qualified function name	583	node, in the same context as a C<rcv> callback. This function must be a
625	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main	584	fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
626	program, use C<::name>.	585	specify a function in the main program, use C<::name>.
627		586
628	If the function doesn't exist, then the node tries to C<require>	587	If the function doesn't exist, then the node tries to C<require>
629	the package, then the package above the package and so on (e.g.	588	the package, then the package above the package and so on (e.g.
630	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	589	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
631	exists or it runs out of package names.	590	exists or it runs out of package names.
632		591
633	The init function is then called with the newly-created port as context	592	The init function is then called with the newly-created port as context
634	object (C<$SELF>) and the C<@initdata> values as arguments.	593	object (C<$SELF>) and the C<@initdata> values as arguments.
635		594
636	A common idiom is to pass your own port, monitor the spawned port, and	595	A common idiom is to pass a local port, immediately monitor the spawned
637	in the init function, monitor the original port. This two-way monitoring	596	port, and in the remote init function, immediately monitor the passed
638	ensures that both ports get cleaned up when there is a problem.	597	local port. This two-way monitoring ensures that both ports get cleaned up
		598	when there is a problem.
639		599
640	Example: spawn a chat server port on C<$othernode>.	600	Example: spawn a chat server port on C<$othernode>.
641		601
642	# this node, executed from within a port context:	602	# this node, executed from within a port context:
643	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	603	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
…		…
673	my $id = "$RUNIQ." . $ID++;	633	my $id = "$RUNIQ." . $ID++;
674		634
675	$_[0] =~ /::/	635	$_[0] =~ /::/
676	or Carp::croak "spawn init function must be a fully-qualified name, caught";	636	or Carp::croak "spawn init function must be a fully-qualified name, caught";
677		637
678	($NODE{$noderef} \|\| add_node $noderef)	638	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;
679	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
680		639
681	"$noderef#$id"	640	"$noderef#$id"
682	}	641	}
683		642
684	=back	643	=item after $timeout, @msg
685		644
686	=head1 NODE MESSAGES	645	=item after $timeout, $callback
687		646
688	Nodes understand the following messages sent to them. Many of them take	647	Either sends the given message, or call the given callback, after the
689	arguments called C<@reply>, which will simply be used to compose a reply	648	specified number of seconds.
690	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
691	the remaining arguments are simply the message data.
692		649
693	While other messages exist, they are not public and subject to change.	650	This is simply a utility function that comes in handy at times - the
		651	AnyEvent::MP author is not convinced of the wisdom of having it, though,
		652	so it may go away in the future.
694		653
695	=over 4
696
697	=cut	654	=cut
698		655
699	=item lookup => $name, @reply	656	sub after($@) {
		657	my ($timeout, @action) = @_;
700		658
701	Replies with the port ID of the specified well-known port, or C<undef>.	659	my $t; $t = AE::timer $timeout, 0, sub {
702		660	undef $t;
703	=item devnull => ...	661	ref $action[0]
704		662	? $action[0]()
705	Generic data sink/CPU heat conversion.	663	: snd @action;
706		664	};
707	=item relay => $port, @msg	665	}
708
709	Simply forwards the message to the given port.
710
711	=item eval => $string[ @reply]
712
713	Evaluates the given string. If C<@reply> is given, then a message of the
714	form C<@reply, $@, @evalres> is sent.
715
716	Example: crash another node.
717
718	snd $othernode, eval => "exit";
719
720	=item time => @reply
721
722	Replies the the current node time to C<@reply>.
723
724	Example: tell the current node to send the current time to C<$myport> in a
725	C<timereply> message.
726
727	snd $NODE, time => $myport, timereply => 1, 2;
728	# => snd $myport, timereply => 1, 2, <time>
729		666
730	=back	667	=back
731		668
732	=head1 AnyEvent::MP vs. Distributed Erlang	669	=head1 AnyEvent::MP vs. Distributed Erlang
733		670
…		…
743		680
744	Despite the similarities, there are also some important differences:	681	Despite the similarities, there are also some important differences:
745		682
746	=over 4	683	=over 4
747		684
748	=item * Node references contain the recipe on how to contact them.	685	=item * Node IDs are arbitrary strings in AEMP.
749		686
750	Erlang relies on special naming and DNS to work everywhere in the	687	Erlang relies on special naming and DNS to work everywhere in the same
751	same way. AEMP relies on each node knowing it's own address(es), with	688	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
752	convenience functionality.	689	configuraiton or DNS), but will otherwise discover other odes itself.
753		690
754	This means that AEMP requires a less tightly controlled environment at the	691	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
755	cost of longer node references and a slightly higher management overhead.	692	uses "local ports are like remote ports".
		693
		694	The failure modes for local ports are quite different (runtime errors
		695	only) then for remote ports - when a local port dies, you I<know> it dies,
		696	when a connection to another node dies, you know nothing about the other
		697	port.
		698
		699	Erlang pretends remote ports are as reliable as local ports, even when
		700	they are not.
		701
		702	AEMP encourages a "treat remote ports differently" philosophy, with local
		703	ports being the special case/exception, where transport errors cannot
		704	occur.
756		705
757	=item * Erlang uses processes and a mailbox, AEMP does not queue.	706	=item * Erlang uses processes and a mailbox, AEMP does not queue.
758		707
759	Erlang uses processes that selctively receive messages, and therefore	708	Erlang uses processes that selectively receive messages, and therefore
760	needs a queue. AEMP is event based, queuing messages would serve no useful	709	needs a queue. AEMP is event based, queuing messages would serve no
761	purpose.	710	useful purpose. For the same reason the pattern-matching abilities of
		711	AnyEvent::MP are more limited, as there is little need to be able to
		712	filter messages without dequeing them.
762		713
763	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	714	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
764		715
765	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	716	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
766		717
767	Sending messages in Erlang is synchronous and blocks the process. AEMP	718	Sending messages in Erlang is synchronous and blocks the process (and
768	sends are immediate, connection establishment is handled in the	719	so does not need a queue that can overflow). AEMP sends are immediate,
769	background.	720	connection establishment is handled in the background.
770		721
771	=item * Erlang can silently lose messages, AEMP cannot.	722	=item * Erlang suffers from silent message loss, AEMP does not.
772		723
773	Erlang makes few guarantees on messages delivery - messages can get lost	724	Erlang makes few guarantees on messages delivery - messages can get lost
774	without any of the processes realising it (i.e. you send messages a, b,	725	without any of the processes realising it (i.e. you send messages a, b,
775	and c, and the other side only receives messages a and c).	726	and c, and the other side only receives messages a and c).
776		727
777	AEMP guarantees correct ordering, and the guarantee that there are no	728	AEMP guarantees correct ordering, and the guarantee that after one message
778	holes in the message sequence.	729	is lost, all following ones sent to the same port are lost as well, until
779		730	monitoring raises an error, so there are no silent "holes" in the message
780	=item * In Erlang, processes can be declared dead and later be found to be	731	sequence.
781	alive.
782
783	In Erlang it can happen that a monitored process is declared dead and
784	linked processes get killed, but later it turns out that the process is
785	still alive - and can receive messages.
786
787	In AEMP, when port monitoring detects a port as dead, then that port will
788	eventually be killed - it cannot happen that a node detects a port as dead
789	and then later sends messages to it, finding it is still alive.
790		732
791	=item * Erlang can send messages to the wrong port, AEMP does not.	733	=item * Erlang can send messages to the wrong port, AEMP does not.
792		734
793	In Erlang it is quite possible that a node that restarts reuses a process	735	In Erlang it is quite likely that a node that restarts reuses a process ID
794	ID known to other nodes for a completely different process, causing	736	known to other nodes for a completely different process, causing messages
795	messages destined for that process to end up in an unrelated process.	737	destined for that process to end up in an unrelated process.
796		738
797	AEMP never reuses port IDs, so old messages or old port IDs floating	739	AEMP never reuses port IDs, so old messages or old port IDs floating
798	around in the network will not be sent to an unrelated port.	740	around in the network will not be sent to an unrelated port.
799		741
800	=item * Erlang uses unprotected connections, AEMP uses secure	742	=item * Erlang uses unprotected connections, AEMP uses secure
801	authentication and can use TLS.	743	authentication and can use TLS.
802		744
803	AEMP can use a proven protocol - SSL/TLS - to protect connections and	745	AEMP can use a proven protocol - TLS - to protect connections and
804	securely authenticate nodes.	746	securely authenticate nodes.
805		747
806	=item * The AEMP protocol is optimised for both text-based and binary	748	=item * The AEMP protocol is optimised for both text-based and binary
807	communications.	749	communications.
808		750
809	The AEMP protocol, unlike the Erlang protocol, supports both	751	The AEMP protocol, unlike the Erlang protocol, supports both programming
810	language-independent text-only protocols (good for debugging) and binary,	752	language independent text-only protocols (good for debugging) and binary,
811	language-specific serialisers (e.g. Storable).	753	language-specific serialisers (e.g. Storable). By default, unless TLS is
		754	used, the protocol is actually completely text-based.
812		755
813	It has also been carefully designed to be implementable in other languages	756	It has also been carefully designed to be implementable in other languages
814	with a minimum of work while gracefully degrading fucntionality to make the	757	with a minimum of work while gracefully degrading functionality to make the
815	protocol simple.	758	protocol simple.
816		759
817	=item * AEMP has more flexible monitoring options than Erlang.	760	=item * AEMP has more flexible monitoring options than Erlang.
818		761
819	In Erlang, you can chose to receive I<all> exit signals as messages	762	In Erlang, you can chose to receive I<all> exit signals as messages
…		…
822	Erlang, as one can choose between automatic kill, exit message or callback	765	Erlang, as one can choose between automatic kill, exit message or callback
823	on a per-process basis.	766	on a per-process basis.
824		767
825	=item * Erlang tries to hide remote/local connections, AEMP does not.	768	=item * Erlang tries to hide remote/local connections, AEMP does not.
826		769
827	Monitoring in Erlang is not an indicator of process death/crashes,	770	Monitoring in Erlang is not an indicator of process death/crashes, in the
828	as linking is (except linking is unreliable in Erlang).	771	same way as linking is (except linking is unreliable in Erlang).
829		772
830	In AEMP, you don't "look up" registered port names or send to named ports	773	In AEMP, you don't "look up" registered port names or send to named ports
831	that might or might not be persistent. Instead, you normally spawn a port	774	that might or might not be persistent. Instead, you normally spawn a port
832	on the remote node. The init function monitors the you, and you monitor	775	on the remote node. The init function monitors you, and you monitor the
833	the remote port. Since both monitors are local to the node, they are much	776	remote port. Since both monitors are local to the node, they are much more
834	more reliable.	777	reliable (no need for C<spawn_link>).
835		778
836	This also saves round-trips and avoids sending messages to the wrong port	779	This also saves round-trips and avoids sending messages to the wrong port
837	(hard to do in Erlang).	780	(hard to do in Erlang).
838		781
839	=back	782	=back
840		783
		784	=head1 RATIONALE
		785
		786	=over 4
		787
		788	=item Why strings for port and node IDs, why not objects?
		789
		790	We considered "objects", but found that the actual number of methods
		791	that can be called are quite low. Since port and node IDs travel over
		792	the network frequently, the serialising/deserialising would add lots of
		793	overhead, as well as having to keep a proxy object everywhere.
		794
		795	Strings can easily be printed, easily serialised etc. and need no special
		796	procedures to be "valid".
		797
		798	And as a result, a miniport consists of a single closure stored in a
		799	global hash - it can't become much cheaper.
		800
		801	=item Why favour JSON, why not a real serialising format such as Storable?
		802
		803	In fact, any AnyEvent::MP node will happily accept Storable as framing
		804	format, but currently there is no way to make a node use Storable by
		805	default (although all nodes will accept it).
		806
		807	The default framing protocol is JSON because a) JSON::XS is many times
		808	faster for small messages and b) most importantly, after years of
		809	experience we found that object serialisation is causing more problems
		810	than it solves: Just like function calls, objects simply do not travel
		811	easily over the network, mostly because they will always be a copy, so you
		812	always have to re-think your design.
		813
		814	Keeping your messages simple, concentrating on data structures rather than
		815	objects, will keep your messages clean, tidy and efficient.
		816
		817	=back
		818
841	=head1 SEE ALSO	819	=head1 SEE ALSO
		820
		821	L<AnyEvent::MP::Intro> - a gentle introduction.
		822
		823	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
		824
		825	L<AnyEvent::MP::Global> - network maintainance and port groups, to find
		826	your applications.
842		827
843	L<AnyEvent>.	828	L<AnyEvent>.
844		829
845	=head1 AUTHOR	830	=head1 AUTHOR
846		831

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC vs. Revision 1.71 by root, Sun Aug 30 19:52:56 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC vs.
Revision 1.71 by root, Sun Aug 30 19:52:56 2009 UTC