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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.50 by root, Fri Aug 14 14:01:05 2009 UTC vs.
Revision 1.78 by root, Thu Sep 3 20:16:36 2009 UTC

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

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.50 by root, Fri Aug 14 14:01:05 2009 UTC vs. Revision 1.78 by root, Thu Sep 3 20:16:36 2009 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.50 by root, Fri Aug 14 14:01:05 2009 UTC vs.
Revision 1.78 by root, Thu Sep 3 20:16:36 2009 UTC