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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.53 by root, Fri Aug 14 15:31:21 2009 UTC vs.
Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC

…		…
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	13	$SELF # receiving/own port id in rcv callbacks
14		14
15	# initialise the node so it can send/receive messages	15	# initialise the node so it can send/receive messages
16	initialise_node; # -OR-	16	initialise_node;
17	initialise_node "localhost:4040"; # -OR-
18	initialise_node "slave/", "localhost:4040"
19		17
20	# ports are message endpoints	18	# ports are message endpoints
21		19
22	# sending messages	20	# sending messages
23	snd $port, type => data...;	21	snd $port, type => data...;
…		…
72	A port is something you can send messages to (with the C<snd> function).	70	A port is something you can send messages to (with the C<snd> function).
73		71
74	Ports allow you to register C<rcv> handlers that can match all or just	72	Ports allow you to register C<rcv> handlers that can match all or just
75	some messages. Messages will not be queued.	73	some messages. Messages will not be queued.
76		74
77	=item port id - C<noderef#portname>	75	=item port ID - C<noderef#portname>
78		76
79	A port ID is the concatenation of a noderef, a hash-mark (C<#>) as	77	A port ID is the concatenation of a noderef, a hash-mark (C<#>) as
80	separator, and a port name (a printable string of unspecified format). An	78	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	79	exception is the the node port, whose ID is identical to its node
82	reference.	80	reference.
…		…
85		83
86	A node is a single process containing at least one port - the node port,	84	A node is a single process containing at least one port - the node port,
87	which provides nodes to manage each other remotely, and to create new	85	which provides nodes to manage each other remotely, and to create new
88	ports.	86	ports.
89		87
90	Nodes are either private (single-process only), slaves (connected to a	88	Nodes are either private (single-process only), slaves (can only talk to
91	master node only) or public nodes (connectable from unrelated nodes).	89	public nodes, but do not need an open port) or public nodes (connectable
		90	from any other node).
92		91
93	=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>	92	=item node ID - C<[a-za-Z0-9_\-.:]+>
94		93
95	A node reference is a string that either simply identifies the node (for	94	A node ID is a string that either simply identifies the node (for
96	private and slave nodes), or contains a recipe on how to reach a given	95	private and slave nodes), or contains a recipe on how to reach a given
97	node (for public nodes).	96	node (for public nodes).
98		97
99	This recipe is simply a comma-separated list of C<address:port> pairs (for	98	This recipe is simply a comma-separated list of C<address:port> pairs (for
100	TCP/IP, other protocols might look different).	99	TCP/IP, other protocols might look different).
…		…
126	use base "Exporter";	125	use base "Exporter";
127		126
128	our $VERSION = $AnyEvent::MP::Kernel::VERSION;	127	our $VERSION = $AnyEvent::MP::Kernel::VERSION;
129		128
130	our @EXPORT = qw(	129	our @EXPORT = qw(
131	NODE $NODE *SELF node_of _any_	130	NODE $NODE *SELF node_of after
132	resolve_node initialise_node	131	resolve_node initialise_node
133	snd rcv mon kil reg psub spawn	132	snd rcv mon mon_guard kil reg psub spawn
134	port	133	port
135	);	134	);
136		135
137	our $SELF;	136	our $SELF;
138		137
…		…
143	}	142	}
144		143
145	=item $thisnode = NODE / $NODE	144	=item $thisnode = NODE / $NODE
146		145
147	The C<NODE> function returns, and the C<$NODE> variable contains the	146	The C<NODE> function returns, and the C<$NODE> variable contains the
148	noderef of the local node. The value is initialised by a call to	147	node id of the local node. The value is initialised by a call to
149	C<initialise_node>.	148	C<initialise_node>.
150		149
151	=item $noderef = node_of $port	150	=item $nodeid = node_of $port
152		151
153	Extracts and returns the noderef from a port ID or a noderef.	152	Extracts and returns the noderef from a port ID or a node ID.
154		153
155	=item initialise_node $noderef, $seednode, $seednode...	154	=item initialise_node $profile_name
156
157	=item initialise_node "slave/", $master, $master...
158		155
159	Before a node can talk to other nodes on the network it has to initialise	156	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	157	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.	158	it should know the noderefs of some other nodes in the network.
162		159
…		…
180		177
181	For public nodes, C<$noderef> (supplied either directly to	178	For public nodes, C<$noderef> (supplied either directly to
182	C<initialise_node> or indirectly via a profile or the nodename) must be a	179	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).	180	noderef (possibly unresolved, in which case it will be resolved).
184		181
185	After resolving, the node will bind itself on all endpoints and try to	182	After resolving, the node will bind itself on all endpoints.
186	connect to all additional C<$seednodes> that are specified. Seednodes are	183
		184	=item slave nodes
		185
		186	When the C<$noderef> (either as given or overriden by the config file)
		187	is the special string C<slave/>, then the node will become a slave
		188	node. Slave nodes cannot be contacted from outside, and cannot talk to
		189	each other (at least in this version of AnyEvent::MP).
		190
		191	Slave nodes work by creating connections to all public nodes, using the
		192	L<AnyEvent::MP::Global> service.
		193
		194	=back
		195
		196	After initialising itself, the node will connect to all additional
		197	C<$seednodes> that are specified diretcly or via a profile. Seednodes are
187	optional and can be used to quickly bootstrap the node into an existing	198	optional and can be used to quickly bootstrap the node into an existing
188	network.	199	network.
189		200
190	=item slave nodes	201	All the seednodes will also be specially marked to automatically retry
191		202	connecting to them indefinitely, so make sure that seednodes are really
192	When the C<$noderef> (either as given or overriden by the config file)	203	reliable and up (this might also change in the future).
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	=back
203
204	This function will block until all nodes have been resolved and, for slave
205	nodes, until it has successfully established a connection to a master
206	server.
207		204
208	Example: become a public node listening on the guessed noderef, or the one	205	Example: become a public node listening on the guessed noderef, or the one
209	specified via C<aemp> for the current node. This should be the most common	206	specified via C<aemp> for the current node. This should be the most common
210	form of invocation for "daemon"-type nodes.	207	form of invocation for "daemon"-type nodes.
211		208
…		…
213		210
214	Example: become a slave node to any of the the seednodes specified via	211	Example: become a slave node to any of the the seednodes specified via
215	C<aemp>. This form is often used for commandline clients.	212	C<aemp>. This form is often used for commandline clients.
216		213
217	initialise_node "slave/";	214	initialise_node "slave/";
218
219	Example: become a slave node to any of the specified master servers. This
220	form is also often used for commandline clients.
221
222	initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
223		215
224	Example: become a public node, and try to contact some well-known master	216	Example: become a public node, and try to contact some well-known master
225	servers to become part of the network.	217	servers to become part of the network.
226		218
227	initialise_node undef, "master1", "master2";	219	initialise_node undef, "master1", "master2";
…		…
348	The default callback received all messages not matched by a more specific	340	The default callback received all messages not matched by a more specific
349	C<tag> match.	341	C<tag> match.
350		342
351	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...	343	=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
352		344
353	Register callbacks to be called on messages starting with the given tag on	345	Register (or replace) callbacks to be called on messages starting with the
354	the given port (and return the port), or unregister it (when C<$callback>	346	given tag on the given port (and return the port), or unregister it (when
355	is C<$undef>).	347	C<$callback> is C<$undef> or missing). There can only be one callback
		348	registered for each tag.
356		349
357	The original message will be passed to the callback, after the first	350	The original message will be passed to the callback, after the first
358	element (the tag) has been removed. The callback will use the same	351	element (the tag) has been removed. The callback will use the same
359	environment as the default callback (see above).	352	environment as the default callback (see above).
360		353
…		…
372	rcv port,	365	rcv port,
373	msg1 => sub { ... },	366	msg1 => sub { ... },
374	...	367	...
375	;	368	;
376		369
		370	Example: temporarily register a rcv callback for a tag matching some port
		371	(e.g. for a rpc reply) and unregister it after a message was received.
		372
		373	rcv $port, $otherport => sub {
		374	my @reply = @_;
		375
		376	rcv $SELF, $otherport;
		377	};
		378
377	=cut	379	=cut
378		380
379	sub rcv($@) {	381	sub rcv($@) {
380	my $port = shift;	382	my $port = shift;
381	my ($noderef, $portid) = split /#/, $port, 2;	383	my ($noderef, $portid) = split /#/, $port, 2;
382		384
383	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}	385	$NODE{$noderef} == $NODE{""}
384	or Carp::croak "$port: rcv can only be called on local ports, caught";	386	or Carp::croak "$port: rcv can only be called on local ports, caught";
385		387
386	while (@_) {	388	while (@_) {
387	if (ref $_[0]) {	389	if (ref $_[0]) {
388	if (my $self = $PORT_DATA{$portid}) {	390	if (my $self = $PORT_DATA{$portid}) {
…		…
487	message loss has been detected. No messages will be lost "in between"	489	message loss has been detected. No messages will be lost "in between"
488	(after the first lost message no further messages will be received by the	490	(after the first lost message no further messages will be received by the
489	port). After the monitoring action was invoked, further messages might get	491	port). After the monitoring action was invoked, further messages might get
490	delivered again.	492	delivered again.
491		493
		494	Note that monitoring-actions are one-shot: once released, they are removed
		495	and will not trigger again.
		496
492	In the first form (callback), the callback is simply called with any	497	In the first form (callback), the callback is simply called with any
493	number of C<@reason> elements (no @reason means that the port was deleted	498	number of C<@reason> elements (no @reason means that the port was deleted
494	"normally"). Note also that I<< the callback B<must> never die >>, so use	499	"normally"). Note also that I<< the callback B<must> never die >>, so use
495	C<eval> if unsure.	500	C<eval> if unsure.
496		501
…		…
656	my $id = "$RUNIQ." . $ID++;	661	my $id = "$RUNIQ." . $ID++;
657		662
658	$_[0] =~ /::/	663	$_[0] =~ /::/
659	or Carp::croak "spawn init function must be a fully-qualified name, caught";	664	or Carp::croak "spawn init function must be a fully-qualified name, caught";
660		665
661	($NODE{$noderef} \|\| add_node $noderef)	666	snd_to_func $noderef, "AnyEvent::MP::_spawn" => $id, @_;
662	->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
663		667
664	"$noderef#$id"	668	"$noderef#$id"
665	}	669	}
666		670
667	=back	671	=item after $timeout, @msg
668		672
669	=head1 NODE MESSAGES	673	=item after $timeout, $callback
670		674
671	Nodes understand the following messages sent to them. Many of them take	675	Either sends the given message, or call the given callback, after the
672	arguments called C<@reply>, which will simply be used to compose a reply	676	specified number of seconds.
673	message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
674	the remaining arguments are simply the message data.
675		677
676	While other messages exist, they are not public and subject to change.	678	This is simply a utility function that come sin handy at times.
677		679
678	=over 4
679
680	=cut	680	=cut
681		681
682	=item lookup => $name, @reply	682	sub after($@) {
		683	my ($timeout, @action) = @_;
683		684
684	Replies with the port ID of the specified well-known port, or C<undef>.	685	my $t; $t = AE::timer $timeout, 0, sub {
685		686	undef $t;
686	=item devnull => ...	687	ref $action[0]
687		688	? $action[0]()
688	Generic data sink/CPU heat conversion.	689	: snd @action;
689		690	};
690	=item relay => $port, @msg	691	}
691
692	Simply forwards the message to the given port.
693
694	=item eval => $string[ @reply]
695
696	Evaluates the given string. If C<@reply> is given, then a message of the
697	form C<@reply, $@, @evalres> is sent.
698
699	Example: crash another node.
700
701	snd $othernode, eval => "exit";
702
703	=item time => @reply
704
705	Replies the the current node time to C<@reply>.
706
707	Example: tell the current node to send the current time to C<$myport> in a
708	C<timereply> message.
709
710	snd $NODE, time => $myport, timereply => 1, 2;
711	# => snd $myport, timereply => 1, 2, <time>
712		692
713	=back	693	=back
714		694
715	=head1 AnyEvent::MP vs. Distributed Erlang	695	=head1 AnyEvent::MP vs. Distributed Erlang
716		696
…		…
735	convenience functionality.	715	convenience functionality.
736		716
737	This means that AEMP requires a less tightly controlled environment at the	717	This means that AEMP requires a less tightly controlled environment at the
738	cost of longer node references and a slightly higher management overhead.	718	cost of longer node references and a slightly higher management overhead.
739		719
740	=item Erlang has a "remote ports are like local ports" philosophy, AEMP	720	=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
741	uses "local ports are like remote ports".	721	uses "local ports are like remote ports".
742		722
743	The failure modes for local ports are quite different (runtime errors	723	The failure modes for local ports are quite different (runtime errors
744	only) then for remote ports - when a local port dies, you I<know> it dies,	724	only) then for remote ports - when a local port dies, you I<know> it dies,
745	when a connection to another node dies, you know nothing about the other	725	when a connection to another node dies, you know nothing about the other

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.53 by root, Fri Aug 14 15:31:21 2009 UTC vs. Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.53 by root, Fri Aug 14 15:31:21 2009 UTC vs.
Revision 1.63 by root, Thu Aug 27 21:29:37 2009 UTC