[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.56 by root, Sat Aug 15 04:12:38 2009 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::MP;	7	use AnyEvent::MP;
8		8
9	NODE # returns this node identifier
10	$NODE # contains this node identifier	9	$NODE # contains this node's noderef
		10	NODE # returns this node's noderef
		11	NODE $port # returns the noderef of the port
11		12
		13	$SELF # receiving/own port id in rcv callbacks
		14
		15	# initialise the node so it can send/receive messages
		16	initialise_node; # -OR-
		17	initialise_node "localhost:4040"; # -OR-
		18	initialise_node "slave/", "localhost:4040"
		19
		20	# ports are message endpoints
		21
		22	# sending messages
12	snd $port, type => data...;	23	snd $port, type => data...;
		24	snd $port, @msg;
		25	snd @msg_with_first_element_being_a_port;
13		26
14	rcv $port, smartmatch => $cb->($port, @msg);	27	# creating/using ports, the simple way
		28	my $simple_port = port { my @msg = @_; 0 };
15		29
16	# examples:	30	# creating/using ports, tagged message matching
		31	my $port = port;
17	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	32	rcv $port, ping => sub { snd $_[0], "pong"; 0 };
18	rcv $port1, pong => sub { warn "pong received\n" };	33	rcv $port, pong => sub { warn "pong received\n"; 0 };
19	snd $port2, ping => $port1;
20		34
21	# more, smarter, matches (_any_ is exported by this module)	35	# create a port on another node
22	rcv $port, [child_died => $pid] => sub { ...	36	my $port = spawn $node, $initfunc, @initdata;
23	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	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
		43	=head1 CURRENT STATUS
		44
		45	AnyEvent::MP - stable API, should work
		46	AnyEvent::MP::Intro - outdated
		47	AnyEvent::MP::Kernel - WIP
		48	AnyEvent::MP::Transport - mostly stable
		49
		50	stay tuned.
24		51
25	=head1 DESCRIPTION	52	=head1 DESCRIPTION
26		53
27	This module (-family) implements a simple message passing framework.	54	This module (-family) implements a simple message passing framework.
28		55
29	Despite its simplicity, you can securely message other processes running	56	Despite its simplicity, you can securely message other processes running
30	on the same or other hosts.	57	on the same or other hosts.
31		58
		59	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
		60	manual page.
		61
32	At the moment, this module family is severly brokena nd underdocumented,	62	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 -	63	so do not use. This was uploaded mainly to reserve the CPAN namespace -
34	stay tuned!	64	stay tuned!
35		65
36	=head1 CONCEPTS	66	=head1 CONCEPTS
37		67
38	=over 4	68	=over 4
39		69
40	=item port	70	=item port
41		71
42	A port is something you can send messages to with the C<snd> function, and	72	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	73
		74	Ports allow you to register C<rcv> handlers that can match all or just
44	messages they match, messages will not be queued.	75	some messages. Messages will not be queued.
45		76
46	=item port id - C<noderef#portname>	77	=item port id - C<noderef#portname>
47		78
48	A port id is always the noderef, a hash-mark (C<#>) as separator, followed	79	A port ID is the concatenation of a noderef, a hash-mark (C<#>) as
49	by a port name (a printable string of unspecified format).	80	separator, and a port name (a printable string of unspecified format). An
		81	exception is the the node port, whose ID is identical to its node
		82	reference.
50		83
51	=item node	84	=item node
52		85
53	A node is a single process containing at least one port - the node	86	A node is a single process containing at least one port - the node port,
54	port. You can send messages to node ports to let them create new ports,	87	which provides nodes to manage each other remotely, and to create new
55	among other things.	88	ports.
56		89
57	Initially, nodes are either private (single-process only) or hidden	90	Nodes are either private (single-process only), slaves (connected to a
58	(connected to a master node only). Only when they epxlicitly "become	91	master node only) or public nodes (connectable from unrelated nodes).
59	public" can you send them messages from unrelated other nodes.
60		92
61	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	93	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>
62		94
63	A noderef is a string that either uniquely identifies a given node (for	95	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	96	private and slave nodes), or contains a recipe on how to reach a given
65	node (for public nodes).	97	node (for public nodes).
66		98
		99	This recipe is simply a comma-separated list of C<address:port> pairs (for
		100	TCP/IP, other protocols might look different).
		101
		102	Node references come in two flavours: resolved (containing only numerical
		103	addresses) or unresolved (where hostnames are used instead of addresses).
		104
		105	Before using an unresolved node reference in a message you first have to
		106	resolve it.
		107
67	=back	108	=back
68		109
69	=head1 VARIABLES/FUNCTIONS	110	=head1 VARIABLES/FUNCTIONS
70		111
71	=over 4	112	=over 4
72		113
73	=cut	114	=cut
74		115
75	package AnyEvent::MP;	116	package AnyEvent::MP;
76		117
77	use AnyEvent::MP::Base;	118	use AnyEvent::MP::Kernel;
78		119
79	use common::sense;	120	use common::sense;
80		121
81	use Carp ();	122	use Carp ();
82		123
83	use AE ();	124	use AE ();
84		125
85	use base "Exporter";	126	use base "Exporter";
86		127
87	our $VERSION = '0.02';	128	our $VERSION = $AnyEvent::MP::Kernel::VERSION;
		129
88	our @EXPORT = qw(	130	our @EXPORT = qw(
89	NODE $NODE $PORT snd rcv mon kil _any_	131	NODE $NODE *SELF node_of _any_
90	create_port create_port_on	132	resolve_node initialise_node
		133	snd rcv mon kil reg psub spawn
91	miniport	134	port
92	become_slave become_public
93	);	135	);
94		136
		137	our $SELF;
		138
		139	sub _self_die() {
		140	my $msg = $@;
		141	$msg =~ s/\n+$// unless ref $msg;
		142	kil $SELF, die => $msg;
		143	}
		144
95	=item NODE / $NODE	145	=item $thisnode = NODE / $NODE
96		146
97	The C<NODE ()> function and the C<$NODE> variable contain the noderef of	147	The C<NODE> function returns, and the C<$NODE> variable contains the
98	the local node. The value is initialised by a call to C<become_public> or	148	noderef of the local node. The value is initialised by a call to
99	C<become_slave>, after which all local port identifiers become invalid.	149	C<initialise_node>.
100		150
		151	=item $noderef = node_of $port
		152
		153	Extracts and returns the noderef from a port ID or a noderef.
		154
		155	=item initialise_node $noderef, $seednode, $seednode...
		156
		157	=item initialise_node "slave/", $master, $master...
		158
		159	Before a node can talk to other nodes on the network it has to initialise
		160	itself - the minimum a node needs to know is it's own name, and optionally
		161	it should know the noderefs of some other nodes in the network.
		162
		163	This function initialises a node - it must be called exactly once (or
		164	never) before calling other AnyEvent::MP functions.
		165
		166	All arguments (optionally except for the first) are noderefs, which can be
		167	either resolved or unresolved.
		168
		169	The first argument will be looked up in the configuration database first
		170	(if it is C<undef> then the current nodename will be used instead) to find
		171	the relevant configuration profile (see L<aemp>). If none is found then
		172	the default configuration is used. The configuration supplies additional
		173	seed/master nodes and can override the actual noderef.
		174
		175	There are two types of networked nodes, public nodes and slave nodes:
		176
		177	=over 4
		178
		179	=item public nodes
		180
		181	For public nodes, C<$noderef> (supplied either directly to
		182	C<initialise_node> or indirectly via a profile or the nodename) must be a
		183	noderef (possibly unresolved, in which case it will be resolved).
		184
		185	After resolving, the node will bind itself on all endpoints and try to
		186	connect to all additional C<$seednodes> that are specified. Seednodes are
		187	optional and can be used to quickly bootstrap the node into an existing
		188	network.
		189
		190	=item slave nodes
		191
		192	When the C<$noderef> (either as given or overriden by the config file)
		193	is the special string C<slave/>, then the node will become a slave
		194	node. Slave nodes cannot be contacted from outside and will route most of
		195	their traffic to the master node that they attach to.
		196
		197	At least one additional noderef is required (either by specifying it
		198	directly or because it is part of the configuration profile): The node
		199	will try to connect to all of them and will become a slave attached to the
		200	first node it can successfully connect to.
		201
		202	Note that slave nodes cannot change their name, and consequently, their
		203	master, so if the master goes down, the slave node will not function well
		204	anymore until it can re-establish conenciton to its master. This makes
		205	slave nodes unsuitable for long-term nodes or fault-tolerant networks.
		206
		207	=back
		208
		209	This function will block until all nodes have been resolved and, for slave
		210	nodes, until it has successfully established a connection to a master
		211	server.
		212
		213	All the seednodes will also be specially marked to automatically retry
		214	connecting to them infinitely.
		215
		216	Example: become a public node listening on the guessed noderef, or the one
		217	specified via C<aemp> for the current node. This should be the most common
		218	form of invocation for "daemon"-type nodes.
		219
		220	initialise_node;
		221
		222	Example: become a slave node to any of the the seednodes specified via
		223	C<aemp>. This form is often used for commandline clients.
		224
		225	initialise_node "slave/";
		226
		227	Example: become a slave node to any of the specified master servers. This
		228	form is also often used for commandline clients.
		229
		230	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
		231
		232	Example: become a public node, and try to contact some well-known master
		233	servers to become part of the network.
		234
		235	initialise_node undef, "master1", "master2";
		236
		237	Example: become a public node listening on port C<4041>.
		238
		239	initialise_node 4041;
		240
		241	Example: become a public node, only visible on localhost port 4044.
		242
		243	initialise_node "localhost:4044";
		244
		245	=item $cv = resolve_node $noderef
		246
		247	Takes an unresolved node reference that may contain hostnames and
		248	abbreviated IDs, resolves all of them and returns a resolved node
		249	reference.
		250
		251	In addition to C<address:port> pairs allowed in resolved noderefs, the
		252	following forms are supported:
		253
		254	=over 4
		255
		256	=item the empty string
		257
		258	An empty-string component gets resolved as if the default port (4040) was
		259	specified.
		260
		261	=item naked port numbers (e.g. C<1234>)
		262
		263	These are resolved by prepending the local nodename and a colon, to be
		264	further resolved.
		265
		266	=item hostnames (e.g. C<localhost:1234>, C<localhost>)
		267
		268	These are resolved by using AnyEvent::DNS to resolve them, optionally
		269	looking up SRV records for the C<aemp=4040> port, if no port was
		270	specified.
		271
		272	=back
		273
		274	=item $SELF
		275
		276	Contains the current port id while executing C<rcv> callbacks or C<psub>
		277	blocks.
		278
		279	=item SELF, %SELF, @SELF...
		280
		281	Due to some quirks in how perl exports variables, it is impossible to
		282	just export C<$SELF>, all the symbols called C<SELF> are exported by this
		283	module, but only C<$SELF> is currently used.
		284
101	=item snd $portid, type => @data	285	=item snd $port, type => @data
102		286
103	=item snd $portid, @msg	287	=item snd $port, @msg
104		288
105	Send the given message to the given port ID, which can identify either	289	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	290	a local or a remote port, and must be a port ID.
107	stringifies a sa port ID (such as a port object :).
108		291
109	While the message can be about anything, it is highly recommended to use a	292	While the message can be about anything, it is highly recommended to use a
110	string as first element (a portid, or some word that indicates a request	293	string as first element (a port ID, or some word that indicates a request
111	type etc.).	294	type etc.).
112		295
113	The message data effectively becomes read-only after a call to this	296	The message data effectively becomes read-only after a call to this
114	function: modifying any argument is not allowed and can cause many	297	function: modifying any argument is not allowed and can cause many
115	problems.	298	problems.
…		…
118	JSON is used, then only strings, numbers and arrays and hashes consisting	301	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	302	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	303	that Storable can serialise and deserialise is allowed, and for the local
121	node, anything can be passed.	304	node, anything can be passed.
122		305
123	=item $guard = mon $portid, $cb->()	306	=item $local_port = port
124		307
125	=item $guard = mon $portid, $otherport	308	Create a new local port object and returns its port ID. Initially it has
		309	no callbacks set and will throw an error when it receives messages.
126		310
127	=item $guard = mon $portid, $otherport, @msg	311	=item $local_port = port { my @msg = @_ }
128		312
129	Monitor the given port and call the given callback when the port is	313	Creates a new local port, and returns its ID. Semantically the same as
130	destroyed or connection to it's node is lost.	314	creating a port and calling C<rcv $port, $callback> on it.
131		315
132	#TODO	316	The block will be called for every message received on the port, with the
		317	global variable C<$SELF> set to the port ID. Runtime errors will cause the
		318	port to be C<kil>ed. The message will be passed as-is, no extra argument
		319	(i.e. no port ID) will be passed to the callback.
		320
		321	If you want to stop/destroy the port, simply C<kil> it:
		322
		323	my $port = port {
		324	my @msg = @_;
		325	...
		326	kil $SELF;
		327	};
133		328
134	=cut	329	=cut
135		330
		331	sub rcv($@);
		332
		333	sub _kilme {
		334	die "received message on port without callback";
		335	}
		336
		337	sub port(;&) {
		338	my $id = "$UNIQ." . $ID++;
		339	my $port = "$NODE#$id";
		340
		341	rcv $port, shift \|\| \&_kilme;
		342
		343	$port
		344	}
		345
		346	=item rcv $local_port, $callback->(@msg)
		347
		348	Replaces the default callback on the specified port. There is no way to
		349	remove the default callback: use C<sub { }> to disable it, or better
		350	C<kil> the port when it is no longer needed.
		351
		352	The global C<$SELF> (exported by this module) contains C<$port> while
		353	executing the callback. Runtime errors during callback execution will
		354	result in the port being C<kil>ed.
		355
		356	The default callback received all messages not matched by a more specific
		357	C<tag> match.
		358
		359	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
		360
		361	Register (or replace) callbacks to be called on messages starting with the
		362	given tag on the given port (and return the port), or unregister it (when
		363	C<$callback> is C<$undef> or missing). There can only be one callback
		364	registered for each tag.
		365
		366	The original message will be passed to the callback, after the first
		367	element (the tag) has been removed. The callback will use the same
		368	environment as the default callback (see above).
		369
		370	Example: create a port and bind receivers on it in one go.
		371
		372	my $port = rcv port,
		373	msg1 => sub { ... },
		374	msg2 => sub { ... },
		375	;
		376
		377	Example: create a port, bind receivers and send it in a message elsewhere
		378	in one go:
		379
		380	snd $otherport, reply =>
		381	rcv port,
		382	msg1 => sub { ... },
		383	...
		384	;
		385
		386	Example: temporarily register a rcv callback for a tag matching some port
		387	(e.g. for a rpc reply) and unregister it after a message was received.
		388
		389	rcv $port, $otherport => sub {
		390	my @reply = @_;
		391
		392	rcv $SELF, $otherport;
		393	};
		394
		395	=cut
		396
		397	sub rcv($@) {
		398	my $port = shift;
		399	my ($noderef, $portid) = split /#/, $port, 2;
		400
		401	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
		402	or Carp::croak "$port: rcv can only be called on local ports, caught";
		403
		404	while (@_) {
		405	if (ref $_[0]) {
		406	if (my $self = $PORT_DATA{$portid}) {
		407	"AnyEvent::MP::Port" eq ref $self
		408	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		409
		410	$self->[2] = shift;
		411	} else {
		412	my $cb = shift;
		413	$PORT{$portid} = sub {
		414	local $SELF = $port;
		415	eval { &$cb }; _self_die if $@;
		416	};
		417	}
		418	} elsif (defined $_[0]) {
		419	my $self = $PORT_DATA{$portid} \|\|= do {
		420	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
		421
		422	$PORT{$portid} = sub {
		423	local $SELF = $port;
		424
		425	if (my $cb = $self->[1]{$_[0]}) {
		426	shift;
		427	eval { &$cb }; _self_die if $@;
		428	} else {
		429	&{ $self->[0] };
		430	}
		431	};
		432
		433	$self
		434	};
		435
		436	"AnyEvent::MP::Port" eq ref $self
		437	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		438
		439	my ($tag, $cb) = splice @_, 0, 2;
		440
		441	if (defined $cb) {
		442	$self->[1]{$tag} = $cb;
		443	} else {
		444	delete $self->[1]{$tag};
		445	}
		446	}
		447	}
		448
		449	$port
		450	}
		451
		452	=item $closure = psub { BLOCK }
		453
		454	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
		455	closure is executed, sets up the environment in the same way as in C<rcv>
		456	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		457
		458	This is useful when you register callbacks from C<rcv> callbacks:
		459
		460	rcv delayed_reply => sub {
		461	my ($delay, @reply) = @_;
		462	my $timer = AE::timer $delay, 0, psub {
		463	snd @reply, $SELF;
		464	};
		465	};
		466
		467	=cut
		468
		469	sub psub(&) {
		470	my $cb = shift;
		471
		472	my $port = $SELF
		473	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
		474
		475	sub {
		476	local $SELF = $port;
		477
		478	if (wantarray) {
		479	my @res = eval { &$cb };
		480	_self_die if $@;
		481	@res
		482	} else {
		483	my $res = eval { &$cb };
		484	_self_die if $@;
		485	$res
		486	}
		487	}
		488	}
		489
		490	=item $guard = mon $port, $cb->(@reason)
		491
		492	=item $guard = mon $port, $rcvport
		493
		494	=item $guard = mon $port
		495
		496	=item $guard = mon $port, $rcvport, @msg
		497
		498	Monitor the given port and do something when the port is killed or
		499	messages to it were lost, and optionally return a guard that can be used
		500	to stop monitoring again.
		501
		502	C<mon> effectively guarantees that, in the absence of hardware failures,
		503	that after starting the monitor, either all messages sent to the port
		504	will arrive, or the monitoring action will be invoked after possible
		505	message loss has been detected. No messages will be lost "in between"
		506	(after the first lost message no further messages will be received by the
		507	port). After the monitoring action was invoked, further messages might get
		508	delivered again.
		509
		510	In the first form (callback), the callback is simply called with any
		511	number of C<@reason> elements (no @reason means that the port was deleted
		512	"normally"). Note also that I<< the callback B<must> never die >>, so use
		513	C<eval> if unsure.
		514
		515	In the second form (another port given), the other port (C<$rcvport>)
		516	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
		517	"normal" kils nothing happens, while under all other conditions, the other
		518	port is killed with the same reason.
		519
		520	The third form (kill self) is the same as the second form, except that
		521	C<$rvport> defaults to C<$SELF>.
		522
		523	In the last form (message), a message of the form C<@msg, @reason> will be
		524	C<snd>.
		525
		526	As a rule of thumb, monitoring requests should always monitor a port from
		527	a local port (or callback). The reason is that kill messages might get
		528	lost, just like any other message. Another less obvious reason is that
		529	even monitoring requests can get lost (for exmaple, when the connection
		530	to the other node goes down permanently). When monitoring a port locally
		531	these problems do not exist.
		532
		533	Example: call a given callback when C<$port> is killed.
		534
		535	mon $port, sub { warn "port died because of <@_>\n" };
		536
		537	Example: kill ourselves when C<$port> is killed abnormally.
		538
		539	mon $port;
		540
		541	Example: send us a restart message when another C<$port> is killed.
		542
		543	mon $port, $self => "restart";
		544
		545	=cut
		546
136	sub mon {	547	sub mon {
137	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);	548	my ($noderef, $port) = split /#/, shift, 2;
138		549
139	my $node = AnyEvent::MP::Base::add_node $noderef;	550	my $node = $NODE{$noderef} \|\| add_node $noderef;
140		551
141	#TODO: ports must not be references	552	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) {	553
		554	unless (ref $cb) {
143	if (@_) {	555	if (@_) {
144	# send a kill info message	556	# send a kill info message
145	my (@msg) = ($cb, @_);	557	my (@msg) = ($cb, @_);
146	$cb = sub { snd @msg, @_ };	558	$cb = sub { snd @msg, @_ };
147	} else {	559	} else {
148	# simply kill other port	560	# simply kill other port
149	my $port = $cb;	561	my $port = $cb;
150	$cb = sub { kil $port, @_ };	562	$cb = sub { kil $port, @_ if @_ };
151	}	563	}
152	}	564	}
153		565
154	$node->monitor ($port, $cb);	566	$node->monitor ($port, $cb);
155		567
…		…
176	=cut	588	=cut
177		589
178	sub mon_guard {	590	sub mon_guard {
179	my ($port, @refs) = @_;	591	my ($port, @refs) = @_;
180		592
		593	#TODO: mon-less form?
		594
181	mon $port, sub { 0 && @refs }	595	mon $port, sub { 0 && @refs }
182	}	596	}
183		597
184	=item $local_port = create_port	598	=item kil $port[, @reason]
185		599
186	Create a new local port object. See the next section for allowed methods.	600	Kill the specified port with the given C<@reason>.
		601
		602	If no C<@reason> is specified, then the port is killed "normally" (linked
		603	ports will not be kileld, or even notified).
		604
		605	Otherwise, linked ports get killed with the same reason (second form of
		606	C<mon>, see below).
		607
		608	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
		609	will be reported as reason C<< die => $@ >>.
		610
		611	Transport/communication errors are reported as C<< transport_error =>
		612	$message >>.
187		613
188	=cut	614	=cut
189		615
190	sub create_port {	616	=item $port = spawn $node, $initfunc[, @initdata]
191	my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++;
192		617
193	my $self = bless {	618	Creates a port on the node C<$node> (which can also be a port ID, in which
194	id => "$NODE#$id",	619	case it's the node where that port resides).
195	}, "AnyEvent::MP::Port";
196		620
197	$AnyEvent::MP::Base::PORT{$id} = sub {	621	The port ID of the newly created port is return immediately, and it is
198	unshift @_, $self;	622	permissible to immediately start sending messages or monitor the port.
199		623
200	for (@{ $self->{rc0}{$_[1]} }) {	624	After the port has been created, the init function is
201	$_ && &{$_->[0]}	625	called. This function must be a fully-qualified function name
202	&& undef $_;	626	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
		627	program, use C<::name>.
		628
		629	If the function doesn't exist, then the node tries to C<require>
		630	the package, then the package above the package and so on (e.g.
		631	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		632	exists or it runs out of package names.
		633
		634	The init function is then called with the newly-created port as context
		635	object (C<$SELF>) and the C<@initdata> values as arguments.
		636
		637	A common idiom is to pass your own port, monitor the spawned port, and
		638	in the init function, monitor the original port. This two-way monitoring
		639	ensures that both ports get cleaned up when there is a problem.
		640
		641	Example: spawn a chat server port on C<$othernode>.
		642
		643	# this node, executed from within a port context:
		644	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		645	mon $server;
		646
		647	# init function on C<$othernode>
		648	sub connect {
		649	my ($srcport) = @_;
		650
		651	mon $srcport;
		652
		653	rcv $SELF, sub {
		654	...
203	}	655	};
		656	}
204		657
205	for (@{ $self->{rcv}{$_[1]} }) {	658	=cut
206	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
207	&& &{$_->[0]}
208	&& undef $_;
209	}
210		659
211	for (@{ $self->{any} }) {	660	sub _spawn {
212	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	661	my $port = shift;
213	&& &{$_->[0]}	662	my $init = shift;
214	&& undef $_;	663
215	}	664	local $SELF = "$NODE#$port";
		665	eval {
		666	&{ load_func $init }
216	};	667	};
217		668	_self_die if $@;
218	$self
219	}	669	}
220		670
221	=item $portid = miniport { my @msg = @_; $finished }	671	sub spawn(@) {
		672	my ($noderef, undef) = split /#/, shift, 2;
222		673
223	Creates a "mini port", that is, a very lightweight port without any	674	my $id = "$RUNIQ." . $ID++;
224	pattern matching behind it, and returns its ID.
225		675
226	The block will be called for every message received on the port. When the	676	$_[0] =~ /::/
227	callback returns a true value its job is considered "done" and the port	677	or Carp::croak "spawn init function must be a fully-qualified name, caught";
228	will be destroyed. Otherwise it will stay alive.
229		678
230	The message will be passed as-is, no extra argument (i.e. no port id) will	679	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;
231	be passed to the callback.
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 has a "remote ports are like local ports" philosophy, AEMP
		758	uses "local ports are like remote ports".
		759
		760	The failure modes for local ports are quite different (runtime errors
		761	only) then for remote ports - when a local port dies, you I<know> it dies,
		762	when a connection to another node dies, you know nothing about the other
		763	port.
		764
		765	Erlang pretends remote ports are as reliable as local ports, even when
		766	they are not.
		767
		768	AEMP encourages a "treat remote ports differently" philosophy, with local
		769	ports being the special case/exception, where transport errors cannot
		770	occur.
		771
		772	=item * Erlang uses processes and a mailbox, AEMP does not queue.
		773
		774	Erlang uses processes that selectively receive messages, and therefore
		775	needs a queue. AEMP is event based, queuing messages would serve no
		776	useful purpose. For the same reason the pattern-matching abilities of
		777	AnyEvent::MP are more limited, as there is little need to be able to
		778	filter messages without dequeing them.
		779
		780	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
		781
		782	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
		783
		784	Sending messages in Erlang is synchronous and blocks the process (and
		785	so does not need a queue that can overflow). AEMP sends are immediate,
		786	connection establishment is handled in the background.
		787
		788	=item * Erlang suffers from silent message loss, AEMP does not.
		789
		790	Erlang makes few guarantees on messages delivery - messages can get lost
		791	without any of the processes realising it (i.e. you send messages a, b,
		792	and c, and the other side only receives messages a and c).
		793
		794	AEMP guarantees correct ordering, and the guarantee that there are no
		795	holes in the message sequence.
		796
		797	=item * In Erlang, processes can be declared dead and later be found to be
		798	alive.
		799
		800	In Erlang it can happen that a monitored process is declared dead and
		801	linked processes get killed, but later it turns out that the process is
		802	still alive - and can receive messages.
		803
		804	In AEMP, when port monitoring detects a port as dead, then that port will
		805	eventually be killed - it cannot happen that a node detects a port as dead
		806	and then later sends messages to it, finding it is still alive.
		807
		808	=item * Erlang can send messages to the wrong port, AEMP does not.
		809
		810	In Erlang it is quite likely that a node that restarts reuses a process ID
		811	known to other nodes for a completely different process, causing messages
		812	destined for that process to end up in an unrelated process.
		813
		814	AEMP never reuses port IDs, so old messages or old port IDs floating
		815	around in the network will not be sent to an unrelated port.
		816
		817	=item * Erlang uses unprotected connections, AEMP uses secure
		818	authentication and can use TLS.
		819
		820	AEMP can use a proven protocol - SSL/TLS - to protect connections and
		821	securely authenticate nodes.
		822
		823	=item * The AEMP protocol is optimised for both text-based and binary
		824	communications.
		825
		826	The AEMP protocol, unlike the Erlang protocol, supports both
		827	language-independent text-only protocols (good for debugging) and binary,
		828	language-specific serialisers (e.g. Storable).
		829
		830	It has also been carefully designed to be implementable in other languages
		831	with a minimum of work while gracefully degrading fucntionality to make the
		832	protocol simple.
		833
		834	=item * AEMP has more flexible monitoring options than Erlang.
		835
		836	In Erlang, you can chose to receive I<all> exit signals as messages
		837	or I<none>, there is no in-between, so monitoring single processes is
		838	difficult to implement. Monitoring in AEMP is more flexible than in
		839	Erlang, as one can choose between automatic kill, exit message or callback
		840	on a per-process basis.
		841
		842	=item * Erlang tries to hide remote/local connections, AEMP does not.
		843
		844	Monitoring in Erlang is not an indicator of process death/crashes,
		845	as linking is (except linking is unreliable in Erlang).
		846
		847	In AEMP, you don't "look up" registered port names or send to named ports
		848	that might or might not be persistent. Instead, you normally spawn a port
		849	on the remote node. The init function monitors the you, and you monitor
		850	the remote port. Since both monitors are local to the node, they are much
		851	more reliable.
		852
		853	This also saves round-trips and avoids sending messages to the wrong port
		854	(hard to do in Erlang).
		855
		856	=back
		857
		858	=head1 RATIONALE
		859
		860	=over 4
		861
		862	=item Why strings for ports and noderefs, why not objects?
		863
		864	We considered "objects", but found that the actual number of methods
		865	thatc an be called are very low. Since port IDs and noderefs travel over
		866	the network frequently, the serialising/deserialising would add lots of
		867	overhead, as well as having to keep a proxy object.
		868
		869	Strings can easily be printed, easily serialised etc. and need no special
		870	procedures to be "valid".
		871
		872	And a a miniport consists of a single closure stored in a global hash - it
		873	can't become much cheaper.
		874
		875	=item Why favour JSON, why not real serialising format such as Storable?
		876
		877	In fact, any AnyEvent::MP node will happily accept Storable as framing
		878	format, but currently there is no way to make a node use Storable by
		879	default.
		880
		881	The default framing protocol is JSON because a) JSON::XS is many times
		882	faster for small messages and b) most importantly, after years of
		883	experience we found that object serialisation is causing more problems
		884	than it gains: Just like function calls, objects simply do not travel
		885	easily over the network, mostly because they will always be a copy, so you
		886	always have to re-think your design.
		887
		888	Keeping your messages simple, concentrating on data structures rather than
		889	objects, will keep your messages clean, tidy and efficient.
		890
		891	=back
		892
418	=head1 SEE ALSO	893	=head1 SEE ALSO
419		894
420	L<AnyEvent>.	895	L<AnyEvent>.
421		896
422	=head1 AUTHOR	897	=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.56 by root, Sat Aug 15 04:12:38 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.56 by root, Sat Aug 15 04:12:38 2009 UTC