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

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.68 by root, Fri Aug 28 23:06:33 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.68 by root, Fri Aug 28 23:06:33 2009 UTC