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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.21 by root, Tue Aug 4 14:10:51 2009 UTC vs. Revision 1.72 by root, Mon Aug 31 10:07:04 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.21 by root, Tue Aug 4 14:10:51 2009 UTC vs.
Revision 1.72 by root, Mon Aug 31 10:07:04 2009 UTC