[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.65 by root, Fri Aug 28 01:00:34 2009 UTC

…		…
8		8
9	$NODE # contains this node's noderef	9	$NODE # contains this node's noderef
10	NODE # returns this node's noderef	10	NODE # returns this node's noderef
11	NODE $port # returns the noderef of the port	11	NODE $port # returns the noderef of the port
12		12
		13	$SELF # receiving/own port id in rcv callbacks
		14
		15	# initialise the node so it can send/receive messages
		16	initialise_node;
		17
		18	# ports are message endpoints
		19
		20	# sending messages
13	snd $port, type => data...;	21	snd $port, type => data...;
		22	snd $port, @msg;
		23	snd @msg_with_first_element_being_a_port;
14		24
15	$SELF # receiving/own port id in rcv callbacks	25	# creating/using ports, the simple way
		26	my $simple_port = port { my @msg = @_; 0 };
16		27
17	rcv $port, smartmatch => $cb->($port, @msg);	28	# creating/using ports, tagged message matching
18		29	my $port = port;
19	# examples:
20	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	30	rcv $port, ping => sub { snd $_[0], "pong"; 0 };
21	rcv $port1, pong => sub { warn "pong received\n" };	31	rcv $port, pong => sub { warn "pong received\n"; 0 };
22	snd $port2, ping => $port1;
23		32
24	# more, smarter, matches (_any_ is exported by this module)	33	# create a port on another node
25	rcv $port, [child_died => $pid] => sub { ...	34	my $port = spawn $node, $initfunc, @initdata;
26	rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3	35
		36	# monitoring
		37	mon $port, $cb->(@msg) # callback is invoked on death
		38	mon $port, $otherport # kill otherport on abnormal death
		39	mon $port, $otherport, @msg # send message on death
		40
		41	=head1 CURRENT STATUS
		42
		43	AnyEvent::MP - stable API, should work
		44	AnyEvent::MP::Intro - outdated
		45	AnyEvent::MP::Kernel - WIP
		46	AnyEvent::MP::Transport - mostly stable
		47
		48	stay tuned.
27		49
28	=head1 DESCRIPTION	50	=head1 DESCRIPTION
29		51
30	This module (-family) implements a simple message passing framework.	52	This module (-family) implements a simple message passing framework.
31		53
32	Despite its simplicity, you can securely message other processes running	54	Despite its simplicity, you can securely message other processes running
33	on the same or other hosts.	55	on the same or other hosts.
34		56
		57	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
		58	manual page.
		59
35	At the moment, this module family is severly brokena nd underdocumented,	60	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 -	61	so do not use. This was uploaded mainly to reserve the CPAN namespace -
37	stay tuned!	62	stay tuned!
38		63
39	=head1 CONCEPTS	64	=head1 CONCEPTS
40		65
41	=over 4	66	=over 4
42		67
43	=item port	68	=item port
44		69
45	A port is something you can send messages to with the C<snd> function, and	70	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
47	messages they match, messages will not be queued.
48		71
		72	Ports allow you to register C<rcv> handlers that can match all or just
		73	some messages. Messages send to ports will not be queued, regardless of
		74	anything was listening for them or not.
		75
49	=item port id - C<noderef#portname>	76	=item port ID - C<noderef#portname>
50		77
51	A port id is always the noderef, a hash-mark (C<#>) as separator, followed	78	A port ID is the concatenation of a noderef, a hash-mark (C<#>) as
52	by a port name (a printable string of unspecified format).	79	separator, and a port name (a printable string of unspecified format). An
		80	exception is the the node port, whose ID is identical to its node
		81	reference.
53		82
54	=item node	83	=item node
55		84
56	A node is a single process containing at least one port - the node	85	A node is a single process containing at least one port - the node port,
57	port. You can send messages to node ports to let them create new ports,	86	which provides nodes to manage each other remotely, and to create new
58	among other things.	87	ports.
59		88
60	Initially, nodes are either private (single-process only) or hidden	89	Nodes are either private (single-process only), slaves (can only talk to
61	(connected to a master node only). Only when they epxlicitly "become	90	public nodes, but do not need an open port) or public nodes (connectable
62	public" can you send them messages from unrelated other nodes.	91	from any other node).
63		92
64	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	93	=item node ID - C<[a-za-Z0-9_\-.:]+>
65		94
66	A noderef is a string that either uniquely identifies a given node (for	95	A node ID is a string that uniquely identifies the node within a
67	private and hidden nodes), or contains a recipe on how to reach a given	96	network. Depending on the configuration used, node IDs can look like a
68	node (for public nodes).	97	hostname, a hostname and a port, or a random string. AnyEvent::MP itself
		98	doesn't interpret node IDs in any way.
		99
		100	=item binds - C<ip:port>
		101
		102	Nodes can only talk to each other by creating some kind of connection to
		103	each other. To do this, nodes should listen on one or more local transport
		104	endpoints - binds. Currently, only standard C<ip:port> specifications can
		105	be used, which specify TCP ports to listen on.
		106
		107	=item seeds - C<host:port>
		108
		109	When a node starts, it knows nothing about the network. To teach the node
		110	about the network it first has to contact some other node within the
		111	network. This node is called a seed.
		112
		113	Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes
		114	are expected to be long-running, and at least one of those should always
		115	be available. When nodes run out of connections (e.g. due to a network
		116	error), they try to re-establish connections to some seednodes again to
		117	join the network.
69		118
70	=back	119	=back
71		120
72	=head1 VARIABLES/FUNCTIONS	121	=head1 VARIABLES/FUNCTIONS
73		122
…		…
75		124
76	=cut	125	=cut
77		126
78	package AnyEvent::MP;	127	package AnyEvent::MP;
79		128
80	use AnyEvent::MP::Base;	129	use AnyEvent::MP::Kernel;
81		130
82	use common::sense;	131	use common::sense;
83		132
84	use Carp ();	133	use Carp ();
85		134
86	use AE ();	135	use AE ();
87		136
88	use base "Exporter";	137	use base "Exporter";
89		138
90	our $VERSION = '0.02';	139	our $VERSION = $AnyEvent::MP::Kernel::VERSION;
		140
91	our @EXPORT = qw(	141	our @EXPORT = qw(
92	NODE $NODE *SELF node_of _any_	142	NODE $NODE *SELF node_of after
93	become_slave become_public	143	resolve_node initialise_node
94	snd rcv mon kil reg psub	144	snd rcv mon mon_guard kil reg psub spawn
95	port	145	port
96	);	146	);
97		147
98	our $SELF;	148	our $SELF;
99		149
…		…
103	kil $SELF, die => $msg;	153	kil $SELF, die => $msg;
104	}	154	}
105		155
106	=item $thisnode = NODE / $NODE	156	=item $thisnode = NODE / $NODE
107		157
108	The C<NODE> function returns, and the C<$NODE> variable contains	158	The C<NODE> function returns, and the C<$NODE> variable contains the node
109	the noderef of the local node. The value is initialised by a call	159	ID of the node running in the current process. This value is initialised by
110	to C<become_public> or C<become_slave>, after which all local port	160	a call to C<initialise_node>.
111	identifiers become invalid.
112		161
113	=item $noderef = node_of $portid	162	=item $nodeid = node_of $port
114		163
115	Extracts and returns the noderef from a portid or a noderef.	164	Extracts and returns the node ID part from a port ID or a node ID.
		165
		166	=item initialise_node $profile_name
		167
		168	Before a node can talk to other nodes on the network (i.e. enter
		169	"distributed mode") it has to initialise itself - the minimum a node needs
		170	to know is its own name, and optionally it should know the addresses of
		171	some other nodes in the network to discover other nodes.
		172
		173	This function initialises a node - it must be called exactly once (or
		174	never) before calling other AnyEvent::MP functions.
		175
		176	The first argument is a profile name. If it is C<undef> or missing, then
		177	the current nodename will be used instead (i.e. F<uname -n>).
		178
		179	The function then looks up the profile in the aemp configuration (see the
		180	L<aemp> commandline utility).
		181
		182	If the profile specifies a node ID, then this will become the node ID of
		183	this process. If not, then the profile name will be used as node ID. The
		184	special node ID of C<anon/> will be replaced by a random node ID.
		185
		186	The next step is to look up the binds in the profile, followed by binding
		187	aemp protocol listeners on all binds specified (it is possible and valid
		188	to have no binds, meaning that the node cannot be contacted form the
		189	outside. This means the node cannot talk to other nodes that also have no
		190	binds, but it can still talk to all "normal" nodes).
		191
		192	If the profile does not specify a binds list, then the node ID will be
		193	treated as if it were of the form C<host:port>, which will be resolved and
		194	used as binds list.
		195
		196	Lastly, the seeds list from the profile is passed to the
		197	L<AnyEvent::MP::Global> module, which will then use it to keep
		198	connectivity with at least on of those seed nodes at any point in time.
		199
		200	Example: become a distributed node listening on the guessed noderef, or
		201	the one specified via C<aemp> for the current node. This should be the
		202	most common form of invocation for "daemon"-type nodes.
		203
		204	initialise_node;
		205
		206	Example: become an anonymous node. This form is often used for commandline
		207	clients.
		208
		209	initialise_node "anon/";
		210
		211	Example: become a distributed node. If there is no profile of the given
		212	name, or no binds list was specified, resolve C<localhost:4044> and bind
		213	on the resulting addresses.
		214
		215	initialise_node "localhost:4044";
116		216
117	=item $SELF	217	=item $SELF
118		218
119	Contains the current port id while executing C<rcv> callbacks or C<psub>	219	Contains the current port id while executing C<rcv> callbacks or C<psub>
120	blocks.	220	blocks.
…		…
123		223
124	Due to some quirks in how perl exports variables, it is impossible to	224	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	225	just export C<$SELF>, all the symbols called C<SELF> are exported by this
126	module, but only C<$SELF> is currently used.	226	module, but only C<$SELF> is currently used.
127		227
128	=item snd $portid, type => @data	228	=item snd $port, type => @data
129		229
130	=item snd $portid, @msg	230	=item snd $port, @msg
131		231
132	Send the given message to the given port ID, which can identify either	232	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	233	a local or a remote port, and must be a port ID.
134	stringifies a sa port ID (such as a port object :).
135		234
136	While the message can be about anything, it is highly recommended to use a	235	While the message can be about anything, it is highly recommended to use a
137	string as first element (a portid, or some word that indicates a request	236	string as first element (a port ID, or some word that indicates a request
138	type etc.).	237	type etc.).
139		238
140	The message data effectively becomes read-only after a call to this	239	The message data effectively becomes read-only after a call to this
141	function: modifying any argument is not allowed and can cause many	240	function: modifying any argument is not allowed and can cause many
142	problems.	241	problems.
…		…
145	JSON is used, then only strings, numbers and arrays and hashes consisting	244	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	245	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	246	that Storable can serialise and deserialise is allowed, and for the local
148	node, anything can be passed.	247	node, anything can be passed.
149		248
150	=item kil $portid[, @reason]	249	=item $local_port = port
151		250
152	Kill the specified port with the given C<@reason>.	251	Create a new local port object and returns its port ID. Initially it has
		252	no callbacks set and will throw an error when it receives messages.
153		253
154	If no C<@reason> is specified, then the port is killed "normally" (linked	254	=item $local_port = port { my @msg = @_ }
155	ports will not be kileld, or even notified).
156		255
157	Otherwise, linked ports get killed with the same reason (second form of	256	Creates a new local port, and returns its ID. Semantically the same as
158	C<mon>, see below).	257	creating a port and calling C<rcv $port, $callback> on it.
159		258
160	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks	259	The block will be called for every message received on the port, with the
161	will be reported as reason C<< die => $@ >>.	260	global variable C<$SELF> set to the port ID. Runtime errors will cause the
		261	port to be C<kil>ed. The message will be passed as-is, no extra argument
		262	(i.e. no port ID) will be passed to the callback.
162		263
163	Transport/communication errors are reported as C<< transport_error =>	264	If you want to stop/destroy the port, simply C<kil> it:
164	$message >>.
165		265
		266	my $port = port {
		267	my @msg = @_;
		268	...
		269	kil $SELF;
		270	};
		271
		272	=cut
		273
		274	sub rcv($@);
		275
		276	sub _kilme {
		277	die "received message on port without callback";
		278	}
		279
		280	sub port(;&) {
		281	my $id = "$UNIQ." . $ID++;
		282	my $port = "$NODE#$id";
		283
		284	rcv $port, shift \|\| \&_kilme;
		285
		286	$port
		287	}
		288
		289	=item rcv $local_port, $callback->(@msg)
		290
		291	Replaces the default callback on the specified port. There is no way to
		292	remove the default callback: use C<sub { }> to disable it, or better
		293	C<kil> the port when it is no longer needed.
		294
		295	The global C<$SELF> (exported by this module) contains C<$port> while
		296	executing the callback. Runtime errors during callback execution will
		297	result in the port being C<kil>ed.
		298
		299	The default callback received all messages not matched by a more specific
		300	C<tag> match.
		301
		302	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
		303
		304	Register (or replace) callbacks to be called on messages starting with the
		305	given tag on the given port (and return the port), or unregister it (when
		306	C<$callback> is C<$undef> or missing). There can only be one callback
		307	registered for each tag.
		308
		309	The original message will be passed to the callback, after the first
		310	element (the tag) has been removed. The callback will use the same
		311	environment as the default callback (see above).
		312
		313	Example: create a port and bind receivers on it in one go.
		314
		315	my $port = rcv port,
		316	msg1 => sub { ... },
		317	msg2 => sub { ... },
		318	;
		319
		320	Example: create a port, bind receivers and send it in a message elsewhere
		321	in one go:
		322
		323	snd $otherport, reply =>
		324	rcv port,
		325	msg1 => sub { ... },
		326	...
		327	;
		328
		329	Example: temporarily register a rcv callback for a tag matching some port
		330	(e.g. for a rpc reply) and unregister it after a message was received.
		331
		332	rcv $port, $otherport => sub {
		333	my @reply = @_;
		334
		335	rcv $SELF, $otherport;
		336	};
		337
		338	=cut
		339
		340	sub rcv($@) {
		341	my $port = shift;
		342	my ($noderef, $portid) = split /#/, $port, 2;
		343
		344	$NODE{$noderef} == $NODE{""}
		345	or Carp::croak "$port: rcv can only be called on local ports, caught";
		346
		347	while (@_) {
		348	if (ref $_[0]) {
		349	if (my $self = $PORT_DATA{$portid}) {
		350	"AnyEvent::MP::Port" eq ref $self
		351	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		352
		353	$self->[2] = shift;
		354	} else {
		355	my $cb = shift;
		356	$PORT{$portid} = sub {
		357	local $SELF = $port;
		358	eval { &$cb }; _self_die if $@;
		359	};
		360	}
		361	} elsif (defined $_[0]) {
		362	my $self = $PORT_DATA{$portid} \|\|= do {
		363	my $self = bless [$PORT{$port} \|\| sub { }, { }, $port], "AnyEvent::MP::Port";
		364
		365	$PORT{$portid} = sub {
		366	local $SELF = $port;
		367
		368	if (my $cb = $self->[1]{$_[0]}) {
		369	shift;
		370	eval { &$cb }; _self_die if $@;
		371	} else {
		372	&{ $self->[0] };
		373	}
		374	};
		375
		376	$self
		377	};
		378
		379	"AnyEvent::MP::Port" eq ref $self
		380	or Carp::croak "$port: rcv can only be called on message matching ports, caught";
		381
		382	my ($tag, $cb) = splice @_, 0, 2;
		383
		384	if (defined $cb) {
		385	$self->[1]{$tag} = $cb;
		386	} else {
		387	delete $self->[1]{$tag};
		388	}
		389	}
		390	}
		391
		392	$port
		393	}
		394
		395	=item $closure = psub { BLOCK }
		396
		397	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
		398	closure is executed, sets up the environment in the same way as in C<rcv>
		399	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
		400
		401	This is useful when you register callbacks from C<rcv> callbacks:
		402
		403	rcv delayed_reply => sub {
		404	my ($delay, @reply) = @_;
		405	my $timer = AE::timer $delay, 0, psub {
		406	snd @reply, $SELF;
		407	};
		408	};
		409
		410	=cut
		411
		412	sub psub(&) {
		413	my $cb = shift;
		414
		415	my $port = $SELF
		416	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
		417
		418	sub {
		419	local $SELF = $port;
		420
		421	if (wantarray) {
		422	my @res = eval { &$cb };
		423	_self_die if $@;
		424	@res
		425	} else {
		426	my $res = eval { &$cb };
		427	_self_die if $@;
		428	$res
		429	}
		430	}
		431	}
		432
166	=item $guard = mon $portid, $cb->(@reason)	433	=item $guard = mon $port, $cb->(@reason)
167		434
168	=item $guard = mon $portid, $otherport	435	=item $guard = mon $port, $rcvport
169		436
		437	=item $guard = mon $port
		438
170	=item $guard = mon $portid, $otherport, @msg	439	=item $guard = mon $port, $rcvport, @msg
171		440
172	Monitor the given port and do something when the port is killed.	441	Monitor the given port and do something when the port is killed or
		442	messages to it were lost, and optionally return a guard that can be used
		443	to stop monitoring again.
173		444
		445	C<mon> effectively guarantees that, in the absence of hardware failures,
		446	that after starting the monitor, either all messages sent to the port
		447	will arrive, or the monitoring action will be invoked after possible
		448	message loss has been detected. No messages will be lost "in between"
		449	(after the first lost message no further messages will be received by the
		450	port). After the monitoring action was invoked, further messages might get
		451	delivered again.
		452
		453	Note that monitoring-actions are one-shot: once released, they are removed
		454	and will not trigger again.
		455
174	In the first form, the callback is simply called with any number	456	In the first form (callback), the callback is simply called with any
175	of C<@reason> elements (no @reason means that the port was deleted	457	number 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	458	"normally"). Note also that I<< the callback B<must> never die >>, so use
177	C<eval> if unsure.	459	C<eval> if unsure.
178		460
179	In the second form, the other port will be C<kil>'ed with C<@reason>, iff	461	In the second form (another port given), the other port (C<$rcvport>)
180	a @reason was specified, i.e. on "normal" kils nothing happens, while	462	will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
181	under all other conditions, the other port is killed with the same reason.	463	"normal" kils nothing happens, while under all other conditions, the other
		464	port is killed with the same reason.
182		465
		466	The third form (kill self) is the same as the second form, except that
		467	C<$rvport> defaults to C<$SELF>.
		468
183	In the last form, a message of the form C<@msg, @reason> will be C<snd>.	469	In the last form (message), a message of the form C<@msg, @reason> will be
		470	C<snd>.
		471
		472	As a rule of thumb, monitoring requests should always monitor a port from
		473	a local port (or callback). The reason is that kill messages might get
		474	lost, just like any other message. Another less obvious reason is that
		475	even monitoring requests can get lost (for exmaple, when the connection
		476	to the other node goes down permanently). When monitoring a port locally
		477	these problems do not exist.
184		478
185	Example: call a given callback when C<$port> is killed.	479	Example: call a given callback when C<$port> is killed.
186		480
187	mon $port, sub { warn "port died because of <@_>\n" };	481	mon $port, sub { warn "port died because of <@_>\n" };
188		482
189	Example: kill ourselves when C<$port> is killed abnormally.	483	Example: kill ourselves when C<$port> is killed abnormally.
190		484
191	mon $port, $self;	485	mon $port;
192		486
193	Example: send us a restart message another C<$port> is killed.	487	Example: send us a restart message when another C<$port> is killed.
194		488
195	mon $port, $self => "restart";	489	mon $port, $self => "restart";
196		490
197	=cut	491	=cut
198		492
199	sub mon {	493	sub mon {
200	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);	494	my ($noderef, $port) = split /#/, shift, 2;
201		495
202	my $node = $NODE{$noderef} \|\| add_node $noderef;	496	my $node = $NODE{$noderef} \|\| add_node $noderef;
203		497
204	#TODO: ports must not be references	498	my $cb = @_ ? shift : $SELF \|\| Carp::croak 'mon: called with one argument only, but $SELF not set,';
205	if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) {	499
		500	unless (ref $cb) {
206	if (@_) {	501	if (@_) {
207	# send a kill info message	502	# send a kill info message
208	my (@msg) = ($cb, @_);	503	my (@msg) = ($cb, @_);
209	$cb = sub { snd @msg, @_ };	504	$cb = sub { snd @msg, @_ };
210	} else {	505	} else {
…		…
239	=cut	534	=cut
240		535
241	sub mon_guard {	536	sub mon_guard {
242	my ($port, @refs) = @_;	537	my ($port, @refs) = @_;
243		538
		539	#TODO: mon-less form?
		540
244	mon $port, sub { 0 && @refs }	541	mon $port, sub { 0 && @refs }
245	}	542	}
246		543
247	=item $local_port = port	544	=item kil $port[, @reason]
248		545
249	Create a new local port object that supports message matching.	546	Kill the specified port with the given C<@reason>.
250		547
251	=item $portid = port { my @msg = @_; $finished }	548	If no C<@reason> is specified, then the port is killed "normally" (linked
		549	ports will not be kileld, or even notified).
252		550
253	Creates a "mini port", that is, a very lightweight port without any	551	Otherwise, linked ports get killed with the same reason (second form of
254	pattern matching behind it, and returns its ID.	552	C<mon>, see below).
255		553
256	The block will be called for every message received on the port. When the	554	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
257	callback returns a true value its job is considered "done" and the port	555	will be reported as reason C<< die => $@ >>.
258	will be destroyed. Otherwise it will stay alive.
259		556
260	The message will be passed as-is, no extra argument (i.e. no port id) will	557	Transport/communication errors are reported as C<< transport_error =>
261	be passed to the callback.	558	$message >>.
262		559
263	If you need the local port id in the callback, this works nicely:
264
265	my $port; $port = miniport {
266	snd $otherport, reply => $port;
267	};
268
269	=cut	560	=cut
270		561
271	sub port(;&) {	562	=item $port = spawn $node, $initfunc[, @initdata]
272	my $id = "$UNIQ." . $ID++;
273	my $port = "$NODE#$id";
274		563
275	if (@_) {	564	Creates a port on the node C<$node> (which can also be a port ID, in which
276	my $cb = shift;	565	case it's the node where that port resides).
277	$PORT{$id} = sub {	566
278	local $SELF = $port;	567	The port ID of the newly created port is return immediately, and it is
279	eval {	568	permissible to immediately start sending messages or monitor the port.
280	&$cb	569
281	and kil $id;	570	After the port has been created, the init function is
		571	called. This function must be a fully-qualified function name
		572	(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
		573	program, use C<::name>.
		574
		575	If the function doesn't exist, then the node tries to C<require>
		576	the package, then the package above the package and so on (e.g.
		577	C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
		578	exists or it runs out of package names.
		579
		580	The init function is then called with the newly-created port as context
		581	object (C<$SELF>) and the C<@initdata> values as arguments.
		582
		583	A common idiom is to pass your own port, monitor the spawned port, and
		584	in the init function, monitor the original port. This two-way monitoring
		585	ensures that both ports get cleaned up when there is a problem.
		586
		587	Example: spawn a chat server port on C<$othernode>.
		588
		589	# this node, executed from within a port context:
		590	my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
		591	mon $server;
		592
		593	# init function on C<$othernode>
		594	sub connect {
		595	my ($srcport) = @_;
		596
		597	mon $srcport;
		598
		599	rcv $SELF, sub {
282	};	600	...
283	_self_die if $@;
284	};
285	} else {
286	my $self = bless {
287	id => "$NODE#$id",
288	}, "AnyEvent::MP::Port";
289
290	$PORT_DATA{$id} = $self;
291	$PORT{$id} = sub {
292	local $SELF = $port;
293
294	eval {
295	for (@{ $self->{rc0}{$_[0]} }) {
296	$_ && &{$_->[0]}
297	&& undef $_;
298	}
299
300	for (@{ $self->{rcv}{$_[0]} }) {
301	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
302	&& &{$_->[0]}
303	&& undef $_;
304	}
305
306	for (@{ $self->{any} }) {
307	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
308	&& &{$_->[0]}
309	&& undef $_;
310	}
311	};
312	_self_die if $@;
313	};	601	};
314	}	602	}
315		603
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	604	=cut
329		605
330	sub reg(@) {	606	sub _spawn {
331	my ($portid, $name) = @_;	607	my $port = shift;
		608	my $init = shift;
332		609
333	$REG{$name} = $portid;	610	local $SELF = "$NODE#$port";
334	}	611	eval {
335		612	&{ load_func $init }
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
377	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
378
379	while (@_) {
380	my ($match, $cb) = splice @_, 0, 2;
381
382	if (!ref $match) {
383	push @{ $self->{rc0}{$match} }, [$cb];
384	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
385	my ($type, @match) = @$match;
386	@match
387	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
388	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
389	} else {
390	push @{ $self->{any} }, [$cb, $match];
391	}
392	}
393	}
394
395	=item $closure = psub { BLOCK }
396
397	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
398	closure is executed, sets up the environment in the same way as in C<rcv>
399	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
400
401	This is useful when you register callbacks from C<rcv> callbacks:
402
403	rcv delayed_reply => sub {
404	my ($delay, @reply) = @_;
405	my $timer = AE::timer $delay, 0, psub {
406	snd @reply, $SELF;
407	};
408	};	613	};
409
410	=cut
411
412	sub psub(&) {
413	my $cb = shift;
414
415	my $port = $SELF
416	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
417
418	sub {
419	local $SELF = $port;
420
421	if (wantarray) {
422	my @res = eval { &$cb };
423	_self_die if $@;	614	_self_die if $@;
424	@res	615	}
425	} else {	616
426	my $res = eval { &$cb };	617	sub spawn(@) {
427	_self_die if $@;	618	my ($noderef, undef) = split /#/, shift, 2;
428	$res	619
429	}	620	my $id = "$RUNIQ." . $ID++;
		621
		622	$_[0] =~ /::/
		623	or Carp::croak "spawn init function must be a fully-qualified name, caught";
		624
		625	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;
		626
		627	"$noderef#$id"
		628	}
		629
		630	=item after $timeout, @msg
		631
		632	=item after $timeout, $callback
		633
		634	Either sends the given message, or call the given callback, after the
		635	specified number of seconds.
		636
		637	This is simply a utility function that come sin handy at times.
		638
		639	=cut
		640
		641	sub after($@) {
		642	my ($timeout, @action) = @_;
		643
		644	my $t; $t = AE::timer $timeout, 0, sub {
		645	undef $t;
		646	ref $action[0]
		647	? $action[0]()
		648	: snd @action;
430	}	649	};
431	}	650	}
432		651
433	=back	652	=back
434		653
435	=head1 FUNCTIONS FOR NODES	654	=head1 AnyEvent::MP vs. Distributed Erlang
		655
		656	AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
		657	== aemp node, Erlang process == aemp port), so many of the documents and
		658	programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
		659	sample:
		660
		661	http://www.Erlang.se/doc/programming_rules.shtml
		662	http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
		663	http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6
		664	http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
		665
		666	Despite the similarities, there are also some important differences:
436		667
437	=over 4	668	=over 4
438		669
439	=item become_public endpoint...	670	=item * Node IDs are arbitrary strings in AEMP.
440		671
441	Tells the node to become a public node, i.e. reachable from other nodes.	672	Erlang relies on special naming and DNS to work everywhere in the same
		673	way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
		674	configuraiton or DNS), but will otherwise discover other odes itself.
442		675
443	If no arguments are given, or the first argument is C<undef>, then	676	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
444	AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the	677	uses "local ports are like remote ports".
445	local nodename resolves to.
446		678
447	Otherwise the first argument must be an array-reference with transport	679	The failure modes for local ports are quite different (runtime errors
448	endpoints ("ip:port", "hostname:port") or port numbers (in which case the	680	only) then for remote ports - when a local port dies, you I<know> it dies,
449	local nodename is used as hostname). The endpoints are all resolved and	681	when a connection to another node dies, you know nothing about the other
450	will become the node reference.	682	port.
451		683
452	=cut	684	Erlang pretends remote ports are as reliable as local ports, even when
		685	they are not.
		686
		687	AEMP encourages a "treat remote ports differently" philosophy, with local
		688	ports being the special case/exception, where transport errors cannot
		689	occur.
		690
		691	=item * Erlang uses processes and a mailbox, AEMP does not queue.
		692
		693	Erlang uses processes that selectively receive messages, and therefore
		694	needs a queue. AEMP is event based, queuing messages would serve no
		695	useful purpose. For the same reason the pattern-matching abilities of
		696	AnyEvent::MP are more limited, as there is little need to be able to
		697	filter messages without dequeing them.
		698
		699	(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
		700
		701	=item * Erlang sends are synchronous, AEMP sends are asynchronous.
		702
		703	Sending messages in Erlang is synchronous and blocks the process (and
		704	so does not need a queue that can overflow). AEMP sends are immediate,
		705	connection establishment is handled in the background.
		706
		707	=item * Erlang suffers from silent message loss, AEMP does not.
		708
		709	Erlang makes few guarantees on messages delivery - messages can get lost
		710	without any of the processes realising it (i.e. you send messages a, b,
		711	and c, and the other side only receives messages a and c).
		712
		713	AEMP guarantees correct ordering, and the guarantee that there are no
		714	holes in the message sequence.
		715
		716	=item * In Erlang, processes can be declared dead and later be found to be
		717	alive.
		718
		719	In Erlang it can happen that a monitored process is declared dead and
		720	linked processes get killed, but later it turns out that the process is
		721	still alive - and can receive messages.
		722
		723	In AEMP, when port monitoring detects a port as dead, then that port will
		724	eventually be killed - it cannot happen that a node detects a port as dead
		725	and then later sends messages to it, finding it is still alive.
		726
		727	=item * Erlang can send messages to the wrong port, AEMP does not.
		728
		729	In Erlang it is quite likely that a node that restarts reuses a process ID
		730	known to other nodes for a completely different process, causing messages
		731	destined for that process to end up in an unrelated process.
		732
		733	AEMP never reuses port IDs, so old messages or old port IDs floating
		734	around in the network will not be sent to an unrelated port.
		735
		736	=item * Erlang uses unprotected connections, AEMP uses secure
		737	authentication and can use TLS.
		738
		739	AEMP can use a proven protocol - SSL/TLS - to protect connections and
		740	securely authenticate nodes.
		741
		742	=item * The AEMP protocol is optimised for both text-based and binary
		743	communications.
		744
		745	The AEMP protocol, unlike the Erlang protocol, supports both
		746	language-independent text-only protocols (good for debugging) and binary,
		747	language-specific serialisers (e.g. Storable).
		748
		749	It has also been carefully designed to be implementable in other languages
		750	with a minimum of work while gracefully degrading fucntionality to make the
		751	protocol simple.
		752
		753	=item * AEMP has more flexible monitoring options than Erlang.
		754
		755	In Erlang, you can chose to receive I<all> exit signals as messages
		756	or I<none>, there is no in-between, so monitoring single processes is
		757	difficult to implement. Monitoring in AEMP is more flexible than in
		758	Erlang, as one can choose between automatic kill, exit message or callback
		759	on a per-process basis.
		760
		761	=item * Erlang tries to hide remote/local connections, AEMP does not.
		762
		763	Monitoring in Erlang is not an indicator of process death/crashes,
		764	as linking is (except linking is unreliable in Erlang).
		765
		766	In AEMP, you don't "look up" registered port names or send to named ports
		767	that might or might not be persistent. Instead, you normally spawn a port
		768	on the remote node. The init function monitors the you, and you monitor
		769	the remote port. Since both monitors are local to the node, they are much
		770	more reliable.
		771
		772	This also saves round-trips and avoids sending messages to the wrong port
		773	(hard to do in Erlang).
453		774
454	=back	775	=back
455		776
456	=head1 NODE MESSAGES	777	=head1 RATIONALE
457
458	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
460	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.
462		778
463	=over 4	779	=over 4
464		780
465	=cut	781	=item Why strings for ports and noderefs, why not objects?
466		782
467	=item lookup => $name, @reply	783	We considered "objects", but found that the actual number of methods
		784	thatc an be called are very low. Since port IDs and noderefs travel over
		785	the network frequently, the serialising/deserialising would add lots of
		786	overhead, as well as having to keep a proxy object.
468		787
469	Replies with the port ID of the specified well-known port, or C<undef>.	788	Strings can easily be printed, easily serialised etc. and need no special
		789	procedures to be "valid".
470		790
471	=item devnull => ...	791	And a a miniport consists of a single closure stored in a global hash - it
		792	can't become much cheaper.
472		793
473	Generic data sink/CPU heat conversion.	794	=item Why favour JSON, why not real serialising format such as Storable?
474		795
475	=item relay => $port, @msg	796	In fact, any AnyEvent::MP node will happily accept Storable as framing
		797	format, but currently there is no way to make a node use Storable by
		798	default.
476		799
477	Simply forwards the message to the given port.	800	The default framing protocol is JSON because a) JSON::XS is many times
		801	faster for small messages and b) most importantly, after years of
		802	experience we found that object serialisation is causing more problems
		803	than it gains: Just like function calls, objects simply do not travel
		804	easily over the network, mostly because they will always be a copy, so you
		805	always have to re-think your design.
478		806
479	=item eval => $string[ @reply]	807	Keeping your messages simple, concentrating on data structures rather than
480		808	objects, will keep your messages clean, tidy and efficient.
481	Evaluates the given string. If C<@reply> is given, then a message of the
482	form C<@reply, $@, @evalres> is sent.
483
484	Example: crash another node.
485
486	snd $othernode, eval => "exit";
487
488	=item time => @reply
489
490	Replies the the current node time to C<@reply>.
491
492	Example: tell the current node to send the current time to C<$myport> in a
493	C<timereply> message.
494
495	snd $NODE, time => $myport, timereply => 1, 2;
496	# => snd $myport, timereply => 1, 2, <time>
497		809
498	=back	810	=back
499		811
500	=head1 SEE ALSO	812	=head1 SEE ALSO
501		813

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.65 by root, Fri Aug 28 01:00:34 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.65 by root, Fri Aug 28 01:00:34 2009 UTC