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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.3 by root, Sat Aug 1 07:11:45 2009 UTC vs. Revision 1.38 by root, Fri Aug 7 22:55:18 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.3 by root, Sat Aug 1 07:11:45 2009 UTC vs.
Revision 1.38 by root, Fri Aug 7 22:55:18 2009 UTC