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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC vs.
Revision 1.125 by root, Sat Mar 3 13:07:19 2012 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 # contains this node's noderef	9	$NODE # contains this node's node ID
10	NODE # returns this node's noderef	10	NODE # returns this node's node ID
11	NODE $port # returns the noderef of the port
12		11
13	$SELF # receiving/own port id in rcv callbacks	12	$SELF # receiving/own port id in rcv callbacks
14		13
15	# initialise the node so it can send/receive messages	14	# initialise the node so it can send/receive messages
16	initialise_node;	15	configure;
17		16
18	# ports are message endpoints	17	# ports are message destinations
19		18
20	# sending messages	19	# sending messages
21	snd $port, type => data...;	20	snd $port, type => data...;
22	snd $port, @msg;	21	snd $port, @msg;
23	snd @msg_with_first_element_being_a_port;	22	snd @msg_with_first_element_being_a_port;
24		23
25	# creating/using ports, the simple way	24	# creating/using ports, the simple way
26	my $simple_port = port { my @msg = @_; 0 };	25	my $simple_port = port { my @msg = @_ };
27		26
28	# creating/using ports, tagged message matching	27	# creating/using ports, tagged message matching
29	my $port = port;	28	my $port = port;
30	rcv $port, ping => sub { snd $_[0], "pong"; 0 };	29	rcv $port, ping => sub { snd $_[0], "pong" };
31	rcv $port, pong => sub { warn "pong received\n"; 0 };	30	rcv $port, pong => sub { warn "pong received\n" };
32		31
33	# create a port on another node	32	# create a port on another node
34	my $port = spawn $node, $initfunc, @initdata;	33	my $port = spawn $node, $initfunc, @initdata;
35		34
		35	# destroy a port again
		36	kil $port; # "normal" kill
		37	kil $port, my_error => "everything is broken"; # error kill
		38
36	# monitoring	39	# monitoring
37	mon $port, $cb->(@msg) # callback is invoked on death	40	mon $localport, $cb->(@msg) # callback is invoked on death
38	mon $port, $otherport # kill otherport on abnormal death	41	mon $localport, $otherport # kill otherport on abnormal death
39	mon $port, $otherport, @msg # send message on death	42	mon $localport, $otherport, @msg # send message on death
		43
		44	# temporarily execute code in port context
		45	peval $port, sub { die "kill the port!" };
		46
		47	# execute callbacks in $SELF port context
		48	my $timer = AE::timer 1, 0, psub {
		49	die "kill the port, delayed";
		50	};
40		51
41	=head1 CURRENT STATUS	52	=head1 CURRENT STATUS
42		53
		54	bin/aemp - stable.
43	AnyEvent::MP - stable API, should work	55	AnyEvent::MP - stable API, should work.
44	AnyEvent::MP::Intro - outdated	56	AnyEvent::MP::Intro - explains most concepts.
45	AnyEvent::MP::Kernel - WIP
46	AnyEvent::MP::Transport - mostly stable	57	AnyEvent::MP::Kernel - mostly stable API.
47		58	AnyEvent::MP::Global - stable API.
48	stay tuned.
49		59
50	=head1 DESCRIPTION	60	=head1 DESCRIPTION
51		61
52	This module (-family) implements a simple message passing framework.	62	This module (-family) implements a simple message passing framework.
53		63
54	Despite its simplicity, you can securely message other processes running	64	Despite its simplicity, you can securely message other processes running
55	on the same or other hosts.	65	on the same or other hosts, and you can supervise entities remotely.
56		66
57	For an introduction to this module family, see the L<AnyEvent::MP::Intro>	67	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
58	manual page.	68	manual page and the examples under F<eg/>.
59
60	At the moment, this module family is severly broken and underdocumented,
61	so do not use. This was uploaded mainly to reserve the CPAN namespace -
62	stay tuned!
63		69
64	=head1 CONCEPTS	70	=head1 CONCEPTS
65		71
66	=over 4	72	=over 4
67		73
68	=item port	74	=item port
69		75
70	A port is something you can send messages to (with the C<snd> function).	76	Not to be confused with a TCP port, a "port" is something you can send
		77	messages to (with the C<snd> function).
71		78
72	Ports allow you to register C<rcv> handlers that can match all or just	79	Ports allow you to register C<rcv> handlers that can match all or just
73	some messages. Messages will not be queued.	80	some messages. Messages send to ports will not be queued, regardless of
		81	anything was listening for them or not.
74		82
		83	Ports are represented by (printable) strings called "port IDs".
		84
75	=item port ID - C<noderef#portname>	85	=item port ID - C<nodeid#portname>
76		86
77	A port ID is the concatenation of a noderef, a hash-mark (C<#>) as	87	A port ID is the concatenation of a node ID, a hash-mark (C<#>)
78	separator, and a port name (a printable string of unspecified format). An	88	as separator, and a port name (a printable string of unspecified
79	exception is the the node port, whose ID is identical to its node	89	format created by AnyEvent::MP).
80	reference.
81		90
82	=item node	91	=item node
83		92
84	A node is a single process containing at least one port - the node port,	93	A node is a single process containing at least one port - the node port,
85	which provides nodes to manage each other remotely, and to create new	94	which enables nodes to manage each other remotely, and to create new
86	ports.	95	ports.
87		96
88	Nodes are either private (single-process only), slaves (can only talk to	97	Nodes are either public (have one or more listening ports) or private
89	public nodes, but do not need an open port) or public nodes (connectable	98	(no listening ports). Private nodes cannot talk to other private nodes
90	from any other node).	99	currently, but all nodes can talk to public nodes.
91		100
		101	Nodes is represented by (printable) strings called "node IDs".
		102
92	=item node ID - C<[a-za-Z0-9_\-.:]+>	103	=item node ID - C<[A-Za-z0-9_\-.:]*>
93		104
94	A node ID is a string that either simply identifies the node (for	105	A node ID is a string that uniquely identifies the node within a
95	private and slave nodes), or contains a recipe on how to reach a given	106	network. Depending on the configuration used, node IDs can look like a
96	node (for public nodes).	107	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
		108	doesn't interpret node IDs in any way except to uniquely identify a node.
97		109
98	This recipe is simply a comma-separated list of C<address:port> pairs (for	110	=item binds - C<ip:port>
99	TCP/IP, other protocols might look different).
100		111
101	Node references come in two flavours: resolved (containing only numerical	112	Nodes can only talk to each other by creating some kind of connection to
102	addresses) or unresolved (where hostnames are used instead of addresses).	113	each other. To do this, nodes should listen on one or more local transport
		114	endpoints - binds.
103		115
104	Before using an unresolved node reference in a message you first have to	116	Currently, only standard C<ip:port> specifications can be used, which
105	resolve it.	117	specify TCP ports to listen on. So a bind is basically just a tcp socket
		118	in listening mode thta accepts conenctions form other nodes.
		119
		120	=item seed nodes
		121
		122	When a node starts, it knows nothing about the network it is in - it
		123	needs to connect to at least one other node that is already in the
		124	network. These other nodes are called "seed nodes".
		125
		126	Seed nodes themselves are not special - they are seed nodes only because
		127	some other node I<uses> them as such, but any node can be used as seed
		128	node for other nodes, and eahc node cna use a different set of seed nodes.
		129
		130	In addition to discovering the network, seed nodes are also used to
		131	maintain the network - all nodes using the same seed node form are part of
		132	the same network. If a network is split into multiple subnets because e.g.
		133	the network link between the parts goes down, then using the same seed
		134	nodes for all nodes ensures that eventually the subnets get merged again.
		135
		136	Seed nodes are expected to be long-running, and at least one seed node
		137	should always be available. They should also be relatively responsive - a
		138	seed node that blocks for long periods will slow down everybody else.
		139
		140	For small networks, it's best if every node uses the same set of seed
		141	nodes. For large networks, it can be useful to specify "regional" seed
		142	nodes for most nodes in an area, and use all seed nodes as seed nodes for
		143	each other. What's important is that all seed nodes connections form a
		144	complete graph, so that the network cannot split into separate subnets
		145	forever.
		146
		147	Seed nodes are represented by seed IDs.
		148
		149	=item seed IDs - C<host:port>
		150
		151	Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
		152	TCP port) of nodes that should be used as seed nodes.
		153
		154	=item global nodes
		155
		156	An AEMP network needs a discovery service - nodes need to know how to
		157	connect to other nodes they only know by name. In addition, AEMP offers a
		158	distributed "group database", which maps group names to a list of strings
		159	- for example, to register worker ports.
		160
		161	A network needs at least one global node to work, and allows every node to
		162	be a global node.
		163
		164	Any node that loads the L<AnyEvent::MP::Global> module becomes a global
		165	node and tries to keep connections to all other nodes. So while it can
		166	make sense to make every node "global" in small networks, it usually makes
		167	sense to only make seed nodes into global nodes in large networks (nodes
		168	keep connections to seed nodes and global nodes, so makign them the same
		169	reduces overhead).
106		170
107	=back	171	=back
108		172
109	=head1 VARIABLES/FUNCTIONS	173	=head1 VARIABLES/FUNCTIONS
110		174
112		176
113	=cut	177	=cut
114		178
115	package AnyEvent::MP;	179	package AnyEvent::MP;
116		180
		181	use AnyEvent::MP::Config ();
117	use AnyEvent::MP::Kernel;	182	use AnyEvent::MP::Kernel;
		183	use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
118		184
119	use common::sense;	185	use common::sense;
120		186
121	use Carp ();	187	use Carp ();
122		188
123	use AE ();	189	use AE ();
		190	use Guard ();
124		191
125	use base "Exporter";	192	use base "Exporter";
126		193
127	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	194	our $VERSION = $AnyEvent::MP::Config::VERSION;
128		195
129	our @EXPORT = qw(	196	our @EXPORT = qw(
130	NODE $NODE *SELF node_of after	197	NODE $NODE *SELF node_of after
131	resolve_node initialise_node	198	configure
132	snd rcv mon mon_guard kil reg psub spawn	199	snd rcv mon mon_guard kil psub peval spawn cal
133	port	200	port
		201	db_set db_del db_reg
134	);	202	);
135		203
136	our $SELF;	204	our $SELF;
137		205
138	sub _self_die() {	206	sub _self_die() {
…		…
141	kil $SELF, die => $msg;	209	kil $SELF, die => $msg;
142	}	210	}
143		211
144	=item $thisnode = NODE / $NODE	212	=item $thisnode = NODE / $NODE
145		213
146	The C<NODE> function returns, and the C<$NODE> variable contains the	214	The C<NODE> function returns, and the C<$NODE> variable contains, the node
147	node id of the local node. The value is initialised by a call to	215	ID of the node running in the current process. This value is initialised by
148	C<initialise_node>.	216	a call to C<configure>.
149		217
150	=item $nodeid = node_of $port	218	=item $nodeid = node_of $port
151		219
152	Extracts and returns the noderef from a port ID or a node ID.	220	Extracts and returns the node ID from a port ID or a node ID.
153		221
154	=item initialise_node $profile_name	222	=item configure $profile, key => value...
155		223
		224	=item configure key => value...
		225
156	Before a node can talk to other nodes on the network it has to initialise	226	Before a node can talk to other nodes on the network (i.e. enter
157	itself - the minimum a node needs to know is it's own name, and optionally	227	"distributed mode") it has to configure itself - the minimum a node needs
158	it should know the noderefs of some other nodes in the network.	228	to know is its own name, and optionally it should know the addresses of
		229	some other nodes in the network to discover other nodes.
159		230
160	This function initialises a node - it must be called exactly once (or	231	This function configures a node - it must be called exactly once (or
161	never) before calling other AnyEvent::MP functions.	232	never) before calling other AnyEvent::MP functions.
162		233
163	All arguments (optionally except for the first) are noderefs, which can be	234	The key/value pairs are basically the same ones as documented for the
164	either resolved or unresolved.	235	F<aemp> command line utility (sans the set/del prefix), with two additions:
165
166	The first argument will be looked up in the configuration database first
167	(if it is C<undef> then the current nodename will be used instead) to find
168	the relevant configuration profile (see L<aemp>). If none is found then
169	the default configuration is used. The configuration supplies additional
170	seed/master nodes and can override the actual noderef.
171
172	There are two types of networked nodes, public nodes and slave nodes:
173		236
174	=over 4	237	=over 4
175		238
176	=item public nodes	239	=item norc => $boolean (default false)
177		240
178	For public nodes, C<$noderef> (supplied either directly to	241	If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
179	C<initialise_node> or indirectly via a profile or the nodename) must be a	242	be consulted - all configuraiton options must be specified in the
180	noderef (possibly unresolved, in which case it will be resolved).	243	C<configure> call.
181		244
182	After resolving, the node will bind itself on all endpoints.	245	=item force => $boolean (default false)
183		246
184	=item slave nodes	247	IF true, then the values specified in the C<configure> will take
185		248	precedence over any values configured via the rc file. The default is for
186	When the C<$noderef> (either as given or overriden by the config file)	249	the rc file to override any options specified in the program.
187	is the special string C<slave/>, then the node will become a slave
188	node. Slave nodes cannot be contacted from outside, and cannot talk to
189	each other (at least in this version of AnyEvent::MP).
190
191	Slave nodes work by creating connections to all public nodes, using the
192	L<AnyEvent::MP::Global> service.
193		250
194	=back	251	=back
195		252
196	After initialising itself, the node will connect to all additional
197	C<$seednodes> that are specified diretcly or via a profile. Seednodes are
198	optional and can be used to quickly bootstrap the node into an existing
199	network.
200
201	All the seednodes will also be specially marked to automatically retry
202	connecting to them indefinitely, so make sure that seednodes are really
203	reliable and up (this might also change in the future).
204
205	Example: become a public node listening on the guessed noderef, or the one
206	specified via C<aemp> for the current node. This should be the most common
207	form of invocation for "daemon"-type nodes.
208
209	initialise_node;
210
211	Example: become a slave node to any of the the seednodes specified via
212	C<aemp>. This form is often used for commandline clients.
213
214	initialise_node "slave/";
215
216	Example: become a public node, and try to contact some well-known master
217	servers to become part of the network.
218
219	initialise_node undef, "master1", "master2";
220
221	Example: become a public node listening on port C<4041>.
222
223	initialise_node 4041;
224
225	Example: become a public node, only visible on localhost port 4044.
226
227	initialise_node "localhost:4044";
228
229	=item $cv = resolve_node $noderef
230
231	Takes an unresolved node reference that may contain hostnames and
232	abbreviated IDs, resolves all of them and returns a resolved node
233	reference.
234
235	In addition to C<address:port> pairs allowed in resolved noderefs, the
236	following forms are supported:
237
238	=over 4	253	=over 4
239		254
240	=item the empty string	255	=item step 1, gathering configuration from profiles
241		256
242	An empty-string component gets resolved as if the default port (4040) was	257	The function first looks up a profile in the aemp configuration (see the
243	specified.	258	L<aemp> commandline utility). The profile name can be specified via the
		259	named C<profile> parameter or can simply be the first parameter). If it is
		260	missing, then the nodename (F<uname -n>) will be used as profile name.
244		261
245	=item naked port numbers (e.g. C<1234>)	262	The profile data is then gathered as follows:
246		263
247	These are resolved by prepending the local nodename and a colon, to be	264	First, all remaining key => value pairs (all of which are conveniently
248	further resolved.	265	undocumented at the moment) will be interpreted as configuration
		266	data. Then they will be overwritten by any values specified in the global
		267	default configuration (see the F<aemp> utility), then the chain of
		268	profiles chosen by the profile name (and any C<parent> attributes).
249		269
250	=item hostnames (e.g. C<localhost:1234>, C<localhost>)	270	That means that the values specified in the profile have highest priority
		271	and the values specified directly via C<configure> have lowest priority,
		272	and can only be used to specify defaults.
251		273
252	These are resolved by using AnyEvent::DNS to resolve them, optionally	274	If the profile specifies a node ID, then this will become the node ID of
253	looking up SRV records for the C<aemp=4040> port, if no port was	275	this process. If not, then the profile name will be used as node ID, with
254	specified.	276	a slash (C</>) attached.
		277
		278	If the node ID (or profile name) ends with a slash (C</>), then a random
		279	string is appended to make it unique.
		280
		281	=item step 2, bind listener sockets
		282
		283	The next step is to look up the binds in the profile, followed by binding
		284	aemp protocol listeners on all binds specified (it is possible and valid
		285	to have no binds, meaning that the node cannot be contacted form the
		286	outside. This means the node cannot talk to other nodes that also have no
		287	binds, but it can still talk to all "normal" nodes).
		288
		289	If the profile does not specify a binds list, then a default of C<*> is
		290	used, meaning the node will bind on a dynamically-assigned port on every
		291	local IP address it finds.
		292
		293	=item step 3, connect to seed nodes
		294
		295	As the last step, the seed ID list from the profile is passed to the
		296	L<AnyEvent::MP::Global> module, which will then use it to keep
		297	connectivity with at least one node at any point in time.
255		298
256	=back	299	=back
		300
		301	Example: become a distributed node using the local node name as profile.
		302	This should be the most common form of invocation for "daemon"-type nodes.
		303
		304	configure
		305
		306	Example: become an anonymous node. This form is often used for commandline
		307	clients.
		308
		309	configure nodeid => "anon/";
		310
		311	Example: configure a node using a profile called seed, which is suitable
		312	for a seed node as it binds on all local addresses on a fixed port (4040,
		313	customary for aemp).
		314
		315	# use the aemp commandline utility
		316	# aemp profile seed binds '*:4040'
		317
		318	# then use it
		319	configure profile => "seed";
		320
		321	# or simply use aemp from the shell again:
		322	# aemp run profile seed
		323
		324	# or provide a nicer-to-remember nodeid
		325	# aemp run profile seed nodeid "$(hostname)"
257		326
258	=item $SELF	327	=item $SELF
259		328
260	Contains the current port id while executing C<rcv> callbacks or C<psub>	329	Contains the current port id while executing C<rcv> callbacks or C<psub>
261	blocks.	330	blocks.
262		331
263	=item SELF, %SELF, @SELF...	332	=item *SELF, SELF, %SELF, @SELF...
264		333
265	Due to some quirks in how perl exports variables, it is impossible to	334	Due to some quirks in how perl exports variables, it is impossible to
266	just export C<$SELF>, all the symbols called C<SELF> are exported by this	335	just export C<$SELF>, all the symbols named C<SELF> are exported by this
267	module, but only C<$SELF> is currently used.	336	module, but only C<$SELF> is currently used.
268		337
269	=item snd $port, type => @data	338	=item snd $port, type => @data
270		339
271	=item snd $port, @msg	340	=item snd $port, @msg
272		341
273	Send the given message to the given port ID, which can identify either	342	Send the given message to the given port, which can identify either a
274	a local or a remote port, and must be a port ID.	343	local or a remote port, and must be a port ID.
275		344
276	While the message can be about anything, it is highly recommended to use a	345	While the message can be almost anything, it is highly recommended to
277	string as first element (a port ID, or some word that indicates a request	346	use a string as first element (a port ID, or some word that indicates a
278	type etc.).	347	request type etc.) and to consist if only simple perl values (scalars,
		348	arrays, hashes) - if you think you need to pass an object, think again.
279		349
280	The message data effectively becomes read-only after a call to this	350	The message data logically becomes read-only after a call to this
281	function: modifying any argument is not allowed and can cause many	351	function: modifying any argument (or values referenced by them) is
282	problems.	352	forbidden, as there can be considerable time between the call to C<snd>
		353	and the time the message is actually being serialised - in fact, it might
		354	never be copied as within the same process it is simply handed to the
		355	receiving port.
283		356
284	The type of data you can transfer depends on the transport protocol: when	357	The type of data you can transfer depends on the transport protocol: when
285	JSON is used, then only strings, numbers and arrays and hashes consisting	358	JSON is used, then only strings, numbers and arrays and hashes consisting
286	of those are allowed (no objects). When Storable is used, then anything	359	of those are allowed (no objects). When Storable is used, then anything
287	that Storable can serialise and deserialise is allowed, and for the local	360	that Storable can serialise and deserialise is allowed, and for the local
288	node, anything can be passed.	361	node, anything can be passed. Best rely only on the common denominator of
		362	these.
289		363
290	=item $local_port = port	364	=item $local_port = port
291		365
292	Create a new local port object and returns its port ID. Initially it has	366	Create a new local port object and returns its port ID. Initially it has
293	no callbacks set and will throw an error when it receives messages.	367	no callbacks set and will throw an error when it receives messages.
…		…
317	sub _kilme {	391	sub _kilme {
318	die "received message on port without callback";	392	die "received message on port without callback";
319	}	393	}
320		394
321	sub port(;&) {	395	sub port(;&) {
322	my $id = "$UNIQ." . $ID++;	396	my $id = $UNIQ . ++$ID;
323	my $port = "$NODE#$id";	397	my $port = "$NODE#$id";
324		398
325	rcv $port, shift \|\| \&_kilme;	399	rcv $port, shift \|\| \&_kilme;
326		400
327	$port	401	$port
…		…
366	msg1 => sub { ... },	440	msg1 => sub { ... },
367	...	441	...
368	;	442	;
369		443
370	Example: temporarily register a rcv callback for a tag matching some port	444	Example: temporarily register a rcv callback for a tag matching some port
371	(e.g. for a rpc reply) and unregister it after a message was received.	445	(e.g. for an rpc reply) and unregister it after a message was received.
372		446
373	rcv $port, $otherport => sub {	447	rcv $port, $otherport => sub {
374	my @reply = @_;	448	my @reply = @_;
375		449
376	rcv $SELF, $otherport;	450	rcv $SELF, $otherport;
…		…
378		452
379	=cut	453	=cut
380		454
381	sub rcv($@) {	455	sub rcv($@) {
382	my $port = shift;	456	my $port = shift;
383	my ($noderef, $portid) = split /#/, $port, 2;	457	my ($nodeid, $portid) = split /#/, $port, 2;
384		458
385	$NODE{$noderef} == $NODE{""}	459	$NODE{$nodeid} == $NODE{""}
386	or Carp::croak "$port: rcv can only be called on local ports, caught";	460	or Carp::croak "$port: rcv can only be called on local ports, caught";
387		461
388	while (@_) {	462	while (@_) {
389	if (ref $_[0]) {	463	if (ref $_[0]) {
390	if (my $self = $PORT_DATA{$portid}) {	464	if (my $self = $PORT_DATA{$portid}) {
391	"AnyEvent::MP::Port" eq ref $self	465	"AnyEvent::MP::Port" eq ref $self
392	or Carp::croak "$port: rcv can only be called on message matching ports, caught";	466	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
393		467
394	$self->[2] = shift;	468	$self->[0] = shift;
395	} else {	469	} else {
396	my $cb = shift;	470	my $cb = shift;
397	$PORT{$portid} = sub {	471	$PORT{$portid} = sub {
398	local $SELF = $port;	472	local $SELF = $port;
399	eval { &$cb }; _self_die if $@;	473	eval { &$cb }; _self_die if $@;
400	};	474	};
401	}	475	}
402	} elsif (defined $_[0]) {	476	} elsif (defined $_[0]) {
403	my $self = $PORT_DATA{$portid} \|\|= do {	477	my $self = $PORT_DATA{$portid} \|\|= do {
404	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";	478	my $self = bless [$PORT{$portid} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
405		479
406	$PORT{$portid} = sub {	480	$PORT{$portid} = sub {
407	local $SELF = $port;	481	local $SELF = $port;
408		482
409	if (my $cb = $self->[1]{$_[0]}) {	483	if (my $cb = $self->[1]{$_[0]}) {
…		…
431	}	505	}
432		506
433	$port	507	$port
434	}	508	}
435		509
		510	=item peval $port, $coderef[, @args]
		511
		512	Evaluates the given C<$codref> within the contetx of C<$port>, that is,
		513	when the code throews an exception the C<$port> will be killed.
		514
		515	Any remaining args will be passed to the callback. Any return values will
		516	be returned to the caller.
		517
		518	This is useful when you temporarily want to execute code in the context of
		519	a port.
		520
		521	Example: create a port and run some initialisation code in it's context.
		522
		523	my $port = port { ... };
		524
		525	peval $port, sub {
		526	init
		527	or die "unable to init";
		528	};
		529
		530	=cut
		531
		532	sub peval($$) {
		533	local $SELF = shift;
		534	my $cb = shift;
		535
		536	if (wantarray) {
		537	my @res = eval { &$cb };
		538	_self_die if $@;
		539	@res
		540	} else {
		541	my $res = eval { &$cb };
		542	_self_die if $@;
		543	$res
		544	}
		545	}
		546
436	=item $closure = psub { BLOCK }	547	=item $closure = psub { BLOCK }
437		548
438	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	549	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
439	closure is executed, sets up the environment in the same way as in C<rcv>	550	closure is executed, sets up the environment in the same way as in C<rcv>
440	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.	551	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		552
		553	The effect is basically as if it returned C<< sub { peval $SELF, sub {
		554	BLOCK }, @_ } >>.
441		555
442	This is useful when you register callbacks from C<rcv> callbacks:	556	This is useful when you register callbacks from C<rcv> callbacks:
443		557
444	rcv delayed_reply => sub {	558	rcv delayed_reply => sub {
445	my ($delay, @reply) = @_;	559	my ($delay, @reply) = @_;
…		…
469	$res	583	$res
470	}	584	}
471	}	585	}
472	}	586	}
473		587
474	=item $guard = mon $port, $cb->(@reason)	588	=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
475		589
476	=item $guard = mon $port, $rcvport	590	=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
477		591
478	=item $guard = mon $port	592	=item $guard = mon $port # kill $SELF when $port dies
479		593
480	=item $guard = mon $port, $rcvport, @msg	594	=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
481		595
482	Monitor the given port and do something when the port is killed or	596	Monitor the given port and do something when the port is killed or
483	messages to it were lost, and optionally return a guard that can be used	597	messages to it were lost, and optionally return a guard that can be used
484	to stop monitoring again.	598	to stop monitoring again.
485
486	C<mon> effectively guarantees that, in the absence of hardware failures,
487	that after starting the monitor, either all messages sent to the port
488	will arrive, or the monitoring action will be invoked after possible
489	message loss has been detected. No messages will be lost "in between"
490	(after the first lost message no further messages will be received by the
491	port). After the monitoring action was invoked, further messages might get
492	delivered again.
493
494	Note that monitoring-actions are one-shot: once released, they are removed
495	and will not trigger again.
496		599
497	In the first form (callback), the callback is simply called with any	600	In the first form (callback), the callback is simply called with any
498	number of C<@reason> elements (no @reason means that the port was deleted	601	number of C<@reason> elements (no @reason means that the port was deleted
499	"normally"). Note also that I<< the callback B<must> never die >>, so use	602	"normally"). Note also that I<< the callback B<must> never die >>, so use
500	C<eval> if unsure.	603	C<eval> if unsure.
501		604
502	In the second form (another port given), the other port (C<$rcvport>)	605	In the second form (another port given), the other port (C<$rcvport>)
503	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on	606	will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
504	"normal" kils nothing happens, while under all other conditions, the other	607	"normal" kils nothing happens, while under all other conditions, the other
505	port is killed with the same reason.	608	port is killed with the same reason.
506		609
507	The third form (kill self) is the same as the second form, except that	610	The third form (kill self) is the same as the second form, except that
508	C<$rvport> defaults to C<$SELF>.	611	C<$rvport> defaults to C<$SELF>.
509		612
510	In the last form (message), a message of the form C<@msg, @reason> will be	613	In the last form (message), a message of the form C<@msg, @reason> will be
511	C<snd>.	614	C<snd>.
		615
		616	Monitoring-actions are one-shot: once messages are lost (and a monitoring
		617	alert was raised), they are removed and will not trigger again.
512		618
513	As a rule of thumb, monitoring requests should always monitor a port from	619	As a rule of thumb, monitoring requests should always monitor a port from
514	a local port (or callback). The reason is that kill messages might get	620	a local port (or callback). The reason is that kill messages might get
515	lost, just like any other message. Another less obvious reason is that	621	lost, just like any other message. Another less obvious reason is that
516	even monitoring requests can get lost (for exmaple, when the connection	622	even monitoring requests can get lost (for example, when the connection
517	to the other node goes down permanently). When monitoring a port locally	623	to the other node goes down permanently). When monitoring a port locally
518	these problems do not exist.	624	these problems do not exist.
519		625
		626	C<mon> effectively guarantees that, in the absence of hardware failures,
		627	after starting the monitor, either all messages sent to the port will
		628	arrive, or the monitoring action will be invoked after possible message
		629	loss has been detected. No messages will be lost "in between" (after
		630	the first lost message no further messages will be received by the
		631	port). After the monitoring action was invoked, further messages might get
		632	delivered again.
		633
		634	Inter-host-connection timeouts and monitoring depend on the transport
		635	used. The only transport currently implemented is TCP, and AnyEvent::MP
		636	relies on TCP to detect node-downs (this can take 10-15 minutes on a
		637	non-idle connection, and usually around two hours for idle connections).
		638
		639	This means that monitoring is good for program errors and cleaning up
		640	stuff eventually, but they are no replacement for a timeout when you need
		641	to ensure some maximum latency.
		642
520	Example: call a given callback when C<$port> is killed.	643	Example: call a given callback when C<$port> is killed.
521		644
522	mon $port, sub { warn "port died because of <@_>\n" };	645	mon $port, sub { warn "port died because of <@_>\n" };
523		646
524	Example: kill ourselves when C<$port> is killed abnormally.	647	Example: kill ourselves when C<$port> is killed abnormally.
…		…
530	mon $port, $self => "restart";	653	mon $port, $self => "restart";
531		654
532	=cut	655	=cut
533		656
534	sub mon {	657	sub mon {
535	my ($noderef, $port) = split /#/, shift, 2;	658	my ($nodeid, $port) = split /#/, shift, 2;
536		659
537	my $node = $NODE{$noderef} \|\| add_node $noderef;	660	my $node = $NODE{$nodeid} \|\| add_node $nodeid;
538		661
539	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';	662	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
540		663
541	unless (ref $cb) {	664	unless (ref $cb) {
542	if (@_) {	665	if (@_) {
…		…
551	}	674	}
552		675
553	$node->monitor ($port, $cb);	676	$node->monitor ($port, $cb);
554		677
555	defined wantarray	678	defined wantarray
556	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	679	and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) })
557	}	680	}
558		681
559	=item $guard = mon_guard $port, $ref, $ref...	682	=item $guard = mon_guard $port, $ref, $ref...
560		683
561	Monitors the given C<$port> and keeps the passed references. When the port	684	Monitors the given C<$port> and keeps the passed references. When the port
562	is killed, the references will be freed.	685	is killed, the references will be freed.
563		686
564	Optionally returns a guard that will stop the monitoring.	687	Optionally returns a guard that will stop the monitoring.
565		688
566	This function is useful when you create e.g. timers or other watchers and	689	This function is useful when you create e.g. timers or other watchers and
567	want to free them when the port gets killed:	690	want to free them when the port gets killed (note the use of C<psub>):
568		691
569	$port->rcv (start => sub {	692	$port->rcv (start => sub {
570	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {	693	my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
571	undef $timer if 0.9 < rand;	694	undef $timer if 0.9 < rand;
572	});	695	});
573	});	696	});
574		697
575	=cut	698	=cut
…		…
584		707
585	=item kil $port[, @reason]	708	=item kil $port[, @reason]
586		709
587	Kill the specified port with the given C<@reason>.	710	Kill the specified port with the given C<@reason>.
588		711
589	If no C<@reason> is specified, then the port is killed "normally" (linked	712	If no C<@reason> is specified, then the port is killed "normally" -
590	ports will not be kileld, or even notified).	713	monitor callback will be invoked, but the kil will not cause linked ports
		714	(C<mon $mport, $lport> form) to get killed.
591		715
592	Otherwise, linked ports get killed with the same reason (second form of	716	If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
593	C<mon>, see below).	717	form) get killed with the same reason.
594		718
595	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	719	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
596	will be reported as reason C<< die => $@ >>.	720	will be reported as reason C<< die => $@ >>.
597		721
598	Transport/communication errors are reported as C<< transport_error =>	722	Transport/communication errors are reported as C<< transport_error =>
…		…
603	=item $port = spawn $node, $initfunc[, @initdata]	727	=item $port = spawn $node, $initfunc[, @initdata]
604		728
605	Creates a port on the node C<$node> (which can also be a port ID, in which	729	Creates a port on the node C<$node> (which can also be a port ID, in which
606	case it's the node where that port resides).	730	case it's the node where that port resides).
607		731
608	The port ID of the newly created port is return immediately, and it is	732	The port ID of the newly created port is returned immediately, and it is
609	permissible to immediately start sending messages or monitor the port.	733	possible to immediately start sending messages or to monitor the port.
610		734
611	After the port has been created, the init function is	735	After the port has been created, the init function is called on the remote
612	called. This function must be a fully-qualified function name	736	node, in the same context as a C<rcv> callback. This function must be a
613	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main	737	fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
614	program, use C<::name>.	738	specify a function in the main program, use C<::name>.
615		739
616	If the function doesn't exist, then the node tries to C<require>	740	If the function doesn't exist, then the node tries to C<require>
617	the package, then the package above the package and so on (e.g.	741	the package, then the package above the package and so on (e.g.
618	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function	742	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
619	exists or it runs out of package names.	743	exists or it runs out of package names.
620		744
621	The init function is then called with the newly-created port as context	745	The init function is then called with the newly-created port as context
622	object (C<$SELF>) and the C<@initdata> values as arguments.	746	object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
		747	call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
		748	the port might not get created.
623		749
624	A common idiom is to pass your own port, monitor the spawned port, and	750	A common idiom is to pass a local port, immediately monitor the spawned
625	in the init function, monitor the original port. This two-way monitoring	751	port, and in the remote init function, immediately monitor the passed
626	ensures that both ports get cleaned up when there is a problem.	752	local port. This two-way monitoring ensures that both ports get cleaned up
		753	when there is a problem.
		754
		755	C<spawn> guarantees that the C<$initfunc> has no visible effects on the
		756	caller before C<spawn> returns (by delaying invocation when spawn is
		757	called for the local node).
627		758
628	Example: spawn a chat server port on C<$othernode>.	759	Example: spawn a chat server port on C<$othernode>.
629		760
630	# this node, executed from within a port context:	761	# this node, executed from within a port context:
631	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;	762	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
…		…
646		777
647	sub _spawn {	778	sub _spawn {
648	my $port = shift;	779	my $port = shift;
649	my $init = shift;	780	my $init = shift;
650		781
		782	# rcv will create the actual port
651	local $SELF = "$NODE#$port";	783	local $SELF = "$NODE#$port";
652	eval {	784	eval {
653	&{ load_func $init }	785	&{ load_func $init }
654	};	786	};
655	_self_die if $@;	787	_self_die if $@;
656	}	788	}
657		789
658	sub spawn(@) {	790	sub spawn(@) {
659	my ($noderef, undef) = split /#/, shift, 2;	791	my ($nodeid, undef) = split /#/, shift, 2;
660		792
661	my $id = "$RUNIQ." . $ID++;	793	my $id = $RUNIQ . ++$ID;
662		794
663	$_[0] =~ /::/	795	$_[0] =~ /::/
664	or Carp::croak "spawn init function must be a fully-qualified name, caught";	796	or Carp::croak "spawn init function must be a fully-qualified name, caught";
665		797
666	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;	798	snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
667		799
668	"$noderef#$id"	800	"$nodeid#$id"
669	}	801	}
		802
670		803
671	=item after $timeout, @msg	804	=item after $timeout, @msg
672		805
673	=item after $timeout, $callback	806	=item after $timeout, $callback
674		807
675	Either sends the given message, or call the given callback, after the	808	Either sends the given message, or call the given callback, after the
676	specified number of seconds.	809	specified number of seconds.
677		810
678	This is simply a utility function that come sin handy at times.	811	This is simply a utility function that comes in handy at times - the
		812	AnyEvent::MP author is not convinced of the wisdom of having it, though,
		813	so it may go away in the future.
679		814
680	=cut	815	=cut
681		816
682	sub after($@) {	817	sub after($@) {
683	my ($timeout, @action) = @_;	818	my ($timeout, @action) = @_;
…		…
688	? $action[0]()	823	? $action[0]()
689	: snd @action;	824	: snd @action;
690	};	825	};
691	}	826	}
692		827
		828	=item cal $port, @msg, $callback[, $timeout]
		829
		830	A simple form of RPC - sends a message to the given C<$port> with the
		831	given contents (C<@msg>), but adds a reply port to the message.
		832
		833	The reply port is created temporarily just for the purpose of receiving
		834	the reply, and will be C<kil>ed when no longer needed.
		835
		836	A reply message sent to the port is passed to the C<$callback> as-is.
		837
		838	If an optional time-out (in seconds) is given and it is not C<undef>,
		839	then the callback will be called without any arguments after the time-out
		840	elapsed and the port is C<kil>ed.
		841
		842	If no time-out is given (or it is C<undef>), then the local port will
		843	monitor the remote port instead, so it eventually gets cleaned-up.
		844
		845	Currently this function returns the temporary port, but this "feature"
		846	might go in future versions unless you can make a convincing case that
		847	this is indeed useful for something.
		848
		849	=cut
		850
		851	sub cal(@) {
		852	my $timeout = ref $_[-1] ? undef : pop;
		853	my $cb = pop;
		854
		855	my $port = port {
		856	undef $timeout;
		857	kil $SELF;
		858	&$cb;
		859	};
		860
		861	if (defined $timeout) {
		862	$timeout = AE::timer $timeout, 0, sub {
		863	undef $timeout;
		864	kil $port;
		865	$cb->();
		866	};
		867	} else {
		868	mon $_[0], sub {
		869	kil $port;
		870	$cb->();
		871	};
		872	}
		873
		874	push @_, $port;
		875	&snd;
		876
		877	$port
		878	}
		879
		880	=back
		881
		882	=head1 DISTRIBUTED DATABASE
		883
		884	AnyEvent::MP comes with a simple distributed database. The database will
		885	be mirrored asynchronously at all global nodes. Other nodes bind to one of
		886	the global nodes for their needs.
		887
		888	The database consists of a two-level hash - a hash contains a hash which
		889	contains values.
		890
		891	The top level hash key is called "family", and the second-level hash key
		892	is simply called "key".
		893
		894	The family must be alphanumeric, i.e. start with a letter and consist
		895	of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>,
		896	pretty much like Perl module names.
		897
		898	As the family namespace is global, it is recommended to prefix family names
		899	with the name of the application or module using it.
		900
		901	The keys must be strings, with no other limitations.
		902
		903	The values should preferably be strings, but other perl scalars should
		904	work as well (such as undef, arrays and hashes).
		905
		906	Every database entry is owned by one node - adding the same family/key
		907	combination on multiple nodes will not cause discomfort for AnyEvent::MP,
		908	but the result might be nondeterministic, i.e. the key might have
		909	different values on different nodes.
		910
		911	=item db_set $family => $key => $value
		912
		913	Sets (or replaces) a key to the database.
		914
		915	=item db_del $family => $key
		916
		917	Deletes a key from the database.
		918
		919	=item $guard = db_reg $family => $key [=> $value]
		920
		921	Sets the key on the database and returns a guard. When the guard is
		922	destroyed, the key is deleted from the database. If C<$value> is missing,
		923	then C<undef> is used.
		924
		925	=cut
		926
693	=back	927	=back
694		928
695	=head1 AnyEvent::MP vs. Distributed Erlang	929	=head1 AnyEvent::MP vs. Distributed Erlang
696		930
697	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node	931	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
698	== aemp node, Erlang process == aemp port), so many of the documents and	932	== aemp node, Erlang process == aemp port), so many of the documents and
699	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a	933	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
700	sample:	934	sample:
701		935
702	http://www.Erlang.se/doc/programming_rules.shtml	936	http://www.erlang.se/doc/programming_rules.shtml
703	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	937	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
704	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6	938	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
705	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	939	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
706		940
707	Despite the similarities, there are also some important differences:	941	Despite the similarities, there are also some important differences:
708		942
709	=over 4	943	=over 4
710		944
711	=item * Node references contain the recipe on how to contact them.	945	=item * Node IDs are arbitrary strings in AEMP.
712		946
713	Erlang relies on special naming and DNS to work everywhere in the	947	Erlang relies on special naming and DNS to work everywhere in the same
714	same way. AEMP relies on each node knowing it's own address(es), with	948	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
715	convenience functionality.	949	configuration or DNS), and possibly the addresses of some seed nodes, but
716		950	will otherwise discover other nodes (and their IDs) itself.
717	This means that AEMP requires a less tightly controlled environment at the
718	cost of longer node references and a slightly higher management overhead.
719		951
720	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP	952	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
721	uses "local ports are like remote ports".	953	uses "local ports are like remote ports".
722		954
723	The failure modes for local ports are quite different (runtime errors	955	The failure modes for local ports are quite different (runtime errors
…		…
732	ports being the special case/exception, where transport errors cannot	964	ports being the special case/exception, where transport errors cannot
733	occur.	965	occur.
734		966
735	=item * Erlang uses processes and a mailbox, AEMP does not queue.	967	=item * Erlang uses processes and a mailbox, AEMP does not queue.
736		968
737	Erlang uses processes that selectively receive messages, and therefore	969	Erlang uses processes that selectively receive messages out of order, and
738	needs a queue. AEMP is event based, queuing messages would serve no	970	therefore needs a queue. AEMP is event based, queuing messages would serve
739	useful purpose. For the same reason the pattern-matching abilities of	971	no useful purpose. For the same reason the pattern-matching abilities
740	AnyEvent::MP are more limited, as there is little need to be able to	972	of AnyEvent::MP are more limited, as there is little need to be able to
741	filter messages without dequeing them.	973	filter messages without dequeuing them.
742		974
743	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).	975	This is not a philosophical difference, but simply stems from AnyEvent::MP
		976	being event-based, while Erlang is process-based.
		977
		978	You cna have a look at L<Coro::MP> for a more Erlang-like process model on
		979	top of AEMP and Coro threads.
744		980
745	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	981	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
746		982
747	Sending messages in Erlang is synchronous and blocks the process (and	983	Sending messages in Erlang is synchronous and blocks the process until
		984	a conenction has been established and the message sent (and so does not
748	so does not need a queue that can overflow). AEMP sends are immediate,	985	need a queue that can overflow). AEMP sends return immediately, connection
749	connection establishment is handled in the background.	986	establishment is handled in the background.
750		987
751	=item * Erlang suffers from silent message loss, AEMP does not.	988	=item * Erlang suffers from silent message loss, AEMP does not.
752		989
753	Erlang makes few guarantees on messages delivery - messages can get lost	990	Erlang implements few guarantees on messages delivery - messages can get
754	without any of the processes realising it (i.e. you send messages a, b,	991	lost without any of the processes realising it (i.e. you send messages a,
755	and c, and the other side only receives messages a and c).	992	b, and c, and the other side only receives messages a and c).
756		993
757	AEMP guarantees correct ordering, and the guarantee that there are no	994	AEMP guarantees (modulo hardware errors) correct ordering, and the
		995	guarantee that after one message is lost, all following ones sent to the
		996	same port are lost as well, until monitoring raises an error, so there are
758	holes in the message sequence.	997	no silent "holes" in the message sequence.
759		998
760	=item * In Erlang, processes can be declared dead and later be found to be	999	If you want your software to be very reliable, you have to cope with
761	alive.	1000	corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
762		1001	simply tries to work better in common error cases, such as when a network
763	In Erlang it can happen that a monitored process is declared dead and	1002	link goes down.
764	linked processes get killed, but later it turns out that the process is
765	still alive - and can receive messages.
766
767	In AEMP, when port monitoring detects a port as dead, then that port will
768	eventually be killed - it cannot happen that a node detects a port as dead
769	and then later sends messages to it, finding it is still alive.
770		1003
771	=item * Erlang can send messages to the wrong port, AEMP does not.	1004	=item * Erlang can send messages to the wrong port, AEMP does not.
772		1005
773	In Erlang it is quite likely that a node that restarts reuses a process ID	1006	In Erlang it is quite likely that a node that restarts reuses an Erlang
774	known to other nodes for a completely different process, causing messages	1007	process ID known to other nodes for a completely different process,
775	destined for that process to end up in an unrelated process.	1008	causing messages destined for that process to end up in an unrelated
		1009	process.
776		1010
777	AEMP never reuses port IDs, so old messages or old port IDs floating	1011	AEMP does not reuse port IDs, so old messages or old port IDs floating
778	around in the network will not be sent to an unrelated port.	1012	around in the network will not be sent to an unrelated port.
779		1013
780	=item * Erlang uses unprotected connections, AEMP uses secure	1014	=item * Erlang uses unprotected connections, AEMP uses secure
781	authentication and can use TLS.	1015	authentication and can use TLS.
782		1016
783	AEMP can use a proven protocol - SSL/TLS - to protect connections and	1017	AEMP can use a proven protocol - TLS - to protect connections and
784	securely authenticate nodes.	1018	securely authenticate nodes.
785		1019
786	=item * The AEMP protocol is optimised for both text-based and binary	1020	=item * The AEMP protocol is optimised for both text-based and binary
787	communications.	1021	communications.
788		1022
789	The AEMP protocol, unlike the Erlang protocol, supports both	1023	The AEMP protocol, unlike the Erlang protocol, supports both programming
790	language-independent text-only protocols (good for debugging) and binary,	1024	language independent text-only protocols (good for debugging), and binary,
791	language-specific serialisers (e.g. Storable).	1025	language-specific serialisers (e.g. Storable). By default, unless TLS is
		1026	used, the protocol is actually completely text-based.
792		1027
793	It has also been carefully designed to be implementable in other languages	1028	It has also been carefully designed to be implementable in other languages
794	with a minimum of work while gracefully degrading fucntionality to make the	1029	with a minimum of work while gracefully degrading functionality to make the
795	protocol simple.	1030	protocol simple.
796		1031
797	=item * AEMP has more flexible monitoring options than Erlang.	1032	=item * AEMP has more flexible monitoring options than Erlang.
798		1033
799	In Erlang, you can chose to receive I<all> exit signals as messages	1034	In Erlang, you can chose to receive I<all> exit signals as messages or
800	or I<none>, there is no in-between, so monitoring single processes is	1035	I<none>, there is no in-between, so monitoring single Erlang processes is
801	difficult to implement. Monitoring in AEMP is more flexible than in	1036	difficult to implement.
802	Erlang, as one can choose between automatic kill, exit message or callback	1037
803	on a per-process basis.	1038	Monitoring in AEMP is more flexible than in Erlang, as one can choose
		1039	between automatic kill, exit message or callback on a per-port basis.
804		1040
805	=item * Erlang tries to hide remote/local connections, AEMP does not.	1041	=item * Erlang tries to hide remote/local connections, AEMP does not.
806		1042
807	Monitoring in Erlang is not an indicator of process death/crashes,	1043	Monitoring in Erlang is not an indicator of process death/crashes, in the
808	as linking is (except linking is unreliable in Erlang).	1044	same way as linking is (except linking is unreliable in Erlang).
809		1045
810	In AEMP, you don't "look up" registered port names or send to named ports	1046	In AEMP, you don't "look up" registered port names or send to named ports
811	that might or might not be persistent. Instead, you normally spawn a port	1047	that might or might not be persistent. Instead, you normally spawn a port
812	on the remote node. The init function monitors the you, and you monitor	1048	on the remote node. The init function monitors you, and you monitor the
813	the remote port. Since both monitors are local to the node, they are much	1049	remote port. Since both monitors are local to the node, they are much more
814	more reliable.	1050	reliable (no need for C<spawn_link>).
815		1051
816	This also saves round-trips and avoids sending messages to the wrong port	1052	This also saves round-trips and avoids sending messages to the wrong port
817	(hard to do in Erlang).	1053	(hard to do in Erlang).
818		1054
819	=back	1055	=back
820		1056
821	=head1 RATIONALE	1057	=head1 RATIONALE
822		1058
823	=over 4	1059	=over 4
824		1060
825	=item Why strings for ports and noderefs, why not objects?	1061	=item Why strings for port and node IDs, why not objects?
826		1062
827	We considered "objects", but found that the actual number of methods	1063	We considered "objects", but found that the actual number of methods
828	thatc an be called are very low. Since port IDs and noderefs travel over	1064	that can be called are quite low. Since port and node IDs travel over
829	the network frequently, the serialising/deserialising would add lots of	1065	the network frequently, the serialising/deserialising would add lots of
830	overhead, as well as having to keep a proxy object.	1066	overhead, as well as having to keep a proxy object everywhere.
831		1067
832	Strings can easily be printed, easily serialised etc. and need no special	1068	Strings can easily be printed, easily serialised etc. and need no special
833	procedures to be "valid".	1069	procedures to be "valid".
834		1070
835	And a a miniport consists of a single closure stored in a global hash - it	1071	And as a result, a port with just a default receiver consists of a single
836	can't become much cheaper.	1072	code reference stored in a global hash - it can't become much cheaper.
837		1073
838	=item Why favour JSON, why not real serialising format such as Storable?	1074	=item Why favour JSON, why not a real serialising format such as Storable?
839		1075
840	In fact, any AnyEvent::MP node will happily accept Storable as framing	1076	In fact, any AnyEvent::MP node will happily accept Storable as framing
841	format, but currently there is no way to make a node use Storable by	1077	format, but currently there is no way to make a node use Storable by
842	default.	1078	default (although all nodes will accept it).
843		1079
844	The default framing protocol is JSON because a) JSON::XS is many times	1080	The default framing protocol is JSON because a) JSON::XS is many times
845	faster for small messages and b) most importantly, after years of	1081	faster for small messages and b) most importantly, after years of
846	experience we found that object serialisation is causing more problems	1082	experience we found that object serialisation is causing more problems
847	than it gains: Just like function calls, objects simply do not travel	1083	than it solves: Just like function calls, objects simply do not travel
848	easily over the network, mostly because they will always be a copy, so you	1084	easily over the network, mostly because they will always be a copy, so you
849	always have to re-think your design.	1085	always have to re-think your design.
850		1086
851	Keeping your messages simple, concentrating on data structures rather than	1087	Keeping your messages simple, concentrating on data structures rather than
852	objects, will keep your messages clean, tidy and efficient.	1088	objects, will keep your messages clean, tidy and efficient.
853		1089
854	=back	1090	=back
855		1091
856	=head1 SEE ALSO	1092	=head1 SEE ALSO
857		1093
		1094	L<AnyEvent::MP::Intro> - a gentle introduction.
		1095
		1096	L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
		1097
		1098	L<AnyEvent::MP::Global> - network maintenance and port groups, to find
		1099	your applications.
		1100
		1101	L<AnyEvent::MP::DataConn> - establish data connections between nodes.
		1102
		1103	L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
		1104	all nodes.
		1105
858	L<AnyEvent>.	1106	L<AnyEvent>.
859		1107
860	=head1 AUTHOR	1108	=head1 AUTHOR
861		1109
862	Marc Lehmann <schmorp@schmorp.de>	1110	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC vs. Revision 1.125 by root, Sat Mar 3 13:07:19 2012 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC vs.
Revision 1.125 by root, Sat Mar 3 13:07:19 2012 UTC