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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs.
Revision 1.127 by root, Sat Mar 3 20:35:10 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<#>)
79	separator, and a port name (a printable string of unspecified format).	88	as separator, and a port name (a printable string of unspecified
		89	format created by AnyEvent::MP).
80		90
81	=item node	91	=item node
82		92
83	A node is a single process containing at least one port - the node port,	93	A node is a single process containing at least one port - the node port,
84	which enables nodes to manage each other remotely, and to create new	94	which enables nodes to manage each other remotely, and to create new
85	ports.	95	ports.
86		96
87	Nodes are either public (have one or more listening ports) or private	97	Nodes are either public (have one or more listening ports) or private
88	(no listening ports). Private nodes cannot talk to other private nodes	98	(no listening ports). Private nodes cannot talk to other private nodes
89	currently.	99	currently, but all nodes can talk to public nodes.
90		100
		101	Nodes is represented by (printable) strings called "node IDs".
		102
91	=item node ID - C<[a-za-Z0-9_\-.:]+>	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
92		104
93	A node ID is a string that uniquely identifies the node within a	105	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	106	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	107	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
96	doesn't interpret node IDs in any way.	108	doesn't interpret node IDs in any way except to uniquely identify a node.
97		109
98	=item binds - C<ip:port>	110	=item binds - C<ip:port>
99		111
100	Nodes can only talk to each other by creating some kind of connection to	112	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	113	each other. To do this, nodes should listen on one or more local transport
		114	endpoints - binds.
		115
102	endpoints - binds. Currently, only standard C<ip:port> specifications can	116	Currently, only standard C<ip:port> specifications can be used, which
103	be used, which specify TCP ports to listen on.	117	specify TCP ports to listen on. So a bind is basically just a tcp socket
		118	in listening mode thta accepts conenctions form other nodes.
104		119
		120	=item seed nodes
		121
		122	When a node starts, it knows nothing about the network it is in - it
		123	needs to connect to at least one other node that is already in the
		124	network. These other nodes are called "seed nodes".
		125
		126	Seed nodes themselves are not special - they are seed nodes only because
		127	some other node I<uses> them as such, but any node can be used as seed
		128	node for other nodes, and eahc node cna use a different set of seed nodes.
		129
		130	In addition to discovering the network, seed nodes are also used to
		131	maintain the network - all nodes using the same seed node form are part of
		132	the same network. If a network is split into multiple subnets because e.g.
		133	the network link between the parts goes down, then using the same seed
		134	nodes for all nodes ensures that eventually the subnets get merged again.
		135
		136	Seed nodes are expected to be long-running, and at least one seed node
		137	should always be available. They should also be relatively responsive - a
		138	seed node that blocks for long periods will slow down everybody else.
		139
		140	For small networks, it's best if every node uses the same set of seed
		141	nodes. For large networks, it can be useful to specify "regional" seed
		142	nodes for most nodes in an area, and use all seed nodes as seed nodes for
		143	each other. What's important is that all seed nodes connections form a
		144	complete graph, so that the network cannot split into separate subnets
		145	forever.
		146
		147	Seed nodes are represented by seed IDs.
		148
105	=item seeds - C<host:port>	149	=item seed IDs - C<host:port>
106		150
107	When a node starts, it knows nothing about the network. To teach the node	151	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	152	TCP port) of nodes that should be used as seed nodes.
109	network. This node is called a seed.
110		153
111	Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes	154	=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		155
117	Apart from being sued for seeding, seednodes are not special in any way -	156	An AEMP network needs a discovery service - nodes need to know how to
118	every public node can be a seednode.	157	connect to other nodes they only know by name. In addition, AEMP offers a
		158	distributed "group database", which maps group names to a list of strings
		159	- for example, to register worker ports.
		160
		161	A network needs at least one global node to work, and allows every node to
		162	be a global node.
		163
		164	Any node that loads the L<AnyEvent::MP::Global> module becomes a global
		165	node and tries to keep connections to all other nodes. So while it can
		166	make sense to make every node "global" in small networks, it usually makes
		167	sense to only make seed nodes into global nodes in large networks (nodes
		168	keep connections to seed nodes and global nodes, so makign them the same
		169	reduces overhead).
119		170
120	=back	171	=back
121		172
122	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
123		174
…		…
125		176
126	=cut	177	=cut
127		178
128	package AnyEvent::MP;	179	package AnyEvent::MP;
129		180
		181	use AnyEvent::MP::Config ();
130	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
131		184
132	use common::sense;	185	use common::sense;
133		186
134	use Carp ();	187	use Carp ();
135		188
136	use AE ();	189	use AE ();
		190	use Guard ();
137		191
138	use base "Exporter";	192	use base "Exporter";
139		193
140	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
141		195
142	our @EXPORT = qw(	196	our @EXPORT = qw(
143	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
144	initialise_node	198	configure
145	snd rcv mon mon_guard kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
146	port	200	port
		201	db_set db_del db_reg
147	);	202	);
148		203
149	our $SELF;	204	our $SELF;
150		205
151	sub _self_die() {	206	sub _self_die() {
…		…
156		211
157	=item $thisnode = NODE / $NODE	212	=item $thisnode = NODE / $NODE
158		213
159	The C<NODE> function returns, and the C<$NODE> variable contains, the node	214	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	215	ID of the node running in the current process. This value is initialised by
161	a call to C<initialise_node>.	216	a call to C<configure>.
162		217
163	=item $nodeid = node_of $port	218	=item $nodeid = node_of $port
164		219
165	Extracts and returns the node ID from a port ID or a node ID.	220	Extracts and returns the node ID from a port ID or a node ID.
166		221
167	=item initialise_node $profile_name, key => value...	222	=item configure $profile, key => value...
		223
		224	=item configure key => value...
168		225
169	Before a node can talk to other nodes on the network (i.e. enter	226	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	227	"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	228	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.	229	some other nodes in the network to discover other nodes.
173		230
174	This function initialises a node - it must be called exactly once (or	231	This function configures a node - it must be called exactly once (or
175	never) before calling other AnyEvent::MP functions.	232	never) before calling other AnyEvent::MP functions.
176		233
177	The first argument is a profile name. If it is C<undef> or missing, then	234	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>).	235	F<aemp> command line utility (sans the set/del prefix), with these additions:
179		236
		237	=over 4
		238
		239	=item norc => $boolean (default false)
		240
		241	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
		242	be consulted - all configuraiton options must be specified in the
		243	C<configure> call.
		244
		245	=item force => $boolean (default false)
		246
		247	IF true, then the values specified in the C<configure> will take
		248	precedence over any values configured via the rc file. The default is for
		249	the rc file to override any options specified in the program.
		250
		251	=item secure => $pass->($nodeid)
		252
		253	In addition to specifying a boolean, you can specify a code reference that
		254	is called for every remote execution attempt - the execution request is
		255	granted iff the callback returns a true value.
		256
		257	See F<semp setsecure> for more info.
		258
		259	=back
		260
		261	=over 4
		262
		263	=item step 1, gathering configuration from profiles
		264
180	The function first looks up the profile in the aemp configuration (see the	265	The function first looks up a profile in the aemp configuration (see the
181	L<aemp> commandline utility). the profile is calculated as follows:	266	L<aemp> commandline utility). The profile name can be specified via the
		267	named C<profile> parameter or can simply be the first parameter). If it is
		268	missing, then the nodename (F<uname -n>) will be used as profile name.
182		269
183	First, all remaining key => value pairs will be used. Then they will be	270	The profile data is then gathered as follows:
184	overwritten by any values specified in the global default configuration	271
185	(see the F<aemp> utility), then the chain of profiles selected, if	272	First, all remaining key => value pairs (all of which are conveniently
		273	undocumented at the moment) will be interpreted as configuration
		274	data. Then they will be overwritten by any values specified in the global
		275	default configuration (see the F<aemp> utility), then the chain of
		276	profiles chosen by the profile name (and any C<parent> attributes).
		277
186	any. That means that the values specified in the profile have highest	278	That means that the values specified in the profile have highest priority
187	priority and the values specified via C<initialise_node> have lowest	279	and the values specified directly via C<configure> have lowest priority,
188	priority.	280	and can only be used to specify defaults.
189		281
190	If the profile specifies a node ID, then this will become the node ID of	282	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	283	this process. If not, then the profile name will be used as node ID, with
192	special node ID of C<anon/> will be replaced by a random node ID.	284	a unique randoms tring (C</%u>) appended.
		285
		286	The node ID can contain some C<%> sequences that are expanded: C<%n>
		287	is expanded to the local nodename, C<%u> is replaced by a random
		288	strign to make the node unique. For example, the F<aemp> commandline
		289	utility uses C<aemp/%n/%u> as nodename, which might expand to
		290	C<aemp/cerebro/ZQDGSIkRhEZQDGSIkRhE>.
		291
		292	=item step 2, bind listener sockets
193		293
194	The next step is to look up the binds in the profile, followed by binding	294	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	295	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	296	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	297	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).	298	binds, but it can still talk to all "normal" nodes).
199		299
200	If the profile does not specify a binds list, then the node ID will be	300	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	301	used, meaning the node will bind on a dynamically-assigned port on every
202	used as binds list.	302	local IP address it finds.
203		303
		304	=item step 3, connect to seed nodes
		305
204	Lastly, the seeds list from the profile is passed to the	306	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	307	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.	308	connectivity with at least one node at any point in time.
207		309
208	Example: become a distributed node listening on the guessed noderef, or	310	=back
209	the one specified via C<aemp> for the current node. This should be the	311
		312	Example: become a distributed node using the local node name as profile.
210	most common form of invocation for "daemon"-type nodes.	313	This should be the most common form of invocation for "daemon"-type nodes.
211		314
212	initialise_node;	315	configure
213		316
214	Example: become an anonymous node. This form is often used for commandline	317	Example: become a semi-anonymous node. This form is often used for
215	clients.	318	commandline clients.
216		319
217	initialise_node "anon/";	320	configure nodeid => "myscript/%n/%u";
218		321
219	Example: become a distributed node. If there is no profile of the given	322	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	323	for a seed node as it binds on all local addresses on a fixed port (4040,
221	on the resulting addresses.	324	customary for aemp).
222		325
223	initialise_node "localhost:4044";	326	# use the aemp commandline utility
		327	# aemp profile seed binds '*:4040'
		328
		329	# then use it
		330	configure profile => "seed";
		331
		332	# or simply use aemp from the shell again:
		333	# aemp run profile seed
		334
		335	# or provide a nicer-to-remember nodeid
		336	# aemp run profile seed nodeid "$(hostname)"
224		337
225	=item $SELF	338	=item $SELF
226		339
227	Contains the current port id while executing C<rcv> callbacks or C<psub>	340	Contains the current port id while executing C<rcv> callbacks or C<psub>
228	blocks.	341	blocks.
…		…
289	sub _kilme {	402	sub _kilme {
290	die "received message on port without callback";	403	die "received message on port without callback";
291	}	404	}
292		405
293	sub port(;&) {	406	sub port(;&) {
294	my $id = "$UNIQ." . $ID++;	407	my $id = $UNIQ . ++$ID;
295	my $port = "$NODE#$id";	408	my $port = "$NODE#$id";
296		409
297	rcv $port, shift \|\| \&_kilme;	410	rcv $port, shift \|\| \&_kilme;
298		411
299	$port	412	$port
…		…
338	msg1 => sub { ... },	451	msg1 => sub { ... },
339	...	452	...
340	;	453	;
341		454
342	Example: temporarily register a rcv callback for a tag matching some port	455	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.	456	(e.g. for an rpc reply) and unregister it after a message was received.
344		457
345	rcv $port, $otherport => sub {	458	rcv $port, $otherport => sub {
346	my @reply = @_;	459	my @reply = @_;
347		460
348	rcv $SELF, $otherport;	461	rcv $SELF, $otherport;
…		…
350		463
351	=cut	464	=cut
352		465
353	sub rcv($@) {	466	sub rcv($@) {
354	my $port = shift;	467	my $port = shift;
355	my ($noderef, $portid) = split /#/, $port, 2;	468	my ($nodeid, $portid) = split /#/, $port, 2;
356		469
357	$NODE{$noderef} == $NODE{""}	470	$NODE{$nodeid} == $NODE{""}
358	or Carp::croak "$port: rcv can only be called on local ports, caught";	471	or Carp::croak "$port: rcv can only be called on local ports, caught";
359		472
360	while (@_) {	473	while (@_) {
361	if (ref $_[0]) {	474	if (ref $_[0]) {
362	if (my $self = $PORT_DATA{$portid}) {	475	if (my $self = $PORT_DATA{$portid}) {
363	"AnyEvent::MP::Port" eq ref $self	476	"AnyEvent::MP::Port" eq ref $self
364	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	477	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
365		478
366	$self->[2] = shift;	479	$self->[0] = shift;
367	} else {	480	} else {
368	my $cb = shift;	481	my $cb = shift;
369	$PORT{$portid} = sub {	482	$PORT{$portid} = sub {
370	local $SELF = $port;	483	local $SELF = $port;
371	eval { &$cb }; _self_die if $@;	484	eval { &$cb }; _self_die if $@;
372	};	485	};
373	}	486	}
374	} elsif (defined $_[0]) {	487	} elsif (defined $_[0]) {
375	my $self = $PORT_DATA{$portid} \|\|= do {	488	my $self = $PORT_DATA{$portid} \|\|= do {
376	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	489	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
377		490
378	$PORT{$portid} = sub {	491	$PORT{$portid} = sub {
379	local $SELF = $port;	492	local $SELF = $port;
380		493
381	if (my $cb = $self->[1]{$_[0]}) {	494	if (my $cb = $self->[1]{$_[0]}) {
…		…
403	}	516	}
404		517
405	$port	518	$port
406	}	519	}
407		520
		521	=item peval $port, $coderef[, @args]
		522
		523	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		524	when the code throews an exception the C<$port> will be killed.
		525
		526	Any remaining args will be passed to the callback. Any return values will
		527	be returned to the caller.
		528
		529	This is useful when you temporarily want to execute code in the context of
		530	a port.
		531
		532	Example: create a port and run some initialisation code in it's context.
		533
		534	my $port = port { ... };
		535
		536	peval $port, sub {
		537	init
		538	or die "unable to init";
		539	};
		540
		541	=cut
		542
		543	sub peval($$) {
		544	local $SELF = shift;
		545	my $cb = shift;
		546
		547	if (wantarray) {
		548	my @res = eval { &$cb };
		549	_self_die if $@;
		550	@res
		551	} else {
		552	my $res = eval { &$cb };
		553	_self_die if $@;
		554	$res
		555	}
		556	}
		557
408	=item $closure = psub { BLOCK }	558	=item $closure = psub { BLOCK }
409		559
410	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	560	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>	561	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.	562	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		563
		564	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		565	BLOCK }, @_ } >>.
413		566
414	This is useful when you register callbacks from C<rcv> callbacks:	567	This is useful when you register callbacks from C<rcv> callbacks:
415		568
416	rcv delayed_reply => sub {	569	rcv delayed_reply => sub {
417	my ($delay, @reply) = @_;	570	my ($delay, @reply) = @_;
…		…
453		606
454	Monitor the given port and do something when the port is killed or	607	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	608	messages to it were lost, and optionally return a guard that can be used
456	to stop monitoring again.	609	to stop monitoring again.
457		610
		611	In the first form (callback), the callback is simply called with any
		612	number of C<@reason> elements (no @reason means that the port was deleted
		613	"normally"). Note also that I<< the callback B<must> never die >>, so use
		614	C<eval> if unsure.
		615
		616	In the second form (another port given), the other port (C<$rcvport>)
		617	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
		618	"normal" kils nothing happens, while under all other conditions, the other
		619	port is killed with the same reason.
		620
		621	The third form (kill self) is the same as the second form, except that
		622	C<$rvport> defaults to C<$SELF>.
		623
		624	In the last form (message), a message of the form C<@msg, @reason> will be
		625	C<snd>.
		626
		627	Monitoring-actions are one-shot: once messages are lost (and a monitoring
		628	alert was raised), they are removed and will not trigger again.
		629
		630	As a rule of thumb, monitoring requests should always monitor a port from
		631	a local port (or callback). The reason is that kill messages might get
		632	lost, just like any other message. Another less obvious reason is that
		633	even monitoring requests can get lost (for example, when the connection
		634	to the other node goes down permanently). When monitoring a port locally
		635	these problems do not exist.
		636
458	C<mon> effectively guarantees that, in the absence of hardware failures,	637	C<mon> effectively guarantees that, in the absence of hardware failures,
459	after starting the monitor, either all messages sent to the port will	638	after starting the monitor, either all messages sent to the port will
460	arrive, or the monitoring action will be invoked after possible message	639	arrive, or the monitoring action will be invoked after possible message
461	loss has been detected. No messages will be lost "in between" (after	640	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	641	the first lost message no further messages will be received by the
463	port). After the monitoring action was invoked, further messages might get	642	port). After the monitoring action was invoked, further messages might get
464	delivered again.	643	delivered again.
465		644
466	Note that monitoring-actions are one-shot: once messages are lost (and a	645	Inter-host-connection timeouts and monitoring depend on the transport
467	monitoring alert was raised), they are removed and will not trigger again.	646	used. The only transport currently implemented is TCP, and AnyEvent::MP
		647	relies on TCP to detect node-downs (this can take 10-15 minutes on a
		648	non-idle connection, and usually around two hours for idle connections).
468		649
469	In the first form (callback), the callback is simply called with any	650	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	651	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	652	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		653
492	Example: call a given callback when C<$port> is killed.	654	Example: call a given callback when C<$port> is killed.
493		655
494	mon $port, sub { warn "port died because of <@_>\n" };	656	mon $port, sub { warn "port died because of <@_>\n" };
495		657
…		…
502	mon $port, $self => "restart";	664	mon $port, $self => "restart";
503		665
504	=cut	666	=cut
505		667
506	sub mon {	668	sub mon {
507	my ($noderef, $port) = split /#/, shift, 2;	669	my ($nodeid, $port) = split /#/, shift, 2;
508		670
509	my $node = $NODE{$noderef} \|\| add_node $noderef;	671	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
510		672
511	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';	673	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
512		674
513	unless (ref $cb) {	675	unless (ref $cb) {
514	if (@_) {	676	if (@_) {
…		…
523	}	685	}
524		686
525	$node->monitor ($port, $cb);	687	$node->monitor ($port, $cb);
526		688
527	defined wantarray	689	defined wantarray
528	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	690	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
529	}	691	}
530		692
531	=item $guard = mon_guard $port, $ref, $ref...	693	=item $guard = mon_guard $port, $ref, $ref...
532		694
533	Monitors the given C<$port> and keeps the passed references. When the port	695	Monitors the given C<$port> and keeps the passed references. When the port
…		…
556		718
557	=item kil $port[, @reason]	719	=item kil $port[, @reason]
558		720
559	Kill the specified port with the given C<@reason>.	721	Kill the specified port with the given C<@reason>.
560		722
561	If no C<@reason> is specified, then the port is killed "normally" (ports	723	If no C<@reason> is specified, then the port is killed "normally" -
562	monitoring other ports will not necessarily die because a port dies	724	monitor callback will be invoked, but the kil will not cause linked ports
563	"normally").	725	(C<mon $mport, $lport> form) to get killed.
564		726
565	Otherwise, linked ports get killed with the same reason (second form of	727	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
566	C<mon>, see above).	728	form) get killed with the same reason.
567		729
568	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	730	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
569	will be reported as reason C<< die => $@ >>.	731	will be reported as reason C<< die => $@ >>.
570		732
571	Transport/communication errors are reported as C<< transport_error =>	733	Transport/communication errors are reported as C<< transport_error =>
…		…
590	the package, then the package above the package and so on (e.g.	752	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	753	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
592	exists or it runs out of package names.	754	exists or it runs out of package names.
593		755
594	The init function is then called with the newly-created port as context	756	The init function is then called with the newly-created port as context
595	object (C<$SELF>) and the C<@initdata> values as arguments.	757	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		758	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		759	the port might not get created.
596		760
597	A common idiom is to pass a local port, immediately monitor the spawned	761	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	762	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	763	local port. This two-way monitoring ensures that both ports get cleaned up
600	when there is a problem.	764	when there is a problem.
601		765
		766	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		767	caller before C<spawn> returns (by delaying invocation when spawn is
		768	called for the local node).
		769
602	Example: spawn a chat server port on C<$othernode>.	770	Example: spawn a chat server port on C<$othernode>.
603		771
604	# this node, executed from within a port context:	772	# this node, executed from within a port context:
605	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	773	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
606	mon $server;	774	mon $server;
…		…
620		788
621	sub _spawn {	789	sub _spawn {
622	my $port = shift;	790	my $port = shift;
623	my $init = shift;	791	my $init = shift;
624		792
		793	# rcv will create the actual port
625	local $SELF = "$NODE#$port";	794	local $SELF = "$NODE#$port";
626	eval {	795	eval {
627	&{ load_func $init }	796	&{ load_func $init }
628	};	797	};
629	_self_die if $@;	798	_self_die if $@;
630	}	799	}
631		800
632	sub spawn(@) {	801	sub spawn(@) {
633	my ($noderef, undef) = split /#/, shift, 2;	802	my ($nodeid, undef) = split /#/, shift, 2;
634		803
635	my $id = "$RUNIQ." . $ID++;	804	my $id = $RUNIQ . ++$ID;
636		805
637	$_[0] =~ /::/	806	$_[0] =~ /::/
638	or Carp::croak "spawn init function must be a fully-qualified name, caught";	807	or Carp::croak "spawn init function must be a fully-qualified name, caught";
639		808
640	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;	809	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
641		810
642	"$noderef#$id"	811	"$nodeid#$id"
643	}	812	}
		813
644		814
645	=item after $timeout, @msg	815	=item after $timeout, @msg
646		816
647	=item after $timeout, $callback	817	=item after $timeout, $callback
648		818
…		…
664	? $action[0]()	834	? $action[0]()
665	: snd @action;	835	: snd @action;
666	};	836	};
667	}	837	}
668		838
		839	=item cal $port, @msg, $callback[, $timeout]
		840
		841	A simple form of RPC - sends a message to the given C<$port> with the
		842	given contents (C<@msg>), but adds a reply port to the message.
		843
		844	The reply port is created temporarily just for the purpose of receiving
		845	the reply, and will be C<kil>ed when no longer needed.
		846
		847	A reply message sent to the port is passed to the C<$callback> as-is.
		848
		849	If an optional time-out (in seconds) is given and it is not C<undef>,
		850	then the callback will be called without any arguments after the time-out
		851	elapsed and the port is C<kil>ed.
		852
		853	If no time-out is given (or it is C<undef>), then the local port will
		854	monitor the remote port instead, so it eventually gets cleaned-up.
		855
		856	Currently this function returns the temporary port, but this "feature"
		857	might go in future versions unless you can make a convincing case that
		858	this is indeed useful for something.
		859
		860	=cut
		861
		862	sub cal(@) {
		863	my $timeout = ref $_[-1] ? undef : pop;
		864	my $cb = pop;
		865
		866	my $port = port {
		867	undef $timeout;
		868	kil $SELF;
		869	&$cb;
		870	};
		871
		872	if (defined $timeout) {
		873	$timeout = AE::timer $timeout, 0, sub {
		874	undef $timeout;
		875	kil $port;
		876	$cb->();
		877	};
		878	} else {
		879	mon $_[0], sub {
		880	kil $port;
		881	$cb->();
		882	};
		883	}
		884
		885	push @_, $port;
		886	&snd;
		887
		888	$port
		889	}
		890
		891	=back
		892
		893	=head1 DISTRIBUTED DATABASE
		894
		895	AnyEvent::MP comes with a simple distributed database. The database will
		896	be mirrored asynchronously at all global nodes. Other nodes bind to one of
		897	the global nodes for their needs.
		898
		899	The database consists of a two-level hash - a hash contains a hash which
		900	contains values.
		901
		902	The top level hash key is called "family", and the second-level hash key
		903	is called "subkey" or simply "key".
		904
		905	The family must be alphanumeric, i.e. start with a letter and consist
		906	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		907	pretty much like Perl module names.
		908
		909	As the family namespace is global, it is recommended to prefix family names
		910	with the name of the application or module using it.
		911
		912	The subkeys must be non-empty strings, with no further restrictions.
		913
		914	The values should preferably be strings, but other perl scalars should
		915	work as well (such as undef, arrays and hashes).
		916
		917	Every database entry is owned by one node - adding the same family/subkey
		918	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		919	but the result might be nondeterministic, i.e. the key might have
		920	different values on different nodes.
		921
		922	Different subkeys in the same family can be owned by different nodes
		923	without problems, and in fact, this is the common method to create worker
		924	pools. For example, a worker port for image scaling might do this:
		925
		926	db_set my_image_scalers => $port;
		927
		928	And clients looking for an image scaler will want to get the
		929	C<my_image_scalers> keys:
		930
		931	db_keys "my_image_scalers" => 60 => sub {
		932	#d##TODO#
		933
		934	=over
		935
		936	=item db_set $family => $subkey [=> $value]
		937
		938	Sets (or replaces) a key to the database - if C<$value> is omitted,
		939	C<undef> is used instead.
		940
		941	=item db_del $family => $subkey
		942
		943	Deletes a key from the database.
		944
		945	=item $guard = db_reg $family => $subkey [=> $value]
		946
		947	Sets the key on the database and returns a guard. When the guard is
		948	destroyed, the key is deleted from the database. If C<$value> is missing,
		949	then C<undef> is used.
		950
		951	=cut
		952
669	=back	953	=back
670		954
671	=head1 AnyEvent::MP vs. Distributed Erlang	955	=head1 AnyEvent::MP vs. Distributed Erlang
672		956
673	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	957	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	958	== 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	959	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
676	sample:	960	sample:
677		961
678	http://www.Erlang.se/doc/programming_rules.shtml	962	http://www.erlang.se/doc/programming_rules.shtml
679	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	963	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	964	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	965	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
682		966
683	Despite the similarities, there are also some important differences:	967	Despite the similarities, there are also some important differences:
684		968
685	=over 4	969	=over 4
686		970
687	=item * Node IDs are arbitrary strings in AEMP.	971	=item * Node IDs are arbitrary strings in AEMP.
688		972
689	Erlang relies on special naming and DNS to work everywhere in the same	973	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	974	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.	975	configuration or DNS), and possibly the addresses of some seed nodes, but
		976	will otherwise discover other nodes (and their IDs) itself.
692		977
693	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	978	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
694	uses "local ports are like remote ports".	979	uses "local ports are like remote ports".
695		980
696	The failure modes for local ports are quite different (runtime errors	981	The failure modes for local ports are quite different (runtime errors
…		…
705	ports being the special case/exception, where transport errors cannot	990	ports being the special case/exception, where transport errors cannot
706	occur.	991	occur.
707		992
708	=item * Erlang uses processes and a mailbox, AEMP does not queue.	993	=item * Erlang uses processes and a mailbox, AEMP does not queue.
709		994
710	Erlang uses processes that selectively receive messages, and therefore	995	Erlang uses processes that selectively receive messages out of order, and
711	needs a queue. AEMP is event based, queuing messages would serve no	996	therefore needs a queue. AEMP is event based, queuing messages would serve
712	useful purpose. For the same reason the pattern-matching abilities of	997	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	998	of AnyEvent::MP are more limited, as there is little need to be able to
714	filter messages without dequeing them.	999	filter messages without dequeuing them.
715		1000
716	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	1001	This is not a philosophical difference, but simply stems from AnyEvent::MP
		1002	being event-based, while Erlang is process-based.
		1003
		1004	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		1005	top of AEMP and Coro threads.
717		1006
718	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	1007	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
719		1008
720	Sending messages in Erlang is synchronous and blocks the process (and	1009	Sending messages in Erlang is synchronous and blocks the process until
		1010	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,	1011	need a queue that can overflow). AEMP sends return immediately, connection
722	connection establishment is handled in the background.	1012	establishment is handled in the background.
723		1013
724	=item * Erlang suffers from silent message loss, AEMP does not.	1014	=item * Erlang suffers from silent message loss, AEMP does not.
725		1015
726	Erlang makes few guarantees on messages delivery - messages can get lost	1016	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,	1017	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).	1018	b, and c, and the other side only receives messages a and c).
729		1019
730	AEMP guarantees correct ordering, and the guarantee that after one message	1020	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	1021	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	1022	same port are lost as well, until monitoring raises an error, so there are
733	sequence.	1023	no silent "holes" in the message sequence.
		1024
		1025	If you want your software to be very reliable, you have to cope with
		1026	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
		1027	simply tries to work better in common error cases, such as when a network
		1028	link goes down.
734		1029
735	=item * Erlang can send messages to the wrong port, AEMP does not.	1030	=item * Erlang can send messages to the wrong port, AEMP does not.
736		1031
737	In Erlang it is quite likely that a node that restarts reuses a process ID	1032	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	1033	process ID known to other nodes for a completely different process,
739	destined for that process to end up in an unrelated process.	1034	causing messages destined for that process to end up in an unrelated
		1035	process.
740		1036
741	AEMP never reuses port IDs, so old messages or old port IDs floating	1037	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.	1038	around in the network will not be sent to an unrelated port.
743		1039
744	=item * Erlang uses unprotected connections, AEMP uses secure	1040	=item * Erlang uses unprotected connections, AEMP uses secure
745	authentication and can use TLS.	1041	authentication and can use TLS.
746		1042
…		…
749		1045
750	=item * The AEMP protocol is optimised for both text-based and binary	1046	=item * The AEMP protocol is optimised for both text-based and binary
751	communications.	1047	communications.
752		1048
753	The AEMP protocol, unlike the Erlang protocol, supports both programming	1049	The AEMP protocol, unlike the Erlang protocol, supports both programming
754	language independent text-only protocols (good for debugging) and binary,	1050	language independent text-only protocols (good for debugging), and binary,
755	language-specific serialisers (e.g. Storable). By default, unless TLS is	1051	language-specific serialisers (e.g. Storable). By default, unless TLS is
756	used, the protocol is actually completely text-based.	1052	used, the protocol is actually completely text-based.
757		1053
758	It has also been carefully designed to be implementable in other languages	1054	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	1055	with a minimum of work while gracefully degrading functionality to make the
760	protocol simple.	1056	protocol simple.
761		1057
762	=item * AEMP has more flexible monitoring options than Erlang.	1058	=item * AEMP has more flexible monitoring options than Erlang.
763		1059
764	In Erlang, you can chose to receive I<all> exit signals as messages	1060	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	1061	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	1062	difficult to implement.
767	Erlang, as one can choose between automatic kill, exit message or callback	1063
768	on a per-process basis.	1064	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		1065	between automatic kill, exit message or callback on a per-port basis.
769		1066
770	=item * Erlang tries to hide remote/local connections, AEMP does not.	1067	=item * Erlang tries to hide remote/local connections, AEMP does not.
771		1068
772	Monitoring in Erlang is not an indicator of process death/crashes, in the	1069	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).	1070	same way as linking is (except linking is unreliable in Erlang).
…		…
795	overhead, as well as having to keep a proxy object everywhere.	1092	overhead, as well as having to keep a proxy object everywhere.
796		1093
797	Strings can easily be printed, easily serialised etc. and need no special	1094	Strings can easily be printed, easily serialised etc. and need no special
798	procedures to be "valid".	1095	procedures to be "valid".
799		1096
800	And as a result, a miniport consists of a single closure stored in a	1097	And as a result, a port with just a default receiver consists of a single
801	global hash - it can't become much cheaper.	1098	code reference stored in a global hash - it can't become much cheaper.
802		1099
803	=item Why favour JSON, why not a real serialising format such as Storable?	1100	=item Why favour JSON, why not a real serialising format such as Storable?
804		1101
805	In fact, any AnyEvent::MP node will happily accept Storable as framing	1102	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	1103	format, but currently there is no way to make a node use Storable by
…		…
822		1119
823	L<AnyEvent::MP::Intro> - a gentle introduction.	1120	L<AnyEvent::MP::Intro> - a gentle introduction.
824		1121
825	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.	1122	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
826		1123
827	L<AnyEvent::MP::Global> - network maintainance and port groups, to find	1124	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
828	your applications.	1125	your applications.
		1126
		1127	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
		1128
		1129	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
		1130	all nodes.
829		1131
830	L<AnyEvent>.	1132	L<AnyEvent>.
831		1133
832	=head1 AUTHOR	1134	=head1 AUTHOR
833		1135

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs. Revision 1.127 by root, Sat Mar 3 20:35:10 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.69 by root, Sun Aug 30 18:51:49 2009 UTC vs.
Revision 1.127 by root, Sat Mar 3 20:35:10 2012 UTC