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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs.
Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent::MP - multi-processing/message-passing framework	3	AnyEvent::MP - erlang-style multi-processing/message-passing framework
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::MP;	7	use AnyEvent::MP;
8		8
9	$NODE # contains this node's noderef	9	$NODE # contains this node's node ID
10	NODE # returns this node's noderef	10	NODE # returns this node's node ID
11	NODE $port # returns the noderef of the port
12		11
13	$SELF # receiving/own port id in rcv callbacks	12	$SELF # receiving/own port id in rcv callbacks
14		13
15	# initialise the node so it can send/receive messages	14	# initialise the node so it can send/receive messages
16	initialise_node;	15	configure;
17		16
18	# ports are message endpoints	17	# ports are message destinations
19		18
20	# sending messages	19	# sending messages
21	snd $port, type => data...;	20	snd $port, type => data...;
22	snd $port, @msg;	21	snd $port, @msg;
23	snd @msg_with_first_element_being_a_port;	22	snd @msg_with_first_element_being_a_port;
24		23
25	# creating/using ports, the simple way	24	# creating/using ports, the simple way
26	my $simple_port = port { my @msg = @_; 0 };	25	my $simple_port = port { my @msg = @_ };
27		26
28	# creating/using ports, tagged message matching	27	# creating/using ports, tagged message matching
29	my $port = port;	28	my $port = port;
30	rcv $port, ping => sub { snd $_[0], "pong"; 0 };	29	rcv $port, ping => sub { snd $_[0], "pong" };
31	rcv $port, pong => sub { warn "pong received\n"; 0 };	30	rcv $port, pong => sub { warn "pong received\n" };
32		31
33	# create a port on another node	32	# create a port on another node
34	my $port = spawn $node, $initfunc, @initdata;	33	my $port = spawn $node, $initfunc, @initdata;
35		34
		35	# destroy a port again
		36	kil $port; # "normal" kill
		37	kil $port, my_error => "everything is broken"; # error kill
		38
36	# monitoring	39	# monitoring
37	mon $port, $cb->(@msg) # callback is invoked on death	40	mon $localport, $cb->(@msg) # callback is invoked on death
38	mon $port, $otherport # kill otherport on abnormal death	41	mon $localport, $otherport # kill otherport on abnormal death
39	mon $port, $otherport, @msg # send message on death	42	mon $localport, $otherport, @msg # send message on death
		43
		44	# temporarily execute code in port context
		45	peval $port, sub { die "kill the port!" };
		46
		47	# execute callbacks in $SELF port context
		48	my $timer = AE::timer 1, 0, psub {
		49	die "kill the port, delayed";
		50	};
40		51
41	=head1 CURRENT STATUS	52	=head1 CURRENT STATUS
42		53
		54	bin/aemp - stable.
43	AnyEvent::MP - stable API, should work	55	AnyEvent::MP - stable API, should work.
44	AnyEvent::MP::Intro - outdated	56	AnyEvent::MP::Intro - explains most concepts.
45	AnyEvent::MP::Kernel - mostly stable	57	AnyEvent::MP::Kernel - mostly stable API.
46	AnyEvent::MP::Global - mostly stable	58	AnyEvent::MP::Global - stable API.
47	AnyEvent::MP::Node - mostly stable, but internal anyways
48	AnyEvent::MP::Transport - mostly stable, but internal anyways
49
50	stay tuned.
51		59
52	=head1 DESCRIPTION	60	=head1 DESCRIPTION
53		61
54	This module (-family) implements a simple message passing framework.	62	This module (-family) implements a simple message passing framework.
55		63
57	on the same or other hosts, and you can supervise entities remotely.	65	on the same or other hosts, and you can supervise entities remotely.
58		66
59	For an introduction to this module family, see the L<AnyEvent::MP::Intro>	67	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
60	manual page and the examples under F<eg/>.	68	manual page and the examples under F<eg/>.
61		69
62	At the moment, this module family is a bit underdocumented.
63
64	=head1 CONCEPTS	70	=head1 CONCEPTS
65		71
66	=over 4	72	=over 4
67		73
68	=item port	74	=item port
69		75
70	A port is something you can send messages to (with the C<snd> function).	76	Not to be confused with a TCP port, a "port" is something you can send
		77	messages to (with the C<snd> function).
71		78
72	Ports allow you to register C<rcv> handlers that can match all or just	79	Ports allow you to register C<rcv> handlers that can match all or just
73	some messages. Messages send to ports will not be queued, regardless of	80	some messages. Messages send to ports will not be queued, regardless of
74	anything was listening for them or not.	81	anything was listening for them or not.
75		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
76	=item port ID - C<nodeid#portname>	85	=item port ID - C<nodeid#portname>
77		86
78	A port ID is the concatenation of a node ID, a hash-mark (C<#>) as	87	A port ID is the concatenation of a node ID, a hash-mark (C<#>) as
79	separator, and a port name (a printable string of unspecified format).	88	separator, and a port name (a printable string of unspecified format).
80		89
…		…
84	which enables nodes to manage each other remotely, and to create new	93	which enables nodes to manage each other remotely, and to create new
85	ports.	94	ports.
86		95
87	Nodes are either public (have one or more listening ports) or private	96	Nodes are either public (have one or more listening ports) or private
88	(no listening ports). Private nodes cannot talk to other private nodes	97	(no listening ports). Private nodes cannot talk to other private nodes
89	currently.	98	currently, but all nodes can talk to public nodes.
90		99
		100	Nodes is represented by (printable) strings called "node IDs".
		101
91	=item node ID - C<[a-za-Z0-9_\-.:]+>	102	=item node ID - C<[A-Za-z0-9_\-.:]*>
92		103
93	A node ID is a string that uniquely identifies the node within a	104	A node ID is a string that uniquely identifies the node within a
94	network. Depending on the configuration used, node IDs can look like a	105	network. Depending on the configuration used, node IDs can look like a
95	hostname, a hostname and a port, or a random string. AnyEvent::MP itself	106	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
96	doesn't interpret node IDs in any way.	107	doesn't interpret node IDs in any way except to uniquely identify a node.
97		108
98	=item binds - C<ip:port>	109	=item binds - C<ip:port>
99		110
100	Nodes can only talk to each other by creating some kind of connection to	111	Nodes can only talk to each other by creating some kind of connection to
101	each other. To do this, nodes should listen on one or more local transport	112	each other. To do this, nodes should listen on one or more local transport
		113	endpoints - binds.
		114
102	endpoints - binds. Currently, only standard C<ip:port> specifications can	115	Currently, only standard C<ip:port> specifications can be used, which
103	be used, which specify TCP ports to listen on.	116	specify TCP ports to listen on. So a bind is basically just a tcp socket
		117	in listening mode thta accepts conenctions form other nodes.
104		118
		119	=item seed nodes
		120
		121	When a node starts, it knows nothing about the network it is in - it
		122	needs to connect to at least one other node that is already in the
		123	network. These other nodes are called "seed nodes".
		124
		125	Seed nodes themselves are not special - they are seed nodes only because
		126	some other node I<uses> them as such, but any node can be used as seed
		127	node for other nodes, and eahc node cna use a different set of seed nodes.
		128
		129	In addition to discovering the network, seed nodes are also used to
		130	maintain the network - all nodes using the same seed node form are part of
		131	the same network. If a network is split into multiple subnets because e.g.
		132	the network link between the parts goes down, then using the same seed
		133	nodes for all nodes ensures that eventually the subnets get merged again.
		134
		135	Seed nodes are expected to be long-running, and at least one seed node
		136	should always be available. They should also be relatively responsive - a
		137	seed node that blocks for long periods will slow down everybody else.
		138
		139	For small networks, it's best if every node uses the same set of seed
		140	nodes. For large networks, it can be useful to specify "regional" seed
		141	nodes for most nodes in an area, and use all seed nodes as seed nodes for
		142	each other. What's important is that all seed nodes connections form a
		143	complete graph, so that the network cannot split into separate subnets
		144	forever.
		145
		146	Seed nodes are represented by seed IDs.
		147
105	=item seeds - C<host:port>	148	=item seed IDs - C<host:port>
106		149
107	When a node starts, it knows nothing about the network. To teach the node	150	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
108	about the network it first has to contact some other node within the	151	TCP port) of nodes that should be used as seed nodes.
109	network. This node is called a seed.
110		152
111	Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes	153	=item global nodes
112	are expected to be long-running, and at least one of those should always
113	be available. When nodes run out of connections (e.g. due to a network
114	error), they try to re-establish connections to some seednodes again to
115	join the network.
116		154
117	Apart from being sued for seeding, seednodes are not special in any way -	155	An AEMP network needs a discovery service - nodes need to know how to
118	every public node can be a seednode.	156	connect to other nodes they only know by name. In addition, AEMP offers a
		157	distributed "group database", which maps group names to a list of strings
		158	- for example, to register worker ports.
		159
		160	A network needs at least one global node to work, and allows every node to
		161	be a global node.
		162
		163	Any node that loads the L<AnyEvent::MP::Global> module becomes a global
		164	node and tries to keep connections to all other nodes. So while it can
		165	make sense to make every node "global" in small networks, it usually makes
		166	sense to only make seed nodes into global nodes in large networks (nodes
		167	keep connections to seed nodes and global nodes, so makign them the same
		168	reduces overhead).
119		169
120	=back	170	=back
121		171
122	=head1 VARIABLES/FUNCTIONS	172	=head1 VARIABLES/FUNCTIONS
123		173
…		…
125		175
126	=cut	176	=cut
127		177
128	package AnyEvent::MP;	178	package AnyEvent::MP;
129		179
		180	use AnyEvent::MP::Config ();
130	use AnyEvent::MP::Kernel;	181	use AnyEvent::MP::Kernel;
		182	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
131		183
132	use common::sense;	184	use common::sense;
133		185
134	use Carp ();	186	use Carp ();
135		187
136	use AE ();	188	use AE ();
137		189
138	use base "Exporter";	190	use base "Exporter";
139		191
140	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	192	our $VERSION = $AnyEvent::MP::Config::VERSION;
141		193
142	our @EXPORT = qw(	194	our @EXPORT = qw(
143	NODE $NODE *SELF node_of after	195	NODE $NODE *SELF node_of after
144	initialise_node	196	configure
145	snd rcv mon mon_guard kil reg psub spawn	197	snd rcv mon mon_guard kil psub peval spawn cal
146	port	198	port
147	);	199	);
148		200
149	our $SELF;	201	our $SELF;
150		202
…		…
156		208
157	=item $thisnode = NODE / $NODE	209	=item $thisnode = NODE / $NODE
158		210
159	The C<NODE> function returns, and the C<$NODE> variable contains, the node	211	The C<NODE> function returns, and the C<$NODE> variable contains, the node
160	ID of the node running in the current process. This value is initialised by	212	ID of the node running in the current process. This value is initialised by
161	a call to C<initialise_node>.	213	a call to C<configure>.
162		214
163	=item $nodeid = node_of $port	215	=item $nodeid = node_of $port
164		216
165	Extracts and returns the node ID from a port ID or a node ID.	217	Extracts and returns the node ID from a port ID or a node ID.
166		218
167	=item initialise_node $profile_name, key => value...	219	=item configure $profile, key => value...
		220
		221	=item configure key => value...
168		222
169	Before a node can talk to other nodes on the network (i.e. enter	223	Before a node can talk to other nodes on the network (i.e. enter
170	"distributed mode") it has to initialise itself - the minimum a node needs	224	"distributed mode") it has to configure itself - the minimum a node needs
171	to know is its own name, and optionally it should know the addresses of	225	to know is its own name, and optionally it should know the addresses of
172	some other nodes in the network to discover other nodes.	226	some other nodes in the network to discover other nodes.
173		227
174	This function initialises a node - it must be called exactly once (or	228	This function configures a node - it must be called exactly once (or
175	never) before calling other AnyEvent::MP functions.	229	never) before calling other AnyEvent::MP functions.
176		230
177	The first argument is a profile name. If it is C<undef> or missing, then	231	The key/value pairs are basically the same ones as documented for the
178	the current nodename will be used instead (i.e. F<uname -n>).	232	F<aemp> command line utility (sans the set/del prefix), with two additions:
179		233
		234	=over 4
		235
		236	=item norc => $boolean (default false)
		237
		238	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
		239	be consulted - all configuraiton options must be specified in the
		240	C<configure> call.
		241
		242	=item force => $boolean (default false)
		243
		244	IF true, then the values specified in the C<configure> will take
		245	precedence over any values configured via the rc file. The default is for
		246	the rc file to override any options specified in the program.
		247
		248	=back
		249
		250	=over 4
		251
		252	=item step 1, gathering configuration from profiles
		253
180	The function first looks up the profile in the aemp configuration (see the	254	The function first looks up a profile in the aemp configuration (see the
181	L<aemp> commandline utility). the profile is calculated as follows:	255	L<aemp> commandline utility). The profile name can be specified via the
		256	named C<profile> parameter or can simply be the first parameter). If it is
		257	missing, then the nodename (F<uname -n>) will be used as profile name.
182		258
183	First, all remaining key => value pairs will be used. Then they will be	259	The profile data is then gathered as follows:
184	overwritten by any values specified in the global default configuration	260
185	(see the F<aemp> utility), then the chain of profiles selected, if	261	First, all remaining key => value pairs (all of which are conveniently
		262	undocumented at the moment) will be interpreted as configuration
		263	data. Then they will be overwritten by any values specified in the global
		264	default configuration (see the F<aemp> utility), then the chain of
		265	profiles chosen by the profile name (and any C<parent> attributes).
		266
186	any. That means that the values specified in the profile have highest	267	That means that the values specified in the profile have highest priority
187	priority and the values specified via C<initialise_node> have lowest	268	and the values specified directly via C<configure> have lowest priority,
188	priority.	269	and can only be used to specify defaults.
189		270
190	If the profile specifies a node ID, then this will become the node ID of	271	If the profile specifies a node ID, then this will become the node ID of
191	this process. If not, then the profile name will be used as node ID. The	272	this process. If not, then the profile name will be used as node ID. The
192	special node ID of C<anon/> will be replaced by a random node ID.	273	special node ID of C<anon/> will be replaced by a random node ID.
		274
		275	=item step 2, bind listener sockets
193		276
194	The next step is to look up the binds in the profile, followed by binding	277	The next step is to look up the binds in the profile, followed by binding
195	aemp protocol listeners on all binds specified (it is possible and valid	278	aemp protocol listeners on all binds specified (it is possible and valid
196	to have no binds, meaning that the node cannot be contacted form the	279	to have no binds, meaning that the node cannot be contacted form the
197	outside. This means the node cannot talk to other nodes that also have no	280	outside. This means the node cannot talk to other nodes that also have no
198	binds, but it can still talk to all "normal" nodes).	281	binds, but it can still talk to all "normal" nodes).
199		282
200	If the profile does not specify a binds list, then the node ID will be	283	If the profile does not specify a binds list, then a default of C<*> is
201	treated as if it were of the form C<host:port>, which will be resolved and	284	used, meaning the node will bind on a dynamically-assigned port on every
202	used as binds list.	285	local IP address it finds.
203		286
		287	=item step 3, connect to seed nodes
		288
204	Lastly, the seeds list from the profile is passed to the	289	As the last step, the seed ID list from the profile is passed to the
205	L<AnyEvent::MP::Global> module, which will then use it to keep	290	L<AnyEvent::MP::Global> module, which will then use it to keep
206	connectivity with at least on of those seed nodes at any point in time.	291	connectivity with at least one node at any point in time.
207		292
208	Example: become a distributed node listening on the guessed noderef, or	293	=back
209	the one specified via C<aemp> for the current node. This should be the	294
		295	Example: become a distributed node using the local node name as profile.
210	most common form of invocation for "daemon"-type nodes.	296	This should be the most common form of invocation for "daemon"-type nodes.
211		297
212	initialise_node;	298	configure
213		299
214	Example: become an anonymous node. This form is often used for commandline	300	Example: become an anonymous node. This form is often used for commandline
215	clients.	301	clients.
216		302
217	initialise_node "anon/";	303	configure nodeid => "anon/";
218		304
219	Example: become a distributed node. If there is no profile of the given	305	Example: configure a node using a profile called seed, which is suitable
220	name, or no binds list was specified, resolve C<localhost:4044> and bind	306	for a seed node as it binds on all local addresses on a fixed port (4040,
221	on the resulting addresses.	307	customary for aemp).
222		308
223	initialise_node "localhost:4044";	309	# use the aemp commandline utility
		310	# aemp profile seed nodeid anon/ binds '*:4040'
		311
		312	# then use it
		313	configure profile => "seed";
		314
		315	# or simply use aemp from the shell again:
		316	# aemp run profile seed
		317
		318	# or provide a nicer-to-remember nodeid
		319	# aemp run profile seed nodeid "$(hostname)"
224		320
225	=item $SELF	321	=item $SELF
226		322
227	Contains the current port id while executing C<rcv> callbacks or C<psub>	323	Contains the current port id while executing C<rcv> callbacks or C<psub>
228	blocks.	324	blocks.
…		…
289	sub _kilme {	385	sub _kilme {
290	die "received message on port without callback";	386	die "received message on port without callback";
291	}	387	}
292		388
293	sub port(;&) {	389	sub port(;&) {
294	my $id = "$UNIQ." . $ID++;	390	my $id = "$UNIQ." . ++$ID;
295	my $port = "$NODE#$id";	391	my $port = "$NODE#$id";
296		392
297	rcv $port, shift \|\| \&_kilme;	393	rcv $port, shift \|\| \&_kilme;
298		394
299	$port	395	$port
…		…
338	msg1 => sub { ... },	434	msg1 => sub { ... },
339	...	435	...
340	;	436	;
341		437
342	Example: temporarily register a rcv callback for a tag matching some port	438	Example: temporarily register a rcv callback for a tag matching some port
343	(e.g. for a rpc reply) and unregister it after a message was received.	439	(e.g. for an rpc reply) and unregister it after a message was received.
344		440
345	rcv $port, $otherport => sub {	441	rcv $port, $otherport => sub {
346	my @reply = @_;	442	my @reply = @_;
347		443
348	rcv $SELF, $otherport;	444	rcv $SELF, $otherport;
…		…
350		446
351	=cut	447	=cut
352		448
353	sub rcv($@) {	449	sub rcv($@) {
354	my $port = shift;	450	my $port = shift;
355	my ($noderef, $portid) = split /#/, $port, 2;	451	my ($nodeid, $portid) = split /#/, $port, 2;
356		452
357	$NODE{$noderef} == $NODE{""}	453	$NODE{$nodeid} == $NODE{""}
358	or Carp::croak "$port: rcv can only be called on local ports, caught";	454	or Carp::croak "$port: rcv can only be called on local ports, caught";
359		455
360	while (@_) {	456	while (@_) {
361	if (ref $_[0]) {	457	if (ref $_[0]) {
362	if (my $self = $PORT_DATA{$portid}) {	458	if (my $self = $PORT_DATA{$portid}) {
363	"AnyEvent::MP::Port" eq ref $self	459	"AnyEvent::MP::Port" eq ref $self
364	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	460	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
365		461
366	$self->[2] = shift;	462	$self->[0] = shift;
367	} else {	463	} else {
368	my $cb = shift;	464	my $cb = shift;
369	$PORT{$portid} = sub {	465	$PORT{$portid} = sub {
370	local $SELF = $port;	466	local $SELF = $port;
371	eval { &$cb }; _self_die if $@;	467	eval { &$cb }; _self_die if $@;
372	};	468	};
373	}	469	}
374	} elsif (defined $_[0]) {	470	} elsif (defined $_[0]) {
375	my $self = $PORT_DATA{$portid} \|\|= do {	471	my $self = $PORT_DATA{$portid} \|\|= do {
376	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	472	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
377		473
378	$PORT{$portid} = sub {	474	$PORT{$portid} = sub {
379	local $SELF = $port;	475	local $SELF = $port;
380		476
381	if (my $cb = $self->[1]{$_[0]}) {	477	if (my $cb = $self->[1]{$_[0]}) {
…		…
403	}	499	}
404		500
405	$port	501	$port
406	}	502	}
407		503
		504	=item peval $port, $coderef[, @args]
		505
		506	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		507	when the code throews an exception the C<$port> will be killed.
		508
		509	Any remaining args will be passed to the callback. Any return values will
		510	be returned to the caller.
		511
		512	This is useful when you temporarily want to execute code in the context of
		513	a port.
		514
		515	Example: create a port and run some initialisation code in it's context.
		516
		517	my $port = port { ... };
		518
		519	peval $port, sub {
		520	init
		521	or die "unable to init";
		522	};
		523
		524	=cut
		525
		526	sub peval($$) {
		527	local $SELF = shift;
		528	my $cb = shift;
		529
		530	if (wantarray) {
		531	my @res = eval { &$cb };
		532	_self_die if $@;
		533	@res
		534	} else {
		535	my $res = eval { &$cb };
		536	_self_die if $@;
		537	$res
		538	}
		539	}
		540
408	=item $closure = psub { BLOCK }	541	=item $closure = psub { BLOCK }
409		542
410	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	543	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
411	closure is executed, sets up the environment in the same way as in C<rcv>	544	closure is executed, sets up the environment in the same way as in C<rcv>
412	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.	545	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		546
		547	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		548	BLOCK }, @_ } >>.
413		549
414	This is useful when you register callbacks from C<rcv> callbacks:	550	This is useful when you register callbacks from C<rcv> callbacks:
415		551
416	rcv delayed_reply => sub {	552	rcv delayed_reply => sub {
417	my ($delay, @reply) = @_;	553	my ($delay, @reply) = @_;
…		…
453		589
454	Monitor the given port and do something when the port is killed or	590	Monitor the given port and do something when the port is killed or
455	messages to it were lost, and optionally return a guard that can be used	591	messages to it were lost, and optionally return a guard that can be used
456	to stop monitoring again.	592	to stop monitoring again.
457		593
		594	In the first form (callback), the callback is simply called with any
		595	number of C<@reason> elements (no @reason means that the port was deleted
		596	"normally"). Note also that I<< the callback B<must> never die >>, so use
		597	C<eval> if unsure.
		598
		599	In the second form (another port given), the other port (C<$rcvport>)
		600	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
		601	"normal" kils nothing happens, while under all other conditions, the other
		602	port is killed with the same reason.
		603
		604	The third form (kill self) is the same as the second form, except that
		605	C<$rvport> defaults to C<$SELF>.
		606
		607	In the last form (message), a message of the form C<@msg, @reason> will be
		608	C<snd>.
		609
		610	Monitoring-actions are one-shot: once messages are lost (and a monitoring
		611	alert was raised), they are removed and will not trigger again.
		612
		613	As a rule of thumb, monitoring requests should always monitor a port from
		614	a local port (or callback). The reason is that kill messages might get
		615	lost, just like any other message. Another less obvious reason is that
		616	even monitoring requests can get lost (for example, when the connection
		617	to the other node goes down permanently). When monitoring a port locally
		618	these problems do not exist.
		619
458	C<mon> effectively guarantees that, in the absence of hardware failures,	620	C<mon> effectively guarantees that, in the absence of hardware failures,
459	after starting the monitor, either all messages sent to the port will	621	after starting the monitor, either all messages sent to the port will
460	arrive, or the monitoring action will be invoked after possible message	622	arrive, or the monitoring action will be invoked after possible message
461	loss has been detected. No messages will be lost "in between" (after	623	loss has been detected. No messages will be lost "in between" (after
462	the first lost message no further messages will be received by the	624	the first lost message no further messages will be received by the
463	port). After the monitoring action was invoked, further messages might get	625	port). After the monitoring action was invoked, further messages might get
464	delivered again.	626	delivered again.
465		627
466	Note that monitoring-actions are one-shot: once messages are lost (and a	628	Inter-host-connection timeouts and monitoring depend on the transport
467	monitoring alert was raised), they are removed and will not trigger again.	629	used. The only transport currently implemented is TCP, and AnyEvent::MP
		630	relies on TCP to detect node-downs (this can take 10-15 minutes on a
		631	non-idle connection, and usually around two hours for idle connections).
468		632
469	In the first form (callback), the callback is simply called with any	633	This means that monitoring is good for program errors and cleaning up
470	number of C<@reason> elements (no @reason means that the port was deleted	634	stuff eventually, but they are no replacement for a timeout when you need
471	"normally"). Note also that I<< the callback B<must> never die >>, so use	635	to ensure some maximum latency.
472	C<eval> if unsure.
473
474	In the second form (another port given), the other port (C<$rcvport>)
475	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
476	"normal" kils nothing happens, while under all other conditions, the other
477	port is killed with the same reason.
478
479	The third form (kill self) is the same as the second form, except that
480	C<$rvport> defaults to C<$SELF>.
481
482	In the last form (message), a message of the form C<@msg, @reason> will be
483	C<snd>.
484
485	As a rule of thumb, monitoring requests should always monitor a port from
486	a local port (or callback). The reason is that kill messages might get
487	lost, just like any other message. Another less obvious reason is that
488	even monitoring requests can get lost (for exmaple, when the connection
489	to the other node goes down permanently). When monitoring a port locally
490	these problems do not exist.
491		636
492	Example: call a given callback when C<$port> is killed.	637	Example: call a given callback when C<$port> is killed.
493		638
494	mon $port, sub { warn "port died because of <@_>\n" };	639	mon $port, sub { warn "port died because of <@_>\n" };
495		640
…		…
502	mon $port, $self => "restart";	647	mon $port, $self => "restart";
503		648
504	=cut	649	=cut
505		650
506	sub mon {	651	sub mon {
507	my ($noderef, $port) = split /#/, shift, 2;	652	my ($nodeid, $port) = split /#/, shift, 2;
508		653
509	my $node = $NODE{$noderef} \|\| add_node $noderef;	654	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
510		655
511	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';	656	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
512		657
513	unless (ref $cb) {	658	unless (ref $cb) {
514	if (@_) {	659	if (@_) {
…		…
523	}	668	}
524		669
525	$node->monitor ($port, $cb);	670	$node->monitor ($port, $cb);
526		671
527	defined wantarray	672	defined wantarray
528	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	673	and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
529	}	674	}
530		675
531	=item $guard = mon_guard $port, $ref, $ref...	676	=item $guard = mon_guard $port, $ref, $ref...
532		677
533	Monitors the given C<$port> and keeps the passed references. When the port	678	Monitors the given C<$port> and keeps the passed references. When the port
…		…
556		701
557	=item kil $port[, @reason]	702	=item kil $port[, @reason]
558		703
559	Kill the specified port with the given C<@reason>.	704	Kill the specified port with the given C<@reason>.
560		705
561	If no C<@reason> is specified, then the port is killed "normally" (ports	706	If no C<@reason> is specified, then the port is killed "normally" -
562	monitoring other ports will not necessarily die because a port dies	707	monitor callback will be invoked, but the kil will not cause linked ports
563	"normally").	708	(C<mon $mport, $lport> form) to get killed.
564		709
565	Otherwise, linked ports get killed with the same reason (second form of	710	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
566	C<mon>, see above).	711	form) get killed with the same reason.
567		712
568	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	713	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
569	will be reported as reason C<< die => $@ >>.	714	will be reported as reason C<< die => $@ >>.
570		715
571	Transport/communication errors are reported as C<< transport_error =>	716	Transport/communication errors are reported as C<< transport_error =>
…		…
590	the package, then the package above the package and so on (e.g.	735	the package, then the package above the package and so on (e.g.
591	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	736	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
592	exists or it runs out of package names.	737	exists or it runs out of package names.
593		738
594	The init function is then called with the newly-created port as context	739	The init function is then called with the newly-created port as context
595	object (C<$SELF>) and the C<@initdata> values as arguments.	740	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		741	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		742	the port might not get created.
596		743
597	A common idiom is to pass a local port, immediately monitor the spawned	744	A common idiom is to pass a local port, immediately monitor the spawned
598	port, and in the remote init function, immediately monitor the passed	745	port, and in the remote init function, immediately monitor the passed
599	local port. This two-way monitoring ensures that both ports get cleaned up	746	local port. This two-way monitoring ensures that both ports get cleaned up
600	when there is a problem.	747	when there is a problem.
601		748
		749	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		750	caller before C<spawn> returns (by delaying invocation when spawn is
		751	called for the local node).
		752
602	Example: spawn a chat server port on C<$othernode>.	753	Example: spawn a chat server port on C<$othernode>.
603		754
604	# this node, executed from within a port context:	755	# this node, executed from within a port context:
605	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	756	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
606	mon $server;	757	mon $server;
…		…
620		771
621	sub _spawn {	772	sub _spawn {
622	my $port = shift;	773	my $port = shift;
623	my $init = shift;	774	my $init = shift;
624		775
		776	# rcv will create the actual port
625	local $SELF = "$NODE#$port";	777	local $SELF = "$NODE#$port";
626	eval {	778	eval {
627	&{ load_func $init }	779	&{ load_func $init }
628	};	780	};
629	_self_die if $@;	781	_self_die if $@;
630	}	782	}
631		783
632	sub spawn(@) {	784	sub spawn(@) {
633	my ($noderef, undef) = split /#/, shift, 2;	785	my ($nodeid, undef) = split /#/, shift, 2;
634		786
635	my $id = "$RUNIQ." . $ID++;	787	my $id = "$RUNIQ." . ++$ID;
636		788
637	$_[0] =~ /::/	789	$_[0] =~ /::/
638	or Carp::croak "spawn init function must be a fully-qualified name, caught";	790	or Carp::croak "spawn init function must be a fully-qualified name, caught";
639		791
640	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;	792	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
641		793
642	"$noderef#$id"	794	"$nodeid#$id"
643	}	795	}
		796
644		797
645	=item after $timeout, @msg	798	=item after $timeout, @msg
646		799
647	=item after $timeout, $callback	800	=item after $timeout, $callback
648		801
…		…
664	? $action[0]()	817	? $action[0]()
665	: snd @action;	818	: snd @action;
666	};	819	};
667	}	820	}
668		821
		822	=item cal $port, @msg, $callback[, $timeout]
		823
		824	A simple form of RPC - sends a message to the given C<$port> with the
		825	given contents (C<@msg>), but adds a reply port to the message.
		826
		827	The reply port is created temporarily just for the purpose of receiving
		828	the reply, and will be C<kil>ed when no longer needed.
		829
		830	A reply message sent to the port is passed to the C<$callback> as-is.
		831
		832	If an optional time-out (in seconds) is given and it is not C<undef>,
		833	then the callback will be called without any arguments after the time-out
		834	elapsed and the port is C<kil>ed.
		835
		836	If no time-out is given (or it is C<undef>), then the local port will
		837	monitor the remote port instead, so it eventually gets cleaned-up.
		838
		839	Currently this function returns the temporary port, but this "feature"
		840	might go in future versions unless you can make a convincing case that
		841	this is indeed useful for something.
		842
		843	=cut
		844
		845	sub cal(@) {
		846	my $timeout = ref $_[-1] ? undef : pop;
		847	my $cb = pop;
		848
		849	my $port = port {
		850	undef $timeout;
		851	kil $SELF;
		852	&$cb;
		853	};
		854
		855	if (defined $timeout) {
		856	$timeout = AE::timer $timeout, 0, sub {
		857	undef $timeout;
		858	kil $port;
		859	$cb->();
		860	};
		861	} else {
		862	mon $_[0], sub {
		863	kil $port;
		864	$cb->();
		865	};
		866	}
		867
		868	push @_, $port;
		869	&snd;
		870
		871	$port
		872	}
		873
669	=back	874	=back
670		875
671	=head1 AnyEvent::MP vs. Distributed Erlang	876	=head1 AnyEvent::MP vs. Distributed Erlang
672		877
673	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	878	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
674	== aemp node, Erlang process == aemp port), so many of the documents and	879	== aemp node, Erlang process == aemp port), so many of the documents and
675	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	880	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
676	sample:	881	sample:
677		882
678	http://www.Erlang.se/doc/programming_rules.shtml	883	http://www.erlang.se/doc/programming_rules.shtml
679	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	884	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
680	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6	885	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
681	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	886	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
682		887
683	Despite the similarities, there are also some important differences:	888	Despite the similarities, there are also some important differences:
684		889
685	=over 4	890	=over 4
686		891
687	=item * Node IDs are arbitrary strings in AEMP.	892	=item * Node IDs are arbitrary strings in AEMP.
688		893
689	Erlang relies on special naming and DNS to work everywhere in the same	894	Erlang relies on special naming and DNS to work everywhere in the same
690	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by	895	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
691	configuraiton or DNS), but will otherwise discover other odes itself.	896	configuration or DNS), and possibly the addresses of some seed nodes, but
		897	will otherwise discover other nodes (and their IDs) itself.
692		898
693	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	899	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
694	uses "local ports are like remote ports".	900	uses "local ports are like remote ports".
695		901
696	The failure modes for local ports are quite different (runtime errors	902	The failure modes for local ports are quite different (runtime errors
…		…
705	ports being the special case/exception, where transport errors cannot	911	ports being the special case/exception, where transport errors cannot
706	occur.	912	occur.
707		913
708	=item * Erlang uses processes and a mailbox, AEMP does not queue.	914	=item * Erlang uses processes and a mailbox, AEMP does not queue.
709		915
710	Erlang uses processes that selectively receive messages, and therefore	916	Erlang uses processes that selectively receive messages out of order, and
711	needs a queue. AEMP is event based, queuing messages would serve no	917	therefore needs a queue. AEMP is event based, queuing messages would serve
712	useful purpose. For the same reason the pattern-matching abilities of	918	no useful purpose. For the same reason the pattern-matching abilities
713	AnyEvent::MP are more limited, as there is little need to be able to	919	of AnyEvent::MP are more limited, as there is little need to be able to
714	filter messages without dequeing them.	920	filter messages without dequeuing them.
715		921
716	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	922	This is not a philosophical difference, but simply stems from AnyEvent::MP
		923	being event-based, while Erlang is process-based.
		924
		925	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		926	top of AEMP and Coro threads.
717		927
718	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	928	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
719		929
720	Sending messages in Erlang is synchronous and blocks the process (and	930	Sending messages in Erlang is synchronous and blocks the process until
		931	a conenction has been established and the message sent (and so does not
721	so does not need a queue that can overflow). AEMP sends are immediate,	932	need a queue that can overflow). AEMP sends return immediately, connection
722	connection establishment is handled in the background.	933	establishment is handled in the background.
723		934
724	=item * Erlang suffers from silent message loss, AEMP does not.	935	=item * Erlang suffers from silent message loss, AEMP does not.
725		936
726	Erlang makes few guarantees on messages delivery - messages can get lost	937	Erlang implements few guarantees on messages delivery - messages can get
727	without any of the processes realising it (i.e. you send messages a, b,	938	lost without any of the processes realising it (i.e. you send messages a,
728	and c, and the other side only receives messages a and c).	939	b, and c, and the other side only receives messages a and c).
729		940
730	AEMP guarantees correct ordering, and the guarantee that after one message	941	AEMP guarantees (modulo hardware errors) correct ordering, and the
731	is lost, all following ones sent to the same port are lost as well, until	942	guarantee that after one message is lost, all following ones sent to the
732	monitoring raises an error, so there are no silent "holes" in the message	943	same port are lost as well, until monitoring raises an error, so there are
733	sequence.	944	no silent "holes" in the message sequence.
		945
		946	If you want your software to be very reliable, you have to cope with
		947	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		948	simply tries to work better in common error cases, such as when a network
		949	link goes down.
734		950
735	=item * Erlang can send messages to the wrong port, AEMP does not.	951	=item * Erlang can send messages to the wrong port, AEMP does not.
736		952
737	In Erlang it is quite likely that a node that restarts reuses a process ID	953	In Erlang it is quite likely that a node that restarts reuses an Erlang
738	known to other nodes for a completely different process, causing messages	954	process ID known to other nodes for a completely different process,
739	destined for that process to end up in an unrelated process.	955	causing messages destined for that process to end up in an unrelated
		956	process.
740		957
741	AEMP never reuses port IDs, so old messages or old port IDs floating	958	AEMP does not reuse port IDs, so old messages or old port IDs floating
742	around in the network will not be sent to an unrelated port.	959	around in the network will not be sent to an unrelated port.
743		960
744	=item * Erlang uses unprotected connections, AEMP uses secure	961	=item * Erlang uses unprotected connections, AEMP uses secure
745	authentication and can use TLS.	962	authentication and can use TLS.
746		963
…		…
749		966
750	=item * The AEMP protocol is optimised for both text-based and binary	967	=item * The AEMP protocol is optimised for both text-based and binary
751	communications.	968	communications.
752		969
753	The AEMP protocol, unlike the Erlang protocol, supports both programming	970	The AEMP protocol, unlike the Erlang protocol, supports both programming
754	language independent text-only protocols (good for debugging) and binary,	971	language independent text-only protocols (good for debugging), and binary,
755	language-specific serialisers (e.g. Storable). By default, unless TLS is	972	language-specific serialisers (e.g. Storable). By default, unless TLS is
756	used, the protocol is actually completely text-based.	973	used, the protocol is actually completely text-based.
757		974
758	It has also been carefully designed to be implementable in other languages	975	It has also been carefully designed to be implementable in other languages
759	with a minimum of work while gracefully degrading functionality to make the	976	with a minimum of work while gracefully degrading functionality to make the
760	protocol simple.	977	protocol simple.
761		978
762	=item * AEMP has more flexible monitoring options than Erlang.	979	=item * AEMP has more flexible monitoring options than Erlang.
763		980
764	In Erlang, you can chose to receive I<all> exit signals as messages	981	In Erlang, you can chose to receive I<all> exit signals as messages or
765	or I<none>, there is no in-between, so monitoring single processes is	982	I<none>, there is no in-between, so monitoring single Erlang processes is
766	difficult to implement. Monitoring in AEMP is more flexible than in	983	difficult to implement.
767	Erlang, as one can choose between automatic kill, exit message or callback	984
768	on a per-process basis.	985	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		986	between automatic kill, exit message or callback on a per-port basis.
769		987
770	=item * Erlang tries to hide remote/local connections, AEMP does not.	988	=item * Erlang tries to hide remote/local connections, AEMP does not.
771		989
772	Monitoring in Erlang is not an indicator of process death/crashes, in the	990	Monitoring in Erlang is not an indicator of process death/crashes, in the
773	same way as linking is (except linking is unreliable in Erlang).	991	same way as linking is (except linking is unreliable in Erlang).
…		…
795	overhead, as well as having to keep a proxy object everywhere.	1013	overhead, as well as having to keep a proxy object everywhere.
796		1014
797	Strings can easily be printed, easily serialised etc. and need no special	1015	Strings can easily be printed, easily serialised etc. and need no special
798	procedures to be "valid".	1016	procedures to be "valid".
799		1017
800	And as a result, a miniport consists of a single closure stored in a	1018	And as a result, a port with just a default receiver consists of a single
801	global hash - it can't become much cheaper.	1019	code reference stored in a global hash - it can't become much cheaper.
802		1020
803	=item Why favour JSON, why not a real serialising format such as Storable?	1021	=item Why favour JSON, why not a real serialising format such as Storable?
804		1022
805	In fact, any AnyEvent::MP node will happily accept Storable as framing	1023	In fact, any AnyEvent::MP node will happily accept Storable as framing
806	format, but currently there is no way to make a node use Storable by	1024	format, but currently there is no way to make a node use Storable by
…		…
822		1040
823	L<AnyEvent::MP::Intro> - a gentle introduction.	1041	L<AnyEvent::MP::Intro> - a gentle introduction.
824		1042
825	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1043	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
826		1044
827	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1045	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
828	your applications.	1046	your applications.
		1047
		1048	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
		1049
		1050	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
		1051	all nodes.
829		1052
830	L<AnyEvent>.	1053	L<AnyEvent>.
831		1054
832	=head1 AUTHOR	1055	=head1 AUTHOR
833		1056

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs. Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs.
Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC