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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.22 by root, Tue Aug 4 18:33:30 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
33	on the same or other hosts.	41	on the same or other hosts.
34		42
		43	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
		44	manual page.
		45
35	At the moment, this module family is severly brokena nd underdocumented,	46	At the moment, this module family is severly broken and underdocumented,
36	so do not use. This was uploaded mainly to reserve the CPAN namespace -	47	so do not use. This was uploaded mainly to reserve the CPAN namespace -
37	stay tuned!	48	stay tuned! The basic API should be finished, however.
38		49
39	=head1 CONCEPTS	50	=head1 CONCEPTS
40		51
41	=over 4	52	=over 4
42		53
43	=item port	54	=item port
44		55
45	A port is something you can send messages to with the C<snd> function, and	56	A port is something you can send messages to (with the C<snd> function).
46	you can register C<rcv> handlers with. All C<rcv> handlers will receive	57
47	messages they match, messages will not be queued.	58	Some ports allow you to register C<rcv> handlers that can match specific
		59	messages. All C<rcv> handlers will receive messages they match, messages
		60	will not be queued.
48		61
49	=item port id - C<noderef#portname>	62	=item port id - C<noderef#portname>
50		63
51	A port id is always the noderef, a hash-mark (C<#>) as separator, followed	64	A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as
52	by a port name (a printable string of unspecified format).	65	separator, and a port name (a printable string of unspecified format). An
		66	exception is the the node port, whose ID is identical to its node
		67	reference.
53		68
54	=item node	69	=item node
55		70
56	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
57	port. You can send messages to node ports to let them create new ports,	72	port. You can send messages to node ports to find existing ports or to
58	among other things.	73	create new ports, among other things.
59		74
60	Initially, nodes are either private (single-process only) or hidden	75	Nodes are either private (single-process only), slaves (connected to a
61	(connected to a master node only). Only when they epxlicitly "become	76	master node only) or public nodes (connectable from unrelated nodes).
62	public" can you send them messages from unrelated other nodes.
63		77
64	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	78	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>
65		79
66	A noderef is a string that either uniquely identifies a given node (for	80	A node reference is a string that either simply identifies the node (for
67	private and hidden nodes), or contains a recipe on how to reach a given	81	private and slave nodes), or contains a recipe on how to reach a given
68	node (for public nodes).	82	node (for public nodes).
69		83
		84	This recipe is simply a comma-separated list of C<address:port> pairs (for
		85	TCP/IP, other protocols might look different).
		86
		87	Node references come in two flavours: resolved (containing only numerical
		88	addresses) or unresolved (where hostnames are used instead of addresses).
		89
		90	Before using an unresolved node reference in a message you first have to
		91	resolve it.
		92
70	=back	93	=back
71		94
72	=head1 VARIABLES/FUNCTIONS	95	=head1 VARIABLES/FUNCTIONS
73		96
74	=over 4	97	=over 4
…		…
85		108
86	use AE ();	109	use AE ();
87		110
88	use base "Exporter";	111	use base "Exporter";
89		112
90	our $VERSION = '0.02';	113	our $VERSION = '0.1';
91	our @EXPORT = qw(	114	our @EXPORT = qw(
92	NODE $NODE *SELF node_of _any_	115	NODE $NODE *SELF node_of _any_
93	become_slave become_public	116	resolve_node initialise_node
94	snd rcv mon kil reg psub	117	snd rcv mon kil reg psub
95	port	118	port
96	);	119	);
97		120
98	our $SELF;	121	our $SELF;
…		…
108	The C<NODE> function returns, and the C<$NODE> variable contains	131	The C<NODE> function returns, and the C<$NODE> variable contains
109	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
110	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
111	identifiers become invalid.	134	identifiers become invalid.
112		135
113	=item $noderef = node_of $portid	136	=item $noderef = node_of $port
114		137
115	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";
		203
		204	=item $cv = resolve_node $noderef
		205
		206	Takes an unresolved node reference that may contain hostnames and
		207	abbreviated IDs, resolves all of them and returns a resolved node
		208	reference.
		209
		210	In addition to C<address:port> pairs allowed in resolved noderefs, the
		211	following forms are supported:
		212
		213	=over 4
		214
		215	=item the empty string
		216
		217	An empty-string component gets resolved as if the default port (4040) was
		218	specified.
		219
		220	=item naked port numbers (e.g. C<1234>)
		221
		222	These are resolved by prepending the local nodename and a colon, to be
		223	further resolved.
		224
		225	=item hostnames (e.g. C<localhost:1234>, C<localhost>)
		226
		227	These are resolved by using AnyEvent::DNS to resolve them, optionally
		228	looking up SRV records for the C<aemp=4040> port, if no port was
		229	specified.
		230
		231	=back
116		232
117	=item $SELF	233	=item $SELF
118		234
119	Contains the current port id while executing C<rcv> callbacks or C<psub>	235	Contains the current port id while executing C<rcv> callbacks or C<psub>
120	blocks.	236	blocks.
…		…
123		239
124	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
125	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
126	module, but only C<$SELF> is currently used.	242	module, but only C<$SELF> is currently used.
127		243
128	=item snd $portid, type => @data	244	=item snd $port, type => @data
129		245
130	=item snd $portid, @msg	246	=item snd $port, @msg
131		247
132	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
133	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
134	stringifies a sa port ID (such as a port object :).	250	stringifies a sa port ID (such as a port object :).
135		251
…		…
145	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
146	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
147	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
148	node, anything can be passed.	264	node, anything can be passed.
149		265
150	=item kil $portid[, @reason]
151
152	Kill the specified port with the given C<@reason>.
153
154	If no C<@reason> is specified, then the port is killed "normally" (linked
155	ports will not be kileld, or even notified).
156
157	Otherwise, linked ports get killed with the same reason (second form of
158	C<mon>, see below).
159
160	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
161	will be reported as reason C<< die => $@ >>.
162
163	Transport/communication errors are reported as C<< transport_error =>
164	$message >>.
165
166	=item $guard = mon $portid, $cb->(@reason)
167
168	=item $guard = mon $portid, $otherport
169
170	=item $guard = mon $portid, $otherport, @msg
171
172	Monitor the given port and do something when the port is killed.
173
174	In the first form, the callback is simply called with any number
175	of C<@reason> elements (no @reason means that the port was deleted
176	"normally"). Note also that I<< the callback B<must> never die >>, so use
177	C<eval> if unsure.
178
179	In the second form, the other port will be C<kil>'ed with C<@reason>, iff
180	a @reason was specified, i.e. on "normal" kils nothing happens, while
181	under all other conditions, the other port is killed with the same reason.
182
183	In the last form, a message of the form C<@msg, @reason> will be C<snd>.
184
185	Example: call a given callback when C<$port> is killed.
186
187	mon $port, sub { warn "port died because of <@_>\n" };
188
189	Example: kill ourselves when C<$port> is killed abnormally.
190
191	mon $port, $self;
192
193	Example: send us a restart message another C<$port> is killed.
194
195	mon $port, $self => "restart";
196
197	=cut
198
199	sub mon {
200	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);
201
202	my $node = $NODE{$noderef} \|\| add_node $noderef;
203
204	#TODO: ports must not be references
205	if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) {
206	if (@_) {
207	# send a kill info message
208	my (@msg) = ($cb, @_);
209	$cb = sub { snd @msg, @_ };
210	} else {
211	# simply kill other port
212	my $port = $cb;
213	$cb = sub { kil $port, @_ if @_ };
214	}
215	}
216
217	$node->monitor ($port, $cb);
218
219	defined wantarray
220	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
221	}
222
223	=item $guard = mon_guard $port, $ref, $ref...
224
225	Monitors the given C<$port> and keeps the passed references. When the port
226	is killed, the references will be freed.
227
228	Optionally returns a guard that will stop the monitoring.
229
230	This function is useful when you create e.g. timers or other watchers and
231	want to free them when the port gets killed:
232
233	$port->rcv (start => sub {
234	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {
235	undef $timer if 0.9 < rand;
236	});
237	});
238
239	=cut
240
241	sub mon_guard {
242	my ($port, @refs) = @_;
243
244	mon $port, sub { 0 && @refs }
245	}
246
247	=item $local_port = port	266	=item $local_port = port
248		267
249	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.
250		271
251	=item $portid = port { my @msg = @_; $finished }	272	=item $port = port { my @msg = @_; $finished }
252		273
253	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
254	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.
255		277
256	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
257	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
258	will be destroyed. Otherwise it will stay alive.	280	will be destroyed. Otherwise it will stay alive.
259		281
260	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
261	be passed to the callback.	283	be passed to the callback.
262		284
263	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:
264		286
265	my $port; $port = miniport {	287	my $port; $port = port {
266	snd $otherport, reply => $port;	288	snd $otherport, reply => $port;
267	};	289	};
268		290
269	=cut	291	=cut
		292
		293	sub rcv($@);
270		294
271	sub port(;&) {	295	sub port(;&) {
272	my $id = "$UNIQ." . $ID++;	296	my $id = "$UNIQ." . $ID++;
273	my $port = "$NODE#$id";	297	my $port = "$NODE#$id";
274		298
275	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) {
276	my $cb = shift;	388	my $cb = shift;
		389	delete $PORT_DATA{$portid};
277	$PORT{$id} = sub {	390	$PORT{$portid} = sub {
278	local $SELF = $port;	391	local $SELF = $port;
279	eval {	392	eval {
280	&$cb	393	&$cb
281	and kil $id;	394	and kil $port;
282	};	395	};
283	_self_die if $@;	396	_self_die if $@;
284	};	397	};
285	} else {	398	} else {
		399	my $self = $PORT_DATA{$portid} \|\|= do {
286	my $self = bless {	400	my $self = bless {
287	id => "$NODE#$id",	401	id => $port,
288	}, "AnyEvent::MP::Port";	402	}, "AnyEvent::MP::Port";
289		403
290	$PORT_DATA{$id} = $self;
291	$PORT{$id} = sub {	404	$PORT{$portid} = sub {
292	local $SELF = $port;	405	local $SELF = $port;
293		406
294	eval {	407	eval {
295	for (@{ $self->{rc0}{$_[0]} }) {	408	for (@{ $self->{rc0}{$_[0]} }) {
296	$_ && &{$_->[0]}	409	$_ && &{$_->[0]}
297	&& undef $_;	410	&& undef $_;
298	}	411	}
299		412
300	for (@{ $self->{rcv}{$_[0]} }) {	413	for (@{ $self->{rcv}{$_[0]} }) {
301	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]	414	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
302	&& &{$_->[0]}	415	&& &{$_->[0]}
303	&& undef $_;	416	&& undef $_;
304	}	417	}
305		418
306	for (@{ $self->{any} }) {	419	for (@{ $self->{any} }) {
307	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	420	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
308	&& &{$_->[0]}	421	&& &{$_->[0]}
309	&& undef $_;	422	&& undef $_;
		423	}
310	}	424	};
		425	_self_die if $@;
311	};	426	};
312	_self_die if $@;	427
		428	$self
313	};	429	};
314	}
315		430
316	$port
317	}
318
319	=item reg $portid, $name
320
321	Registers the given port under the name C<$name>. If the name already
322	exists it is replaced.
323
324	A port can only be registered under one well known name.
325
326	A port automatically becomes unregistered when it is killed.
327
328	=cut
329
330	sub reg(@) {
331	my ($portid, $name) = @_;
332
333	$REG{$name} = $portid;
334	}
335
336	=item rcv $portid, tagstring => $callback->(@msg), ...
337
338	=item rcv $portid, $smartmatch => $callback->(@msg), ...
339
340	=item rcv $portid, [$smartmatch...] => $callback->(@msg), ...
341
342	Register callbacks to be called on matching messages on the given port.
343
344	The callback has to return a true value when its work is done, after
345	which is will be removed, or a false value in which case it will stay
346	registered.
347
348	The global C<$SELF> (exported by this module) contains C<$portid> while
349	executing the callback.
350
351	Runtime errors wdurign callback execution will result in the port being
352	C<kil>ed.
353
354	If the match is an array reference, then it will be matched against the
355	first elements of the message, otherwise only the first element is being
356	matched.
357
358	Any element in the match that is specified as C<_any_> (a function
359	exported by this module) matches any single element of the message.
360
361	While not required, it is highly recommended that the first matching
362	element is a string identifying the message. The one-string-only match is
363	also the most efficient match (by far).
364
365	=cut
366
367	sub rcv($@) {
368	my ($noderef, $port) = split /#/, shift, 2;
369
370	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
371	or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught";
372
373	my $self = $PORT_DATA{$port}
374	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
375
376	"AnyEvent::MP::Port" eq ref $self	431	"AnyEvent::MP::Port" eq ref $self
377	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";
378		433
379	while (@_) {	434	while (@_) {
380	my ($match, $cb) = splice @_, 0, 2;	435	my ($match, $cb) = splice @_, 0, 2;
381		436
382	if (!ref $match) {	437	if (!ref $match) {
383	push @{ $self->{rc0}{$match} }, [$cb];	438	push @{ $self->{rc0}{$match} }, [$cb];
384	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {	439	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
385	my ($type, @match) = @$match;	440	my ($type, @match) = @$match;
386	@match	441	@match
387	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]	442	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
388	: push @{ $self->{rc0}{$match->[0]} }, [$cb];	443	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
389	} else {	444	} else {
390	push @{ $self->{any} }, [$cb, $match];	445	push @{ $self->{any} }, [$cb, $match];
		446	}
391	}	447	}
392	}	448	}
		449
		450	$port
393	}	451	}
394		452
395	=item $closure = psub { BLOCK }	453	=item $closure = psub { BLOCK }
396		454
397	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
…		…
428	$res	486	$res
429	}	487	}
430	}	488	}
431	}	489	}
432		490
433	=back	491	=item $guard = mon $port, $cb->(@reason)
434		492
435	=head1 FUNCTIONS FOR NODES	493	=item $guard = mon $port, $rcvport
436		494
437	=over 4	495	=item $guard = mon $port
438		496
439	=item become_public endpoint...	497	=item $guard = mon $port, $rcvport, @msg
440		498
441	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.
442		501
443	If no arguments are given, or the first argument is C<undef>, then	502	In the first form (callback), the callback is simply called with any
444	AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the	503	number of C<@reason> elements (no @reason means that the port was deleted
445	local nodename resolves to.	504	"normally"). Note also that I<< the callback B<must> never die >>, so use
		505	C<eval> if unsure.
446		506
447	Otherwise the first argument must be an array-reference with transport	507	In the second form (another port given), the other port (C<$rcvport)
448	endpoints ("ip:port", "hostname:port") or port numbers (in which case the	508	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
449	local nodename is used as hostname). The endpoints are all resolved and	509	"normal" kils nothing happens, while under all other conditions, the other
450	will become the node reference.	510	port is killed with the same reason.
451		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
452	=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 >>.
453		622
454	=back	623	=back
455		624
456	=head1 NODE MESSAGES	625	=head1 NODE MESSAGES
457		626
458	Nodes understand the following messages sent to them. Many of them take	627	Nodes understand the following messages sent to them. Many of them take
459	arguments called C<@reply>, which will simply be used to compose a reply	628	arguments called C<@reply>, which will simply be used to compose a reply
460	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and	629	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
461	the remaining arguments are simply the message data.	630	the remaining arguments are simply the message data.
462		631
		632	While other messages exist, they are not public and subject to change.
		633
463	=over 4	634	=over 4
464		635
465	=cut	636	=cut
466		637
467	=item lookup => $name, @reply	638	=item lookup => $name, @reply
…		…
495	snd $NODE, time => $myport, timereply => 1, 2;	666	snd $NODE, time => $myport, timereply => 1, 2;
496	# => snd $myport, timereply => 1, 2, <time>	667	# => snd $myport, timereply => 1, 2, <time>
497		668
498	=back	669	=back
499		670
		671	=head1 AnyEvent::MP vs. Distributed Erlang
		672
		673	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
		674	== aemp node, Erlang process == aemp port), so many of the documents and
		675	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
		676	sample:
		677
		678	http://www.Erlang.se/doc/programming_rules.shtml
		679	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
		680	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6
		681	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
		682
		683	Despite the similarities, there are also some important differences:
		684
		685	=over 4
		686
		687	=item * Node references contain the recipe on how to contact them.
		688
		689	Erlang relies on special naming and DNS to work everywhere in the
		690	same way. AEMP relies on each node knowing it's own address(es), with
		691	convenience functionality.
		692
		693	This means that AEMP requires a less tightly controlled environment at the
		694	cost of longer node references and a slightly higher management overhead.
		695
		696	=item * Erlang uses processes and a mailbox, AEMP does not queue.
		697
		698	Erlang uses processes that selctively receive messages, and therefore
		699	needs a queue. AEMP is event based, queuing messages would serve no useful
		700	purpose.
		701
		702	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
		703
		704	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
		705
		706	Sending messages in Erlang is synchronous and blocks the process. AEMP
		707	sends are immediate, connection establishment is handled in the
		708	background.
		709
		710	=item * Erlang can silently lose messages, AEMP cannot.
		711
		712	Erlang makes few guarantees on messages delivery - messages can get lost
		713	without any of the processes realising it (i.e. you send messages a, b,
		714	and c, and the other side only receives messages a and c).
		715
		716	AEMP guarantees correct ordering, and the guarantee that there are no
		717	holes in the message sequence.
		718
		719	=item * In Erlang, processes can be declared dead and later be found to be
		720	alive.
		721
		722	In Erlang it can happen that a monitored process is declared dead and
		723	linked processes get killed, but later it turns out that the process is
		724	still alive - and can receive messages.
		725
		726	In AEMP, when port monitoring detects a port as dead, then that port will
		727	eventually be killed - it cannot happen that a node detects a port as dead
		728	and then later sends messages to it, finding it is still alive.
		729
		730	=item * Erlang can send messages to the wrong port, AEMP does not.
		731
		732	In Erlang it is quite possible that a node that restarts reuses a process
		733	ID known to other nodes for a completely different process, causing
		734	messages destined for that process to end up in an unrelated process.
		735
		736	AEMP never reuses port IDs, so old messages or old port IDs floating
		737	around in the network will not be sent to an unrelated port.
		738
		739	=item * Erlang uses unprotected connections, AEMP uses secure
		740	authentication and can use TLS.
		741
		742	AEMP can use a proven protocol - SSL/TLS - to protect connections and
		743	securely authenticate nodes.
		744
		745	=item * The AEMP protocol is optimised for both text-based and binary
		746	communications.
		747
		748	The AEMP protocol, unlike the Erlang protocol, supports both
		749	language-independent text-only protocols (good for debugging) and binary,
		750	language-specific serialisers (e.g. Storable).
		751
		752	It has also been carefully designed to be implementable in other languages
		753	with a minimum of work while gracefully degrading fucntionality to make the
		754	protocol simple.
		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
		771	=back
		772
500	=head1 SEE ALSO	773	=head1 SEE ALSO
501		774
502	L<AnyEvent>.	775	L<AnyEvent>.
503		776
504	=head1 AUTHOR	777	=head1 AUTHOR

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.22 by root, Tue Aug 4 18:33:30 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.22 by root, Tue Aug 4 18:33:30 2009 UTC vs.
Revision 1.36 by root, Thu Aug 6 10:46:48 2009 UTC