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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs.
Revision 1.92 by root, Tue Sep 22 14:13:33 2009 UTC

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs. Revision 1.92 by root, Tue Sep 22 14:13:33 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.14 by root, Sun Aug 2 18:26:00 2009 UTC vs.
Revision 1.92 by root, Tue Sep 22 14:13:33 2009 UTC