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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.21 by root, Tue Aug 4 14:10:51 2009 UTC vs.
Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::MP;	7	use AnyEvent::MP;
8		8
9	NODE # returns this node identifier
10	$NODE # contains this node identifier	9	$NODE # contains this node's noderef
		10	NODE # returns this node's noderef
		11	NODE $port # returns the noderef of the port
11		12
		13	$SELF # receiving/own port id in rcv callbacks
		14
		15	# ports are message endpoints
		16
		17	# sending messages
12	snd $port, type => data...;	18	snd $port, type => data...;
		19	snd $port, @msg;
		20	snd @msg_with_first_element_being_a_port;
13		21
		22	# miniports
		23	my $miniport = port { my @msg = @_; 0 };
		24
		25	# full ports
		26	my $port = port;
14	rcv $port, smartmatch => $cb->($port, @msg);	27	rcv $port, smartmatch => $cb->(@msg);
15
16	# examples:
17	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	28	rcv $port, ping => sub { snd $_[0], "pong"; 0 };
18	rcv $port1, pong => sub { warn "pong received\n" };	29	rcv $port, pong => sub { warn "pong received\n"; 0 };
19	snd $port2, ping => $port1;	30
		31	# remote ports
		32	my $port = spawn $node, $initfunc, @initdata;
20		33
21	# more, smarter, matches (_any_ is exported by this module)	34	# more, smarter, matches (_any_ is exported by this module)
22	rcv $port, [child_died => $pid] => sub { ...	35	rcv $port, [child_died => $pid] => sub { ...
23	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	36	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
24		37
		38	# monitoring
		39	mon $port, $cb->(@msg) # callback is invoked on death
		40	mon $port, $otherport # kill otherport on abnormal death
		41	mon $port, $otherport, @msg # send message on death
		42
25	=head1 DESCRIPTION	43	=head1 DESCRIPTION
26		44
27	This module (-family) implements a simple message passing framework.	45	This module (-family) implements a simple message passing framework.
28		46
29	Despite its simplicity, you can securely message other processes running	47	Despite its simplicity, you can securely message other processes running
30	on the same or other hosts.	48	on the same or other hosts.
31		49
		50	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
		51	manual page.
		52
32	At the moment, this module family is severly brokena nd underdocumented,	53	At the moment, this module family is severly broken and underdocumented,
33	so do not use. This was uploaded mainly to reserve the CPAN namespace -	54	so do not use. This was uploaded mainly to reserve the CPAN namespace -
34	stay tuned!	55	stay tuned! The basic API should be finished, however.
35		56
36	=head1 CONCEPTS	57	=head1 CONCEPTS
37		58
38	=over 4	59	=over 4
39		60
40	=item port	61	=item port
41		62
42	A port is something you can send messages to with the C<snd> function, and	63	A port is something you can send messages to (with the C<snd> function).
43	you can register C<rcv> handlers with. All C<rcv> handlers will receive	64
44	messages they match, messages will not be queued.	65	Some ports allow you to register C<rcv> handlers that can match specific
		66	messages. All C<rcv> handlers will receive messages they match, messages
		67	will not be queued.
45		68
46	=item port id - C<noderef#portname>	69	=item port id - C<noderef#portname>
47		70
48	A port id is always the noderef, a hash-mark (C<#>) as separator, followed	71	A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as
49	by a port name (a printable string of unspecified format).	72	separator, and a port name (a printable string of unspecified format). An
		73	exception is the the node port, whose ID is identical to its node
		74	reference.
50		75
51	=item node	76	=item node
52		77
53	A node is a single process containing at least one port - the node	78	A node is a single process containing at least one port - the node
54	port. You can send messages to node ports to let them create new ports,	79	port. You can send messages to node ports to find existing ports or to
55	among other things.	80	create new ports, among other things.
56		81
57	Initially, nodes are either private (single-process only) or hidden	82	Nodes are either private (single-process only), slaves (connected to a
58	(connected to a master node only). Only when they epxlicitly "become	83	master node only) or public nodes (connectable from unrelated nodes).
59	public" can you send them messages from unrelated other nodes.
60		84
61	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	85	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>
62		86
63	A noderef is a string that either uniquely identifies a given node (for	87	A node reference is a string that either simply identifies the node (for
64	private and hidden nodes), or contains a recipe on how to reach a given	88	private and slave nodes), or contains a recipe on how to reach a given
65	node (for public nodes).	89	node (for public nodes).
66		90
		91	This recipe is simply a comma-separated list of C<address:port> pairs (for
		92	TCP/IP, other protocols might look different).
		93
		94	Node references come in two flavours: resolved (containing only numerical
		95	addresses) or unresolved (where hostnames are used instead of addresses).
		96
		97	Before using an unresolved node reference in a message you first have to
		98	resolve it.
		99
67	=back	100	=back
68		101
69	=head1 VARIABLES/FUNCTIONS	102	=head1 VARIABLES/FUNCTIONS
70		103
71	=over 4	104	=over 4
…		…
82		115
83	use AE ();	116	use AE ();
84		117
85	use base "Exporter";	118	use base "Exporter";
86		119
87	our $VERSION = '0.02';	120	our $VERSION = '0.1';
88	our @EXPORT = qw(	121	our @EXPORT = qw(
89	NODE $NODE $PORT snd rcv mon kil _any_	122	NODE $NODE *SELF node_of _any_
90	create_port create_port_on	123	resolve_node initialise_node
		124	snd rcv mon kil reg psub spawn
91	miniport	125	port
92	become_slave become_public
93	);	126	);
94		127
		128	our $SELF;
		129
		130	sub _self_die() {
		131	my $msg = $@;
		132	$msg =~ s/\n+$// unless ref $msg;
		133	kil $SELF, die => $msg;
		134	}
		135
95	=item NODE / $NODE	136	=item $thisnode = NODE / $NODE
96		137
97	The C<NODE ()> function and the C<$NODE> variable contain the noderef of	138	The C<NODE> function returns, and the C<$NODE> variable contains
98	the local node. The value is initialised by a call to C<become_public> or	139	the noderef of the local node. The value is initialised by a call
99	C<become_slave>, after which all local port identifiers become invalid.	140	to C<become_public> or C<become_slave>, after which all local port
		141	identifiers become invalid.
100		142
		143	=item $noderef = node_of $port
		144
		145	Extracts and returns the noderef from a portid or a noderef.
		146
		147	=item initialise_node $noderef, $seednode, $seednode...
		148
		149	=item initialise_node "slave/", $master, $master...
		150
		151	Before a node can talk to other nodes on the network it has to initialise
		152	itself - the minimum a node needs to know is it's own name, and optionally
		153	it should know the noderefs of some other nodes in the network.
		154
		155	This function initialises a node - it must be called exactly once (or
		156	never) before calling other AnyEvent::MP functions.
		157
		158	All arguments are noderefs, which can be either resolved or unresolved.
		159
		160	There are two types of networked nodes, public nodes and slave nodes:
		161
		162	=over 4
		163
		164	=item public nodes
		165
		166	For public nodes, C<$noderef> must either be a (possibly unresolved)
		167	noderef, in which case it will be resolved, or C<undef> (or missing), in
		168	which case the noderef will be guessed.
		169
		170	Afterwards, the node will bind itself on all endpoints and try to connect
		171	to all additional C<$seednodes> that are specified. Seednodes are optional
		172	and can be used to quickly bootstrap the node into an existing network.
		173
		174	=item slave nodes
		175
		176	When the C<$noderef> is the special string C<slave/>, then the node will
		177	become a slave node. Slave nodes cannot be contacted from outside and will
		178	route most of their traffic to the master node that they attach to.
		179
		180	At least one additional noderef is required: The node will try to connect
		181	to all of them and will become a slave attached to the first node it can
		182	successfully connect to.
		183
		184	=back
		185
		186	This function will block until all nodes have been resolved and, for slave
		187	nodes, until it has successfully established a connection to a master
		188	server.
		189
		190	Example: become a public node listening on the default node.
		191
		192	initialise_node;
		193
		194	Example: become a public node, and try to contact some well-known master
		195	servers to become part of the network.
		196
		197	initialise_node undef, "master1", "master2";
		198
		199	Example: become a public node listening on port C<4041>.
		200
		201	initialise_node 4041;
		202
		203	Example: become a public node, only visible on localhost port 4044.
		204
		205	initialise_node "locahost:4044";
		206
		207	Example: become a slave node to any of the specified master servers.
		208
		209	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
		210
		211	=item $cv = resolve_node $noderef
		212
		213	Takes an unresolved node reference that may contain hostnames and
		214	abbreviated IDs, resolves all of them and returns a resolved node
		215	reference.
		216
		217	In addition to C<address:port> pairs allowed in resolved noderefs, the
		218	following forms are supported:
		219
		220	=over 4
		221
		222	=item the empty string
		223
		224	An empty-string component gets resolved as if the default port (4040) was
		225	specified.
		226
		227	=item naked port numbers (e.g. C<1234>)
		228
		229	These are resolved by prepending the local nodename and a colon, to be
		230	further resolved.
		231
		232	=item hostnames (e.g. C<localhost:1234>, C<localhost>)
		233
		234	These are resolved by using AnyEvent::DNS to resolve them, optionally
		235	looking up SRV records for the C<aemp=4040> port, if no port was
		236	specified.
		237
		238	=back
		239
		240	=item $SELF
		241
		242	Contains the current port id while executing C<rcv> callbacks or C<psub>
		243	blocks.
		244
		245	=item SELF, %SELF, @SELF...
		246
		247	Due to some quirks in how perl exports variables, it is impossible to
		248	just export C<$SELF>, all the symbols called C<SELF> are exported by this
		249	module, but only C<$SELF> is currently used.
		250
101	=item snd $portid, type => @data	251	=item snd $port, type => @data
102		252
103	=item snd $portid, @msg	253	=item snd $port, @msg
104		254
105	Send the given message to the given port ID, which can identify either	255	Send the given message to the given port ID, which can identify either
106	a local or a remote port, and can be either a string or soemthignt hat	256	a local or a remote port, and can be either a string or soemthignt hat
107	stringifies a sa port ID (such as a port object :).	257	stringifies a sa port ID (such as a port object :).
108		258
…		…
118	JSON is used, then only strings, numbers and arrays and hashes consisting	268	JSON is used, then only strings, numbers and arrays and hashes consisting
119	of those are allowed (no objects). When Storable is used, then anything	269	of those are allowed (no objects). When Storable is used, then anything
120	that Storable can serialise and deserialise is allowed, and for the local	270	that Storable can serialise and deserialise is allowed, and for the local
121	node, anything can be passed.	271	node, anything can be passed.
122		272
		273	=item $local_port = port
		274
		275	Create a new local port object that can be used either as a pattern
		276	matching port ("full port") or a single-callback port ("miniport"),
		277	depending on how C<rcv> callbacks are bound to the object.
		278
		279	=item $port = port { my @msg = @_; $finished }
		280
		281	Creates a "miniport", that is, a very lightweight port without any pattern
		282	matching behind it, and returns its ID. Semantically the same as creating
		283	a port and calling C<rcv $port, $callback> on it.
		284
		285	The block will be called for every message received on the port. When the
		286	callback returns a true value its job is considered "done" and the port
		287	will be destroyed. Otherwise it will stay alive.
		288
		289	The message will be passed as-is, no extra argument (i.e. no port id) will
		290	be passed to the callback.
		291
		292	If you need the local port id in the callback, this works nicely:
		293
		294	my $port; $port = port {
		295	snd $otherport, reply => $port;
		296	};
		297
		298	=cut
		299
		300	sub rcv($@);
		301
		302	sub port(;&) {
		303	my $id = "$UNIQ." . $ID++;
		304	my $port = "$NODE#$id";
		305
		306	if (@_) {
		307	rcv $port, shift;
		308	} else {
		309	$PORT{$id} = sub { }; # nop
		310	}
		311
		312	$port
		313	}
		314
		315	=item reg $port, $name
		316
		317	=item reg $name
		318
		319	Registers the given port (or C<$SELF><<< if missing) under the name
		320	C<$name>. If the name already exists it is replaced.
		321
		322	A port can only be registered under one well known name.
		323
		324	A port automatically becomes unregistered when it is killed.
		325
		326	=cut
		327
		328	sub reg(@) {
		329	my $port = @_ > 1 ? shift : $SELF \|\| Carp::croak 'reg: called with one argument only, but $SELF not set,';
		330
		331	$REG{$_[0]} = $port;
		332	}
		333
		334	=item rcv $port, $callback->(@msg)
		335
		336	Replaces the callback on the specified miniport (after converting it to
		337	one if required).
		338
		339	=item rcv $port, tagstring => $callback->(@msg), ...
		340
		341	=item rcv $port, $smartmatch => $callback->(@msg), ...
		342
		343	=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
		344
		345	Register callbacks to be called on matching messages on the given full
		346	port (after converting it to one if required) and return the port.
		347
		348	The callback has to return a true value when its work is done, after
		349	which is will be removed, or a false value in which case it will stay
		350	registered.
		351
		352	The global C<$SELF> (exported by this module) contains C<$port> while
		353	executing the callback.
		354
		355	Runtime errors during callback execution will result in the port being
		356	C<kil>ed.
		357
		358	If the match is an array reference, then it will be matched against the
		359	first elements of the message, otherwise only the first element is being
		360	matched.
		361
		362	Any element in the match that is specified as C<_any_> (a function
		363	exported by this module) matches any single element of the message.
		364
		365	While not required, it is highly recommended that the first matching
		366	element is a string identifying the message. The one-string-only match is
		367	also the most efficient match (by far).
		368
		369	Example: create a port and bind receivers on it in one go.
		370
		371	my $port = rcv port,
		372	msg1 => sub { ...; 0 },
		373	msg2 => sub { ...; 0 },
		374	;
		375
		376	Example: create a port, bind receivers and send it in a message elsewhere
		377	in one go:
		378
		379	snd $otherport, reply =>
		380	rcv port,
		381	msg1 => sub { ...; 0 },
		382	...
		383	;
		384
		385	=cut
		386
		387	sub rcv($@) {
		388	my $port = shift;
		389	my ($noderef, $portid) = split /#/, $port, 2;
		390
		391	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
		392	or Carp::croak "$port: rcv can only be called on local ports, caught";
		393
		394	if (@_ == 1) {
		395	my $cb = shift;
		396	delete $PORT_DATA{$portid};
		397	$PORT{$portid} = sub {
		398	local $SELF = $port;
		399	eval {
		400	&$cb
		401	and kil $port;
		402	};
		403	_self_die if $@;
		404	};
		405	} else {
		406	my $self = $PORT_DATA{$portid} \|\|= do {
		407	my $self = bless {
		408	id => $port,
		409	}, "AnyEvent::MP::Port";
		410
		411	$PORT{$portid} = sub {
		412	local $SELF = $port;
		413
		414	eval {
		415	for (@{ $self->{rc0}{$_[0]} }) {
		416	$_ && &{$_->[0]}
		417	&& undef $_;
		418	}
		419
		420	for (@{ $self->{rcv}{$_[0]} }) {
		421	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
		422	&& &{$_->[0]}
		423	&& undef $_;
		424	}
		425
		426	for (@{ $self->{any} }) {
		427	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
		428	&& &{$_->[0]}
		429	&& undef $_;
		430	}
		431	};
		432	_self_die if $@;
		433	};
		434
		435	$self
		436	};
		437
		438	"AnyEvent::MP::Port" eq ref $self
		439	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		440
		441	while (@_) {
		442	my ($match, $cb) = splice @_, 0, 2;
		443
		444	if (!ref $match) {
		445	push @{ $self->{rc0}{$match} }, [$cb];
		446	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
		447	my ($type, @match) = @$match;
		448	@match
		449	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
		450	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
		451	} else {
		452	push @{ $self->{any} }, [$cb, $match];
		453	}
		454	}
		455	}
		456
		457	$port
		458	}
		459
		460	=item $closure = psub { BLOCK }
		461
		462	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
		463	closure is executed, sets up the environment in the same way as in C<rcv>
		464	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		465
		466	This is useful when you register callbacks from C<rcv> callbacks:
		467
		468	rcv delayed_reply => sub {
		469	my ($delay, @reply) = @_;
		470	my $timer = AE::timer $delay, 0, psub {
		471	snd @reply, $SELF;
		472	};
		473	};
		474
		475	=cut
		476
		477	sub psub(&) {
		478	my $cb = shift;
		479
		480	my $port = $SELF
		481	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
		482
		483	sub {
		484	local $SELF = $port;
		485
		486	if (wantarray) {
		487	my @res = eval { &$cb };
		488	_self_die if $@;
		489	@res
		490	} else {
		491	my $res = eval { &$cb };
		492	_self_die if $@;
		493	$res
		494	}
		495	}
		496	}
		497
123	=item $guard = mon $portid, $cb->()	498	=item $guard = mon $port, $cb->(@reason)
124		499
125	=item $guard = mon $portid, $otherport	500	=item $guard = mon $port, $rcvport
126		501
		502	=item $guard = mon $port
		503
127	=item $guard = mon $portid, $otherport, @msg	504	=item $guard = mon $port, $rcvport, @msg
128		505
129	Monitor the given port and call the given callback when the port is	506	Monitor the given port and do something when the port is killed, and
130	destroyed or connection to it's node is lost.	507	optionally return a guard that can be used to stop monitoring again.
131		508
132	#TODO	509	In the first form (callback), the callback is simply called with any
		510	number of C<@reason> elements (no @reason means that the port was deleted
		511	"normally"). Note also that I<< the callback B<must> never die >>, so use
		512	C<eval> if unsure.
		513
		514	In the second form (another port given), the other port (C<$rcvport)
		515	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
		516	"normal" kils nothing happens, while under all other conditions, the other
		517	port is killed with the same reason.
		518
		519	The third form (kill self) is the same as the second form, except that
		520	C<$rvport> defaults to C<$SELF>.
		521
		522	In the last form (message), a message of the form C<@msg, @reason> will be
		523	C<snd>.
		524
		525	As a rule of thumb, monitoring requests should always monitor a port from
		526	a local port (or callback). The reason is that kill messages might get
		527	lost, just like any other message. Another less obvious reason is that
		528	even monitoring requests can get lost (for exmaple, when the connection
		529	to the other node goes down permanently). When monitoring a port locally
		530	these problems do not exist.
		531
		532	Example: call a given callback when C<$port> is killed.
		533
		534	mon $port, sub { warn "port died because of <@_>\n" };
		535
		536	Example: kill ourselves when C<$port> is killed abnormally.
		537
		538	mon $port;
		539
		540	Example: send us a restart message when another C<$port> is killed.
		541
		542	mon $port, $self => "restart";
133		543
134	=cut	544	=cut
135		545
136	sub mon {	546	sub mon {
137	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);	547	my ($noderef, $port) = split /#/, shift, 2;
138		548
139	my $node = AnyEvent::MP::Base::add_node $noderef;	549	my $node = $NODE{$noderef} \|\| add_node $noderef;
140		550
141	#TODO: ports must not be references	551	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
142	if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) {	552
		553	unless (ref $cb) {
143	if (@_) {	554	if (@_) {
144	# send a kill info message	555	# send a kill info message
145	my (@msg) = ($cb, @_);	556	my (@msg) = ($cb, @_);
146	$cb = sub { snd @msg, @_ };	557	$cb = sub { snd @msg, @_ };
147	} else {	558	} else {
148	# simply kill other port	559	# simply kill other port
149	my $port = $cb;	560	my $port = $cb;
150	$cb = sub { kil $port, @_ };	561	$cb = sub { kil $port, @_ if @_ };
151	}	562	}
152	}	563	}
153		564
154	$node->monitor ($port, $cb);	565	$node->monitor ($port, $cb);
155		566
…		…
176	=cut	587	=cut
177		588
178	sub mon_guard {	589	sub mon_guard {
179	my ($port, @refs) = @_;	590	my ($port, @refs) = @_;
180		591
		592	#TODO: mon-less form?
		593
181	mon $port, sub { 0 && @refs }	594	mon $port, sub { 0 && @refs }
182	}	595	}
183		596
184	=item $local_port = create_port	597	=item kil $port[, @reason]
185		598
186	Create a new local port object. See the next section for allowed methods.	599	Kill the specified port with the given C<@reason>.
187		600
188	=cut	601	If no C<@reason> is specified, then the port is killed "normally" (linked
		602	ports will not be kileld, or even notified).
189		603
190	sub create_port {	604	Otherwise, linked ports get killed with the same reason (second form of
191	my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++;	605	C<mon>, see below).
192		606
193	my $self = bless {	607	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
194	id => "$NODE#$id",	608	will be reported as reason C<< die => $@ >>.
195	}, "AnyEvent::MP::Port";
196		609
197	$AnyEvent::MP::Base::PORT{$id} = sub {	610	Transport/communication errors are reported as C<< transport_error =>
198	unshift @_, $self;	611	$message >>.
199		612
200	for (@{ $self->{rc0}{$_[1]} }) {	613	=cut
201	$_ && &{$_->[0]}	614
202	&& undef $_;	615	=item $port = spawn $node, $initfunc[, @initdata]
		616
		617	Creates a port on the node C<$node> (which can also be a port ID, in which
		618	case it's the node where that port resides).
		619
		620	The port ID of the newly created port is return immediately, and it is
		621	permissible to immediately start sending messages or monitor the port.
		622
		623	After the port has been created, the init function is
		624	called. This function must be a fully-qualified function name
		625	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
		626	program, use C<::name>.
		627
		628	If the function doesn't exist, then the node tries to C<require>
		629	the package, then the package above the package and so on (e.g.
		630	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		631	exists or it runs out of package names.
		632
		633	The init function is then called with the newly-created port as context
		634	object (C<$SELF>) and the C<@initdata> values as arguments.
		635
		636	A common idiom is to pass your own port, monitor the spawned port, and
		637	in the init function, monitor the original port. This two-way monitoring
		638	ensures that both ports get cleaned up when there is a problem.
		639
		640	Example: spawn a chat server port on C<$othernode>.
		641
		642	# this node, executed from within a port context:
		643	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		644	mon $server;
		645
		646	# init function on C<$othernode>
		647	sub connect {
		648	my ($srcport) = @_;
		649
		650	mon $srcport;
		651
		652	rcv $SELF, sub {
		653	...
203	}	654	};
		655	}
204		656
205	for (@{ $self->{rcv}{$_[1]} }) {	657	=cut
206	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
207	&& &{$_->[0]}
208	&& undef $_;
209	}
210		658
211	for (@{ $self->{any} }) {	659	sub _spawn {
212	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	660	my $port = shift;
213	&& &{$_->[0]}	661	my $init = shift;
214	&& undef $_;	662
215	}	663	local $SELF = "$NODE#$port";
		664	eval {
		665	&{ load_func $init }
216	};	666	};
217		667	_self_die if $@;
218	$self
219	}	668	}
220		669
221	=item $portid = miniport { my @msg = @_; $finished }	670	sub spawn(@) {
		671	my ($noderef, undef) = split /#/, shift, 2;
222		672
223	Creates a "mini port", that is, a very lightweight port without any	673	my $id = "$RUNIQ." . $ID++;
224	pattern matching behind it, and returns its ID.
225		674
226	The block will be called for every message received on the port. When the	675	$_[0] =~ /::/
227	callback returns a true value its job is considered "done" and the port	676	or Carp::croak "spawn init function must be a fully-qualified name, caught";
228	will be destroyed. Otherwise it will stay alive.
229		677
230	The message will be passed as-is, no extra argument (i.e. no port id) will	678	($NODE{$noderef} \|\| add_node $noderef)
231	be passed to the callback.	679	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
232		680
233	If you need the local port id in the callback, this works nicely:	681	"$noderef#$id"
234
235	my $port; $port = miniport {
236	snd $otherport, reply => $port;
237	};
238
239	=cut
240
241	sub miniport(&) {
242	my $cb = shift;
243	my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++;
244
245	$AnyEvent::MP::Base::PORT{$id} = sub {
246	&$cb
247	and kil $id;
248	};
249
250	"$NODE#$id"
251	}	682	}
252
253	package AnyEvent::MP::Port;
254
255	=back
256
257	=head1 METHODS FOR PORT OBJECTS
258
259	=over 4
260
261	=item "$port"
262
263	A port object stringifies to its port ID, so can be used directly for
264	C<snd> operations.
265
266	=cut
267
268	use overload
269	'""' => sub { $_[0]{id} },
270	fallback => 1;
271
272	sub TO_JSON { $_[0]{id} }
273
274	=item $port->rcv (type => $callback->($port, @msg))
275
276	=item $port->rcv ($smartmatch => $callback->($port, @msg))
277
278	=item $port->rcv ([$smartmatch...] => $callback->($port, @msg))
279
280	Register a callback on the given port.
281
282	The callback has to return a true value when its work is done, after
283	which is will be removed, or a false value in which case it will stay
284	registered.
285
286	If the match is an array reference, then it will be matched against the
287	first elements of the message, otherwise only the first element is being
288	matched.
289
290	Any element in the match that is specified as C<_any_> (a function
291	exported by this module) matches any single element of the message.
292
293	While not required, it is highly recommended that the first matching
294	element is a string identifying the message. The one-string-only match is
295	also the most efficient match (by far).
296
297	=cut
298
299	sub rcv($@) {
300	my ($self, $match, $cb) = @_;
301
302	if (!ref $match) {
303	push @{ $self->{rc0}{$match} }, [$cb];
304	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
305	my ($type, @match) = @$match;
306	@match
307	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
308	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
309	} else {
310	push @{ $self->{any} }, [$cb, $match];
311	}
312	}
313
314	=item $port->register ($name)
315
316	Registers the given port under the well known name C<$name>. If the name
317	already exists it is replaced.
318
319	A port can only be registered under one well known name.
320
321	=cut
322
323	sub register {
324	my ($self, $name) = @_;
325
326	$self->{wkname} = $name;
327	$AnyEvent::MP::Base::WKP{$name} = "$self";
328	}
329
330	=item $port->destroy
331
332	Explicitly destroy/remove/nuke/vaporise the port.
333
334	Ports are normally kept alive by their mere existance alone, and need to
335	be destroyed explicitly.
336
337	=cut
338
339	sub destroy {
340	my ($self) = @_;
341
342	delete $AnyEvent::MP::Base::WKP{ $self->{wkname} };
343
344	AnyEvent::MP::Base::kil $self->{id};
345	}
346
347	=back
348
349	=head1 FUNCTIONS FOR NODES
350
351	=over 4
352
353	=item mon $noderef, $callback->($noderef, $status, $)
354
355	Monitors the given noderef.
356
357	=item become_public endpoint...
358
359	Tells the node to become a public node, i.e. reachable from other nodes.
360
361	If no arguments are given, or the first argument is C<undef>, then
362	AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the
363	local nodename resolves to.
364
365	Otherwise the first argument must be an array-reference with transport
366	endpoints ("ip:port", "hostname:port") or port numbers (in which case the
367	local nodename is used as hostname). The endpoints are all resolved and
368	will become the node reference.
369
370	=cut
371		683
372	=back	684	=back
373		685
374	=head1 NODE MESSAGES	686	=head1 NODE MESSAGES
375		687
376	Nodes understand the following messages sent to them. Many of them take	688	Nodes understand the following messages sent to them. Many of them take
377	arguments called C<@reply>, which will simply be used to compose a reply	689	arguments called C<@reply>, which will simply be used to compose a reply
378	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and	690	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
379	the remaining arguments are simply the message data.	691	the remaining arguments are simply the message data.
380		692
		693	While other messages exist, they are not public and subject to change.
		694
381	=over 4	695	=over 4
382		696
383	=cut	697	=cut
384		698
385	=item wkp => $name, @reply	699	=item lookup => $name, @reply
386		700
387	Replies with the port ID of the specified well-known port, or C<undef>.	701	Replies with the port ID of the specified well-known port, or C<undef>.
388		702
389	=item devnull => ...	703	=item devnull => ...
390		704
…		…
413	snd $NODE, time => $myport, timereply => 1, 2;	727	snd $NODE, time => $myport, timereply => 1, 2;
414	# => snd $myport, timereply => 1, 2, <time>	728	# => snd $myport, timereply => 1, 2, <time>
415		729
416	=back	730	=back
417		731
		732	=head1 AnyEvent::MP vs. Distributed Erlang
		733
		734	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
		735	== aemp node, Erlang process == aemp port), so many of the documents and
		736	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
		737	sample:
		738
		739	http://www.Erlang.se/doc/programming_rules.shtml
		740	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
		741	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6
		742	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
		743
		744	Despite the similarities, there are also some important differences:
		745
		746	=over 4
		747
		748	=item * Node references contain the recipe on how to contact them.
		749
		750	Erlang relies on special naming and DNS to work everywhere in the
		751	same way. AEMP relies on each node knowing it's own address(es), with
		752	convenience functionality.
		753
		754	This means that AEMP requires a less tightly controlled environment at the
		755	cost of longer node references and a slightly higher management overhead.
		756
		757	=item * Erlang uses processes and a mailbox, AEMP does not queue.
		758
		759	Erlang uses processes that selctively receive messages, and therefore
		760	needs a queue. AEMP is event based, queuing messages would serve no useful
		761	purpose.
		762
		763	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
		764
		765	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
		766
		767	Sending messages in Erlang is synchronous and blocks the process. AEMP
		768	sends are immediate, connection establishment is handled in the
		769	background.
		770
		771	=item * Erlang can silently lose messages, AEMP cannot.
		772
		773	Erlang makes few guarantees on messages delivery - messages can get lost
		774	without any of the processes realising it (i.e. you send messages a, b,
		775	and c, and the other side only receives messages a and c).
		776
		777	AEMP guarantees correct ordering, and the guarantee that there are no
		778	holes in the message sequence.
		779
		780	=item * In Erlang, processes can be declared dead and later be found to be
		781	alive.
		782
		783	In Erlang it can happen that a monitored process is declared dead and
		784	linked processes get killed, but later it turns out that the process is
		785	still alive - and can receive messages.
		786
		787	In AEMP, when port monitoring detects a port as dead, then that port will
		788	eventually be killed - it cannot happen that a node detects a port as dead
		789	and then later sends messages to it, finding it is still alive.
		790
		791	=item * Erlang can send messages to the wrong port, AEMP does not.
		792
		793	In Erlang it is quite possible that a node that restarts reuses a process
		794	ID known to other nodes for a completely different process, causing
		795	messages destined for that process to end up in an unrelated process.
		796
		797	AEMP never reuses port IDs, so old messages or old port IDs floating
		798	around in the network will not be sent to an unrelated port.
		799
		800	=item * Erlang uses unprotected connections, AEMP uses secure
		801	authentication and can use TLS.
		802
		803	AEMP can use a proven protocol - SSL/TLS - to protect connections and
		804	securely authenticate nodes.
		805
		806	=item * The AEMP protocol is optimised for both text-based and binary
		807	communications.
		808
		809	The AEMP protocol, unlike the Erlang protocol, supports both
		810	language-independent text-only protocols (good for debugging) and binary,
		811	language-specific serialisers (e.g. Storable).
		812
		813	It has also been carefully designed to be implementable in other languages
		814	with a minimum of work while gracefully degrading fucntionality to make the
		815	protocol simple.
		816
		817	=item * AEMP has more flexible monitoring options than Erlang.
		818
		819	In Erlang, you can chose to receive I<all> exit signals as messages
		820	or I<none>, there is no in-between, so monitoring single processes is
		821	difficult to implement. Monitoring in AEMP is more flexible than in
		822	Erlang, as one can choose between automatic kill, exit message or callback
		823	on a per-process basis.
		824
		825	=item * Erlang tries to hide remote/local connections, AEMP does not.
		826
		827	Monitoring in Erlang is not an indicator of process death/crashes,
		828	as linking is (except linking is unreliable in Erlang).
		829
		830	In AEMP, you don't "look up" registered port names or send to named ports
		831	that might or might not be persistent. Instead, you normally spawn a port
		832	on the remote node. The init function monitors the you, and you monitor
		833	the remote port. Since both monitors are local to the node, they are much
		834	more reliable.
		835
		836	This also saves round-trips and avoids sending messages to the wrong port
		837	(hard to do in Erlang).
		838
		839	=back
		840
418	=head1 SEE ALSO	841	=head1 SEE ALSO
419		842
420	L<AnyEvent>.	843	L<AnyEvent>.
421		844
422	=head1 AUTHOR	845	=head1 AUTHOR

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.21 by root, Tue Aug 4 14:10:51 2009 UTC vs. Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.21 by root, Tue Aug 4 14:10:51 2009 UTC vs.
Revision 1.41 by root, Sat Aug 8 21:56:29 2009 UTC