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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.7 by root, Sat Aug 1 15:04:30 2009 UTC vs.
Revision 1.58 by root, Sun Aug 16 02:55:16 2009 UTC

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.7 by root, Sat Aug 1 15:04:30 2009 UTC vs. Revision 1.58 by root, Sun Aug 16 02:55:16 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.7 by root, Sat Aug 1 15:04:30 2009 UTC vs.
Revision 1.58 by root, Sun Aug 16 02:55:16 2009 UTC