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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.29 by root, Tue Aug 4 23:16:57 2009 UTC vs.
Revision 1.36 by root, Thu Aug 6 10:46:48 2009 UTC

…		…
23		23
24	# more, smarter, matches (_any_ is exported by this module)	24	# more, smarter, matches (_any_ is exported by this module)
25	rcv $port, [child_died => $pid] => sub { ...	25	rcv $port, [child_died => $pid] => sub { ...
26	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	26	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
27		27
		28	# linking two ports, so they both crash together
		29	lnk $port1, $port2;
		30
		31	# monitoring
		32	mon $port, $cb->(@msg) # callback is invoked on death
		33	mon $port, $otherport # kill otherport on abnormal death
		34	mon $port, $otherport, @msg # send message on death
		35
28	=head1 DESCRIPTION	36	=head1 DESCRIPTION
29		37
30	This module (-family) implements a simple message passing framework.	38	This module (-family) implements a simple message passing framework.
31		39
32	Despite its simplicity, you can securely message other processes running	40	Despite its simplicity, you can securely message other processes running
…		…
53		61
54	=item port id - C<noderef#portname>	62	=item port id - C<noderef#portname>
55		63
56	A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as	64	A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as
57	separator, and a port name (a printable string of unspecified format). An	65	separator, and a port name (a printable string of unspecified format). An
58	exception is the the node port, whose ID is identical to it's node	66	exception is the the node port, whose ID is identical to its node
59	reference.	67	reference.
60		68
61	=item node	69	=item node
62		70
63	A node is a single process containing at least one port - the node	71	A node is a single process containing at least one port - the node
…		…
103	use base "Exporter";	111	use base "Exporter";
104		112
105	our $VERSION = '0.1';	113	our $VERSION = '0.1';
106	our @EXPORT = qw(	114	our @EXPORT = qw(
107	NODE $NODE *SELF node_of _any_	115	NODE $NODE *SELF node_of _any_
108	resolve_node	116	resolve_node initialise_node
109	become_slave become_public
110	snd rcv mon kil reg psub	117	snd rcv mon kil reg psub
111	port	118	port
112	);	119	);
113		120
114	our $SELF;	121	our $SELF;
…		…
124	The C<NODE> function returns, and the C<$NODE> variable contains	131	The C<NODE> function returns, and the C<$NODE> variable contains
125	the noderef of the local node. The value is initialised by a call	132	the noderef of the local node. The value is initialised by a call
126	to C<become_public> or C<become_slave>, after which all local port	133	to C<become_public> or C<become_slave>, after which all local port
127	identifiers become invalid.	134	identifiers become invalid.
128		135
129	=item $noderef = node_of $portid	136	=item $noderef = node_of $port
130		137
131	Extracts and returns the noderef from a portid or a noderef.	138	Extracts and returns the noderef from a portid or a noderef.
		139
		140	=item initialise_node $noderef, $seednode, $seednode...
		141
		142	=item initialise_node "slave/", $master, $master...
		143
		144	Before a node can talk to other nodes on the network it has to initialise
		145	itself - the minimum a node needs to know is it's own name, and optionally
		146	it should know the noderefs of some other nodes in the network.
		147
		148	This function initialises a node - it must be called exactly once (or
		149	never) before calling other AnyEvent::MP functions.
		150
		151	All arguments are noderefs, which can be either resolved or unresolved.
		152
		153	There are two types of networked nodes, public nodes and slave nodes:
		154
		155	=over 4
		156
		157	=item public nodes
		158
		159	For public nodes, C<$noderef> must either be a (possibly unresolved)
		160	noderef, in which case it will be resolved, or C<undef> (or missing), in
		161	which case the noderef will be guessed.
		162
		163	Afterwards, the node will bind itself on all endpoints and try to connect
		164	to all additional C<$seednodes> that are specified. Seednodes are optional
		165	and can be used to quickly bootstrap the node into an existing network.
		166
		167	=item slave nodes
		168
		169	When the C<$noderef> is the special string C<slave/>, then the node will
		170	become a slave node. Slave nodes cannot be contacted from outside and will
		171	route most of their traffic to the master node that they attach to.
		172
		173	At least one additional noderef is required: The node will try to connect
		174	to all of them and will become a slave attached to the first node it can
		175	successfully connect to.
		176
		177	=back
		178
		179	This function will block until all nodes have been resolved and, for slave
		180	nodes, until it has successfully established a connection to a master
		181	server.
		182
		183	Example: become a public node listening on the default node.
		184
		185	initialise_node;
		186
		187	Example: become a public node, and try to contact some well-known master
		188	servers to become part of the network.
		189
		190	initialise_node undef, "master1", "master2";
		191
		192	Example: become a public node listening on port C<4041>.
		193
		194	initialise_node 4041;
		195
		196	Example: become a public node, only visible on localhost port 4044.
		197
		198	initialise_node "locahost:4044";
		199
		200	Example: become a slave node to any of the specified master servers.
		201
		202	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
132		203
133	=item $cv = resolve_node $noderef	204	=item $cv = resolve_node $noderef
134		205
135	Takes an unresolved node reference that may contain hostnames and	206	Takes an unresolved node reference that may contain hostnames and
136	abbreviated IDs, resolves all of them and returns a resolved node	207	abbreviated IDs, resolves all of them and returns a resolved node
…		…
168		239
169	Due to some quirks in how perl exports variables, it is impossible to	240	Due to some quirks in how perl exports variables, it is impossible to
170	just export C<$SELF>, all the symbols called C<SELF> are exported by this	241	just export C<$SELF>, all the symbols called C<SELF> are exported by this
171	module, but only C<$SELF> is currently used.	242	module, but only C<$SELF> is currently used.
172		243
173	=item snd $portid, type => @data	244	=item snd $port, type => @data
174		245
175	=item snd $portid, @msg	246	=item snd $port, @msg
176		247
177	Send the given message to the given port ID, which can identify either	248	Send the given message to the given port ID, which can identify either
178	a local or a remote port, and can be either a string or soemthignt hat	249	a local or a remote port, and can be either a string or soemthignt hat
179	stringifies a sa port ID (such as a port object :).	250	stringifies a sa port ID (such as a port object :).
180		251
…		…
190	JSON is used, then only strings, numbers and arrays and hashes consisting	261	JSON is used, then only strings, numbers and arrays and hashes consisting
191	of those are allowed (no objects). When Storable is used, then anything	262	of those are allowed (no objects). When Storable is used, then anything
192	that Storable can serialise and deserialise is allowed, and for the local	263	that Storable can serialise and deserialise is allowed, and for the local
193	node, anything can be passed.	264	node, anything can be passed.
194		265
195	=item kil $portid[, @reason]
196
197	Kill the specified port with the given C<@reason>.
198
199	If no C<@reason> is specified, then the port is killed "normally" (linked
200	ports will not be kileld, or even notified).
201
202	Otherwise, linked ports get killed with the same reason (second form of
203	C<mon>, see below).
204
205	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
206	will be reported as reason C<< die => $@ >>.
207
208	Transport/communication errors are reported as C<< transport_error =>
209	$message >>.
210
211	=item $guard = mon $portid, $cb->(@reason)
212
213	=item $guard = mon $portid, $otherport
214
215	=item $guard = mon $portid, $otherport, @msg
216
217	Monitor the given port and do something when the port is killed.
218
219	In the first form, the callback is simply called with any number
220	of C<@reason> elements (no @reason means that the port was deleted
221	"normally"). Note also that I<< the callback B<must> never die >>, so use
222	C<eval> if unsure.
223
224	In the second form, the other port will be C<kil>'ed with C<@reason>, iff
225	a @reason was specified, i.e. on "normal" kils nothing happens, while
226	under all other conditions, the other port is killed with the same reason.
227
228	In the last form, a message of the form C<@msg, @reason> will be C<snd>.
229
230	Example: call a given callback when C<$port> is killed.
231
232	mon $port, sub { warn "port died because of <@_>\n" };
233
234	Example: kill ourselves when C<$port> is killed abnormally.
235
236	mon $port, $self;
237
238	Example: send us a restart message another C<$port> is killed.
239
240	mon $port, $self => "restart";
241
242	=cut
243
244	sub mon {
245	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);
246
247	my $node = $NODE{$noderef} \|\| add_node $noderef;
248
249	#TODO: ports must not be references
250	if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) {
251	if (@_) {
252	# send a kill info message
253	my (@msg) = ($cb, @_);
254	$cb = sub { snd @msg, @_ };
255	} else {
256	# simply kill other port
257	my $port = $cb;
258	$cb = sub { kil $port, @_ if @_ };
259	}
260	}
261
262	$node->monitor ($port, $cb);
263
264	defined wantarray
265	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
266	}
267
268	=item $guard = mon_guard $port, $ref, $ref...
269
270	Monitors the given C<$port> and keeps the passed references. When the port
271	is killed, the references will be freed.
272
273	Optionally returns a guard that will stop the monitoring.
274
275	This function is useful when you create e.g. timers or other watchers and
276	want to free them when the port gets killed:
277
278	$port->rcv (start => sub {
279	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {
280	undef $timer if 0.9 < rand;
281	});
282	});
283
284	=cut
285
286	sub mon_guard {
287	my ($port, @refs) = @_;
288
289	mon $port, sub { 0 && @refs }
290	}
291
292	=item lnk $port1, $port2
293
294	Link two ports. This is simply a shorthand for:
295
296	mon $port1, $port2;
297	mon $port2, $port1;
298
299	It means that if either one is killed abnormally, the other one gets
300	killed as well.
301
302	=item $local_port = port	266	=item $local_port = port
303		267
304	Create a new local port object that supports message matching.	268	Create a new local port object that can be used either as a pattern
		269	matching port ("full port") or a single-callback port ("miniport"),
		270	depending on how C<rcv> callbacks are bound to the object.
305		271
306	=item $portid = port { my @msg = @_; $finished }	272	=item $port = port { my @msg = @_; $finished }
307		273
308	Creates a "mini port", that is, a very lightweight port without any	274	Creates a "miniport", that is, a very lightweight port without any pattern
309	pattern matching behind it, and returns its ID.	275	matching behind it, and returns its ID. Semantically the same as creating
		276	a port and calling C<rcv $port, $callback> on it.
310		277
311	The block will be called for every message received on the port. When the	278	The block will be called for every message received on the port. When the
312	callback returns a true value its job is considered "done" and the port	279	callback returns a true value its job is considered "done" and the port
313	will be destroyed. Otherwise it will stay alive.	280	will be destroyed. Otherwise it will stay alive.
314		281
315	The message will be passed as-is, no extra argument (i.e. no port id) will	282	The message will be passed as-is, no extra argument (i.e. no port id) will
316	be passed to the callback.	283	be passed to the callback.
317		284
318	If you need the local port id in the callback, this works nicely:	285	If you need the local port id in the callback, this works nicely:
319		286
320	my $port; $port = miniport {	287	my $port; $port = port {
321	snd $otherport, reply => $port;	288	snd $otherport, reply => $port;
322	};	289	};
323		290
324	=cut	291	=cut
		292
		293	sub rcv($@);
325		294
326	sub port(;&) {	295	sub port(;&) {
327	my $id = "$UNIQ." . $ID++;	296	my $id = "$UNIQ." . $ID++;
328	my $port = "$NODE#$id";	297	my $port = "$NODE#$id";
329		298
330	if (@_) {	299	if (@_) {
		300	rcv $port, shift;
		301	} else {
		302	$PORT{$id} = sub { }; # nop
		303	}
		304
		305	$port
		306	}
		307
		308	=item reg $port, $name
		309
		310	=item reg $name
		311
		312	Registers the given port (or C<$SELF><<< if missing) under the name
		313	C<$name>. If the name already exists it is replaced.
		314
		315	A port can only be registered under one well known name.
		316
		317	A port automatically becomes unregistered when it is killed.
		318
		319	=cut
		320
		321	sub reg(@) {
		322	my $port = @_ > 1 ? shift : $SELF \|\| Carp::croak 'reg: called with one argument only, but $SELF not set,';
		323
		324	$REG{$_[0]} = $port;
		325	}
		326
		327	=item rcv $port, $callback->(@msg)
		328
		329	Replaces the callback on the specified miniport (after converting it to
		330	one if required).
		331
		332	=item rcv $port, tagstring => $callback->(@msg), ...
		333
		334	=item rcv $port, $smartmatch => $callback->(@msg), ...
		335
		336	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
		337
		338	Register callbacks to be called on matching messages on the given full
		339	port (after converting it to one if required) and return the port.
		340
		341	The callback has to return a true value when its work is done, after
		342	which is will be removed, or a false value in which case it will stay
		343	registered.
		344
		345	The global C<$SELF> (exported by this module) contains C<$port> while
		346	executing the callback.
		347
		348	Runtime errors wdurign callback execution will result in the port being
		349	C<kil>ed.
		350
		351	If the match is an array reference, then it will be matched against the
		352	first elements of the message, otherwise only the first element is being
		353	matched.
		354
		355	Any element in the match that is specified as C<_any_> (a function
		356	exported by this module) matches any single element of the message.
		357
		358	While not required, it is highly recommended that the first matching
		359	element is a string identifying the message. The one-string-only match is
		360	also the most efficient match (by far).
		361
		362	Example: create a port and bind receivers on it in one go.
		363
		364	my $port = rcv port,
		365	msg1 => sub { ...; 0 },
		366	msg2 => sub { ...; 0 },
		367	;
		368
		369	Example: create a port, bind receivers and send it in a message elsewhere
		370	in one go:
		371
		372	snd $otherport, reply =>
		373	rcv port,
		374	msg1 => sub { ...; 0 },
		375	...
		376	;
		377
		378	=cut
		379
		380	sub rcv($@) {
		381	my $port = shift;
		382	my ($noderef, $portid) = split /#/, $port, 2;
		383
		384	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
		385	or Carp::croak "$port: rcv can only be called on local ports, caught";
		386
		387	if (@_ == 1) {
331	my $cb = shift;	388	my $cb = shift;
		389	delete $PORT_DATA{$portid};
332	$PORT{$id} = sub {	390	$PORT{$portid} = sub {
333	local $SELF = $port;	391	local $SELF = $port;
334	eval {	392	eval {
335	&$cb	393	&$cb
336	and kil $id;	394	and kil $port;
337	};	395	};
338	_self_die if $@;	396	_self_die if $@;
339	};	397	};
340	} else {	398	} else {
		399	my $self = $PORT_DATA{$portid} \|\|= do {
341	my $self = bless {	400	my $self = bless {
342	id => "$NODE#$id",	401	id => $port,
343	}, "AnyEvent::MP::Port";	402	}, "AnyEvent::MP::Port";
344		403
345	$PORT_DATA{$id} = $self;
346	$PORT{$id} = sub {	404	$PORT{$portid} = sub {
347	local $SELF = $port;	405	local $SELF = $port;
348		406
349	eval {	407	eval {
350	for (@{ $self->{rc0}{$_[0]} }) {	408	for (@{ $self->{rc0}{$_[0]} }) {
351	$_ && &{$_->[0]}	409	$_ && &{$_->[0]}
352	&& undef $_;	410	&& undef $_;
353	}	411	}
354		412
355	for (@{ $self->{rcv}{$_[0]} }) {	413	for (@{ $self->{rcv}{$_[0]} }) {
356	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]	414	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
357	&& &{$_->[0]}	415	&& &{$_->[0]}
358	&& undef $_;	416	&& undef $_;
359	}	417	}
360		418
361	for (@{ $self->{any} }) {	419	for (@{ $self->{any} }) {
362	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	420	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
363	&& &{$_->[0]}	421	&& &{$_->[0]}
364	&& undef $_;	422	&& undef $_;
		423	}
365	}	424	};
		425	_self_die if $@;
366	};	426	};
367	_self_die if $@;	427
		428	$self
368	};	429	};
369	}
370		430
371	$port
372	}
373
374	=item reg $portid, $name
375
376	Registers the given port under the name C<$name>. If the name already
377	exists it is replaced.
378
379	A port can only be registered under one well known name.
380
381	A port automatically becomes unregistered when it is killed.
382
383	=cut
384
385	sub reg(@) {
386	my ($portid, $name) = @_;
387
388	$REG{$name} = $portid;
389	}
390
391	=item rcv $portid, tagstring => $callback->(@msg), ...
392
393	=item rcv $portid, $smartmatch => $callback->(@msg), ...
394
395	=item rcv $portid, [$smartmatch...] => $callback->(@msg), ...
396
397	Register callbacks to be called on matching messages on the given port.
398
399	The callback has to return a true value when its work is done, after
400	which is will be removed, or a false value in which case it will stay
401	registered.
402
403	The global C<$SELF> (exported by this module) contains C<$portid> while
404	executing the callback.
405
406	Runtime errors wdurign callback execution will result in the port being
407	C<kil>ed.
408
409	If the match is an array reference, then it will be matched against the
410	first elements of the message, otherwise only the first element is being
411	matched.
412
413	Any element in the match that is specified as C<_any_> (a function
414	exported by this module) matches any single element of the message.
415
416	While not required, it is highly recommended that the first matching
417	element is a string identifying the message. The one-string-only match is
418	also the most efficient match (by far).
419
420	=cut
421
422	sub rcv($@) {
423	my ($noderef, $port) = split /#/, shift, 2;
424
425	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
426	or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught";
427
428	my $self = $PORT_DATA{$port}
429	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
430
431	"AnyEvent::MP::Port" eq ref $self	431	"AnyEvent::MP::Port" eq ref $self
432	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";	432	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
433		433
434	while (@_) {	434	while (@_) {
435	my ($match, $cb) = splice @_, 0, 2;	435	my ($match, $cb) = splice @_, 0, 2;
436		436
437	if (!ref $match) {	437	if (!ref $match) {
438	push @{ $self->{rc0}{$match} }, [$cb];	438	push @{ $self->{rc0}{$match} }, [$cb];
439	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {	439	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
440	my ($type, @match) = @$match;	440	my ($type, @match) = @$match;
441	@match	441	@match
442	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]	442	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
443	: push @{ $self->{rc0}{$match->[0]} }, [$cb];	443	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
444	} else {	444	} else {
445	push @{ $self->{any} }, [$cb, $match];	445	push @{ $self->{any} }, [$cb, $match];
		446	}
446	}	447	}
447	}	448	}
		449
		450	$port
448	}	451	}
449		452
450	=item $closure = psub { BLOCK }	453	=item $closure = psub { BLOCK }
451		454
452	Remembers C<$SELF> and creates a closure out of the BLOCK. When the	455	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
…		…
483	$res	486	$res
484	}	487	}
485	}	488	}
486	}	489	}
487		490
488	=back	491	=item $guard = mon $port, $cb->(@reason)
489		492
490	=head1 FUNCTIONS FOR NODES	493	=item $guard = mon $port, $rcvport
491		494
492	=over 4	495	=item $guard = mon $port
493		496
494	=item become_public $noderef	497	=item $guard = mon $port, $rcvport, @msg
495		498
496	Tells the node to become a public node, i.e. reachable from other nodes.	499	Monitor the given port and do something when the port is killed, and
		500	optionally return a guard that can be used to stop monitoring again.
497		501
498	The first argument is the (unresolved) node reference of the local node	502	In the first form (callback), the callback is simply called with any
499	(if missing then the empty string is used).	503	number of C<@reason> elements (no @reason means that the port was deleted
		504	"normally"). Note also that I<< the callback B<must> never die >>, so use
		505	C<eval> if unsure.
500		506
501	It is quite common to not specify anything, in which case the local node	507	In the second form (another port given), the other port (C<$rcvport)
502	tries to listen on the default port, or to only specify a port number, in	508	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
503	which case AnyEvent::MP tries to guess the local addresses.	509	"normal" kils nothing happens, while under all other conditions, the other
		510	port is killed with the same reason.
504		511
		512	The third form (kill self) is the same as the second form, except that
		513	C<$rvport> defaults to C<$SELF>.
		514
		515	In the last form (message), a message of the form C<@msg, @reason> will be
		516	C<snd>.
		517
		518	Example: call a given callback when C<$port> is killed.
		519
		520	mon $port, sub { warn "port died because of <@_>\n" };
		521
		522	Example: kill ourselves when C<$port> is killed abnormally.
		523
		524	mon $port;
		525
		526	Example: send us a restart message when another C<$port> is killed.
		527
		528	mon $port, $self => "restart";
		529
505	=cut	530	=cut
		531
		532	sub mon {
		533	my ($noderef, $port) = split /#/, shift, 2;
		534
		535	my $node = $NODE{$noderef} \|\| add_node $noderef;
		536
		537	my $cb = @_ ? $_[0] : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
		538
		539	unless (ref $cb) {
		540	if (@_) {
		541	# send a kill info message
		542	my (@msg) = @_;
		543	$cb = sub { snd @msg, @_ };
		544	} else {
		545	# simply kill other port
		546	my $port = $cb;
		547	$cb = sub { kil $port, @_ if @_ };
		548	}
		549	}
		550
		551	$node->monitor ($port, $cb);
		552
		553	defined wantarray
		554	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
		555	}
		556
		557	=item $guard = mon_guard $port, $ref, $ref...
		558
		559	Monitors the given C<$port> and keeps the passed references. When the port
		560	is killed, the references will be freed.
		561
		562	Optionally returns a guard that will stop the monitoring.
		563
		564	This function is useful when you create e.g. timers or other watchers and
		565	want to free them when the port gets killed:
		566
		567	$port->rcv (start => sub {
		568	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {
		569	undef $timer if 0.9 < rand;
		570	});
		571	});
		572
		573	=cut
		574
		575	sub mon_guard {
		576	my ($port, @refs) = @_;
		577
		578	#TODO: mon-less form?
		579
		580	mon $port, sub { 0 && @refs }
		581	}
		582
		583	=item lnk $port1, $port2
		584
		585	=item lnk $otherport
		586
		587	Link two ports. This is simply a shorthand for:
		588
		589	mon $port1, $port2;
		590	mon $port2, $port1;
		591
		592	It means that if either one is killed abnormally, the other one gets
		593	killed as well.
		594
		595	The one-argument form assumes that one port is C<$SELF>.
		596
		597	=cut
		598
		599	sub lnk {
		600	my $port1 = shift;
		601	my $port2 = @_ ? shift : $SELF \|\| Carp::croak 'lnk: called with one argument only, but $SELF not set,';
		602
		603	mon $port1, $port2;
		604	mon $port2, $port1;
		605	}
		606
		607	=item kil $port[, @reason]
		608
		609	Kill the specified port with the given C<@reason>.
		610
		611	If no C<@reason> is specified, then the port is killed "normally" (linked
		612	ports will not be kileld, or even notified).
		613
		614	Otherwise, linked ports get killed with the same reason (second form of
		615	C<mon>, see below).
		616
		617	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
		618	will be reported as reason C<< die => $@ >>.
		619
		620	Transport/communication errors are reported as C<< transport_error =>
		621	$message >>.
506		622
507	=back	623	=back
508		624
509	=head1 NODE MESSAGES	625	=head1 NODE MESSAGES
510		626
…		…
552		668
553	=back	669	=back
554		670
555	=head1 AnyEvent::MP vs. Distributed Erlang	671	=head1 AnyEvent::MP vs. Distributed Erlang
556		672
557	AnyEvent::MP got lots of its ideas from distributed erlang (erlang node	673	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
558	== aemp node, erlang process == aemp port), so many of the documents and	674	== aemp node, Erlang process == aemp port), so many of the documents and
559	programming techniques employed by erlang apply to AnyEvent::MP. Here is a	675	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
560	sample:	676	sample:
561		677
562	http://www.erlang.se/doc/programming_rules.shtml	678	http://www.Erlang.se/doc/programming_rules.shtml
563	http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4	679	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
564	http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6	680	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6
565	http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5	681	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
566		682
567	Despite the similarities, there are also some important differences:	683	Despite the similarities, there are also some important differences:
568		684
569	=over 4	685	=over 4
570		686
…		…
581		697
582	Erlang uses processes that selctively receive messages, and therefore	698	Erlang uses processes that selctively receive messages, and therefore
583	needs a queue. AEMP is event based, queuing messages would serve no useful	699	needs a queue. AEMP is event based, queuing messages would serve no useful
584	purpose.	700	purpose.
585		701
586	(But see L<Coro::MP> for a more erlang-like process model on top of AEMP).	702	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
587		703
588	=item * Erlang sends are synchronous, AEMP sends are asynchronous.	704	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
589		705
590	Sending messages in erlang is synchronous and blocks the process. AEMP	706	Sending messages in Erlang is synchronous and blocks the process. AEMP
591	sends are immediate, connection establishment is handled in the	707	sends are immediate, connection establishment is handled in the
592	background.	708	background.
593		709
594	=item * Erlang can silently lose messages, AEMP cannot.	710	=item * Erlang can silently lose messages, AEMP cannot.
595		711
…		…
598	and c, and the other side only receives messages a and c).	714	and c, and the other side only receives messages a and c).
599		715
600	AEMP guarantees correct ordering, and the guarantee that there are no	716	AEMP guarantees correct ordering, and the guarantee that there are no
601	holes in the message sequence.	717	holes in the message sequence.
602		718
603	=item * In erlang, processes can be declared dead and later be found to be	719	=item * In Erlang, processes can be declared dead and later be found to be
604	alive.	720	alive.
605		721
606	In erlang it can happen that a monitored process is declared dead and	722	In Erlang it can happen that a monitored process is declared dead and
607	linked processes get killed, but later it turns out that the process is	723	linked processes get killed, but later it turns out that the process is
608	still alive - and can receive messages.	724	still alive - and can receive messages.
609		725
610	In AEMP, when port monitoring detects a port as dead, then that port will	726	In AEMP, when port monitoring detects a port as dead, then that port will
611	eventually be killed - it cannot happen that a node detects a port as dead	727	eventually be killed - it cannot happen that a node detects a port as dead
612	and then later sends messages to it, finding it is still alive.	728	and then later sends messages to it, finding it is still alive.
613		729
614	=item * Erlang can send messages to the wrong port, AEMP does not.	730	=item * Erlang can send messages to the wrong port, AEMP does not.
615		731
616	In erlang it is quite possible that a node that restarts reuses a process	732	In Erlang it is quite possible that a node that restarts reuses a process
617	ID known to other nodes for a completely different process, causing	733	ID known to other nodes for a completely different process, causing
618	messages destined for that process to end up in an unrelated process.	734	messages destined for that process to end up in an unrelated process.
619		735
620	AEMP never reuses port IDs, so old messages or old port IDs floating	736	AEMP never reuses port IDs, so old messages or old port IDs floating
621	around in the network will not be sent to an unrelated port.	737	around in the network will not be sent to an unrelated port.
…		…
627	securely authenticate nodes.	743	securely authenticate nodes.
628		744
629	=item * The AEMP protocol is optimised for both text-based and binary	745	=item * The AEMP protocol is optimised for both text-based and binary
630	communications.	746	communications.
631		747
632	The AEMP protocol, unlike the erlang protocol, supports both	748	The AEMP protocol, unlike the Erlang protocol, supports both
633	language-independent text-only protocols (good for debugging) and binary,	749	language-independent text-only protocols (good for debugging) and binary,
634	language-specific serialisers (e.g. Storable).	750	language-specific serialisers (e.g. Storable).
635		751
636	It has also been carefully designed to be implementable in other languages	752	It has also been carefully designed to be implementable in other languages
637	with a minimum of work while gracefully degrading fucntionality to make the	753	with a minimum of work while gracefully degrading fucntionality to make the
638	protocol simple.	754	protocol simple.
639		755
		756	=item * AEMP has more flexible monitoring options than Erlang.
		757
		758	In Erlang, you can chose to receive I<all> exit signals as messages
		759	or I<none>, there is no in-between, so monitoring single processes is
		760	difficult to implement. Monitoring in AEMP is more flexible than in
		761	Erlang, as one can choose between automatic kill, exit message or callback
		762	on a per-process basis.
		763
		764	=item * Erlang has different semantics for monitoring and linking, AEMP has the same.
		765
		766	Monitoring in Erlang is not an indicator of process death/crashes,
		767	as linking is (except linking is unreliable in Erlang). In AEMP, the
		768	semantics of monitoring and linking are identical, linking is simply
		769	two-way monitoring with automatic kill.
		770
640	=back	771	=back
641		772
642	=head1 SEE ALSO	773	=head1 SEE ALSO
643		774
644	L<AnyEvent>.	775	L<AnyEvent>.

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.29 by root, Tue Aug 4 23:16:57 2009 UTC vs. Revision 1.36 by root, Thu Aug 6 10:46:48 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.29 by root, Tue Aug 4 23:16:57 2009 UTC vs.
Revision 1.36 by root, Thu Aug 6 10:46:48 2009 UTC