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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.10 by root, Sun Aug 2 18:05:43 2009 UTC vs.
Revision 1.23 by root, Tue Aug 4 18:46:16 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
12	snd $port, type => data...;	13	snd $port, type => data...;
		14
		15	$SELF # receiving/own port id in rcv callbacks
13		16
14	rcv $port, smartmatch => $cb->($port, @msg);	17	rcv $port, smartmatch => $cb->($port, @msg);
15		18
16	# examples:	19	# examples:
17	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };	20	rcv $port2, ping => sub { snd $_[0], "pong"; 0 };
…		…
27	This module (-family) implements a simple message passing framework.	30	This module (-family) implements a simple message passing framework.
28		31
29	Despite its simplicity, you can securely message other processes running	32	Despite its simplicity, you can securely message other processes running
30	on the same or other hosts.	33	on the same or other hosts.
31		34
		35	For an introduction to this module family, see the L<AnyEvent::MP::Intro>
		36	manual page.
		37
32	At the moment, this module family is severly brokena nd underdocumented,	38	At the moment, this module family is severly broken and underdocumented,
33	so do not use. This was uploaded mainly to resreve the CPAN namespace -	39	so do not use. This was uploaded mainly to reserve the CPAN namespace -
34	stay tuned!	40	stay tuned! The basic API should be finished, however.
35		41
36	=head1 CONCEPTS	42	=head1 CONCEPTS
37		43
38	=over 4	44	=over 4
39		45
…		…
84		90
85	use base "Exporter";	91	use base "Exporter";
86		92
87	our $VERSION = '0.02';	93	our $VERSION = '0.02';
88	our @EXPORT = qw(	94	our @EXPORT = qw(
89	NODE $NODE $PORT snd rcv _any_	95	NODE $NODE *SELF node_of _any_
90	create_port create_port_on
91	become_slave become_public	96	become_slave become_public
		97	snd rcv mon kil reg psub
		98	port
92	);	99	);
93		100
		101	our $SELF;
		102
		103	sub _self_die() {
		104	my $msg = $@;
		105	$msg =~ s/\n+$// unless ref $msg;
		106	kil $SELF, die => $msg;
		107	}
		108
94	=item NODE / $NODE	109	=item $thisnode = NODE / $NODE
95		110
96	The C<NODE ()> function and the C<$NODE> variable contain the noderef of	111	The C<NODE> function returns, and the C<$NODE> variable contains
97	the local node. The value is initialised by a call to C<become_public> or	112	the noderef of the local node. The value is initialised by a call
98	C<become_slave>, after which all local port identifiers become invalid.	113	to C<become_public> or C<become_slave>, after which all local port
		114	identifiers become invalid.
		115
		116	=item $noderef = node_of $portid
		117
		118	Extracts and returns the noderef from a portid or a noderef.
		119
		120	=item $SELF
		121
		122	Contains the current port id while executing C<rcv> callbacks or C<psub>
		123	blocks.
		124
		125	=item SELF, %SELF, @SELF...
		126
		127	Due to some quirks in how perl exports variables, it is impossible to
		128	just export C<$SELF>, all the symbols called C<SELF> are exported by this
		129	module, but only C<$SELF> is currently used.
99		130
100	=item snd $portid, type => @data	131	=item snd $portid, type => @data
101		132
102	=item snd $portid, @msg	133	=item snd $portid, @msg
103		134
…		…
117	JSON is used, then only strings, numbers and arrays and hashes consisting	148	JSON is used, then only strings, numbers and arrays and hashes consisting
118	of those are allowed (no objects). When Storable is used, then anything	149	of those are allowed (no objects). When Storable is used, then anything
119	that Storable can serialise and deserialise is allowed, and for the local	150	that Storable can serialise and deserialise is allowed, and for the local
120	node, anything can be passed.	151	node, anything can be passed.
121		152
122	=item $local_port = create_port	153	=item kil $portid[, @reason]
123		154
124	Create a new local port object. See the next section for allowed methods.	155	Kill the specified port with the given C<@reason>.
125		156
126	=cut	157	If no C<@reason> is specified, then the port is killed "normally" (linked
		158	ports will not be kileld, or even notified).
127		159
128	sub create_port {	160	Otherwise, linked ports get killed with the same reason (second form of
129	my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID;	161	C<mon>, see below).
130		162
131	my $self = bless {	163	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
132	id => "$NODE#$id",	164	will be reported as reason C<< die => $@ >>.
133	names => [$id],
134	}, "AnyEvent::MP::Port";
135		165
136	$AnyEvent::MP::Base::PORT{$id} = sub {	166	Transport/communication errors are reported as C<< transport_error =>
137	unshift @_, $self;	167	$message >>.
138		168
139	for (@{ $self->{rc0}{$_[1]} }) {	169	=item $guard = mon $portid, $cb->(@reason)
140	$_ && &{$_->[0]}	170
141	&& undef $_;	171	=item $guard = mon $portid, $otherport
		172
		173	=item $guard = mon $portid, $otherport, @msg
		174
		175	Monitor the given port and do something when the port is killed.
		176
		177	In the first form, the callback is simply called with any number
		178	of C<@reason> elements (no @reason means that the port was deleted
		179	"normally"). Note also that I<< the callback B<must> never die >>, so use
		180	C<eval> if unsure.
		181
		182	In the second form, the other port will be C<kil>'ed with C<@reason>, iff
		183	a @reason was specified, i.e. on "normal" kils nothing happens, while
		184	under all other conditions, the other port is killed with the same reason.
		185
		186	In the last form, a message of the form C<@msg, @reason> will be C<snd>.
		187
		188	Example: call a given callback when C<$port> is killed.
		189
		190	mon $port, sub { warn "port died because of <@_>\n" };
		191
		192	Example: kill ourselves when C<$port> is killed abnormally.
		193
		194	mon $port, $self;
		195
		196	Example: send us a restart message another C<$port> is killed.
		197
		198	mon $port, $self => "restart";
		199
		200	=cut
		201
		202	sub mon {
		203	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);
		204
		205	my $node = $NODE{$noderef} \|\| add_node $noderef;
		206
		207	#TODO: ports must not be references
		208	if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) {
		209	if (@_) {
		210	# send a kill info message
		211	my (@msg) = ($cb, @_);
		212	$cb = sub { snd @msg, @_ };
		213	} else {
		214	# simply kill other port
		215	my $port = $cb;
		216	$cb = sub { kil $port, @_ if @_ };
142	}	217	}
		218	}
143		219
144	for (@{ $self->{rcv}{$_[1]} }) {	220	$node->monitor ($port, $cb);
145	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]	221
146	&& &{$_->[0]}	222	defined wantarray
147	&& undef $_;	223	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
		224	}
		225
		226	=item $guard = mon_guard $port, $ref, $ref...
		227
		228	Monitors the given C<$port> and keeps the passed references. When the port
		229	is killed, the references will be freed.
		230
		231	Optionally returns a guard that will stop the monitoring.
		232
		233	This function is useful when you create e.g. timers or other watchers and
		234	want to free them when the port gets killed:
		235
		236	$port->rcv (start => sub {
		237	my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {
		238	undef $timer if 0.9 < rand;
148	}	239	});
		240	});
149		241
150	for (@{ $self->{any} }) {	242	=cut
151	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]	243
152	&& &{$_->[0]}	244	sub mon_guard {
153	&& undef $_;	245	my ($port, @refs) = @_;
154	}	246
		247	mon $port, sub { 0 && @refs }
		248	}
		249
		250	=item $local_port = port
		251
		252	Create a new local port object that supports message matching.
		253
		254	=item $portid = port { my @msg = @_; $finished }
		255
		256	Creates a "mini port", that is, a very lightweight port without any
		257	pattern matching behind it, and returns its ID.
		258
		259	The block will be called for every message received on the port. When the
		260	callback returns a true value its job is considered "done" and the port
		261	will be destroyed. Otherwise it will stay alive.
		262
		263	The message will be passed as-is, no extra argument (i.e. no port id) will
		264	be passed to the callback.
		265
		266	If you need the local port id in the callback, this works nicely:
		267
		268	my $port; $port = miniport {
		269	snd $otherport, reply => $port;
155	};	270	};
156		271
157	$self
158	}
159
160	=item $portid = create_miniport { }
161
162	Creates a "mini port", that is, a port without much #TODO
163
164	=cut	272	=cut
165		273
166	sub create_miniport(&) {	274	sub port(;&) {
		275	my $id = "$UNIQ." . $ID++;
		276	my $port = "$NODE#$id";
		277
		278	if (@_) {
167	my $cb = shift;	279	my $cb = shift;
168	my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID;	280	$PORT{$id} = sub {
169		281	local $SELF = $port;
170	$AnyEvent::MP::Base::PORT{$id} = sub {	282	eval {
171	&$cb	283	&$cb
172	and delete $AnyEvent::MP::Base::PORT{$id};	284	and kil $id;
		285	};
		286	_self_die if $@;
		287	};
		288	} else {
		289	my $self = bless {
		290	id => "$NODE#$id",
		291	}, "AnyEvent::MP::Port";
		292
		293	$PORT_DATA{$id} = $self;
		294	$PORT{$id} = sub {
		295	local $SELF = $port;
		296
		297	eval {
		298	for (@{ $self->{rc0}{$_[0]} }) {
		299	$_ && &{$_->[0]}
		300	&& undef $_;
		301	}
		302
		303	for (@{ $self->{rcv}{$_[0]} }) {
		304	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
		305	&& &{$_->[0]}
		306	&& undef $_;
		307	}
		308
		309	for (@{ $self->{any} }) {
		310	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
		311	&& &{$_->[0]}
		312	&& undef $_;
		313	}
		314	};
		315	_self_die if $@;
		316	};
173	};	317	}
174		318
175	"$NODE#$id"	319	$port
176	}	320	}
177		321
178	package AnyEvent::MP::Port;	322	=item reg $portid, $name
179		323
180	=back	324	Registers the given port under the name C<$name>. If the name already
		325	exists it is replaced.
181		326
182	=head1 METHODS FOR PORT OBJECTS	327	A port can only be registered under one well known name.
183		328
184	=over 4	329	A port automatically becomes unregistered when it is killed.
185		330
186	=item "$port"
187
188	A port object stringifies to its port ID, so can be used directly for
189	C<snd> operations.
190
191	=cut	331	=cut
192		332
193	use overload	333	sub reg(@) {
194	'""' => sub { $_[0]{id} },	334	my ($portid, $name) = @_;
195	fallback => 1;
196		335
197	=item $port->rcv (type => $callback->($port, @msg))	336	$REG{$name} = $portid;
		337	}
198		338
199	=item $port->rcv ($smartmatch => $callback->($port, @msg))	339	=item rcv $portid, tagstring => $callback->(@msg), ...
200		340
		341	=item rcv $portid, $smartmatch => $callback->(@msg), ...
		342
201	=item $port->rcv ([$smartmatch...] => $callback->($port, @msg))	343	=item rcv $portid, [$smartmatch...] => $callback->(@msg), ...
202		344
203	Register a callback on the given port.	345	Register callbacks to be called on matching messages on the given port.
204		346
205	The callback has to return a true value when its work is done, after	347	The callback has to return a true value when its work is done, after
206	which is will be removed, or a false value in which case it will stay	348	which is will be removed, or a false value in which case it will stay
207	registered.	349	registered.
208		350
		351	The global C<$SELF> (exported by this module) contains C<$portid> while
		352	executing the callback.
		353
		354	Runtime errors wdurign callback execution will result in the port being
		355	C<kil>ed.
		356
209	If the match is an array reference, then it will be matched against the	357	If the match is an array reference, then it will be matched against the
210	first elements of the message, otherwise only the first element is being	358	first elements of the message, otherwise only the first element is being
211	matched.	359	matched.
212		360
213	Any element in the match that is specified as C<_any_> (a function	361	Any element in the match that is specified as C<_any_> (a function
…		…
218	also the most efficient match (by far).	366	also the most efficient match (by far).
219		367
220	=cut	368	=cut
221		369
222	sub rcv($@) {	370	sub rcv($@) {
223	my ($self, $match, $cb) = @_;	371	my ($noderef, $port) = split /#/, shift, 2;
224		372
		373	($NODE{$noderef} \|\| add_node $noderef) == $NODE{""}
		374	or Carp::croak "$noderef#$port: rcv can only be called on local ports, caught";
		375
		376	my $self = $PORT_DATA{$port}
		377	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
		378
		379	"AnyEvent::MP::Port" eq ref $self
		380	or Carp::croak "$noderef#$port: rcv can only be called on message matching ports, caught";
		381
		382	while (@_) {
		383	my ($match, $cb) = splice @_, 0, 2;
		384
225	if (!ref $match) {	385	if (!ref $match) {
226	push @{ $self->{rc0}{$match} }, [$cb];	386	push @{ $self->{rc0}{$match} }, [$cb];
227	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {	387	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
228	my ($type, @match) = @$match;	388	my ($type, @match) = @$match;
229	@match	389	@match
230	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]	390	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
231	: push @{ $self->{rc0}{$match->[0]} }, [$cb];	391	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
232	} else {	392	} else {
233	push @{ $self->{any} }, [$cb, $match];	393	push @{ $self->{any} }, [$cb, $match];
		394	}
234	}	395	}
235	}	396	}
236		397
237	=item $port->register ($name)	398	=item $closure = psub { BLOCK }
238		399
239	Registers the given port under the well known name C<$name>. If the name	400	Remembers C<$SELF> and creates a closure out of the BLOCK. When the
240	already exists it is replaced.	401	closure is executed, sets up the environment in the same way as in C<rcv>
		402	callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
241		403
242	A port can only be registered under one well known name.	404	This is useful when you register callbacks from C<rcv> callbacks:
243		405
244	=cut	406	rcv delayed_reply => sub {
		407	my ($delay, @reply) = @_;
		408	my $timer = AE::timer $delay, 0, psub {
		409	snd @reply, $SELF;
		410	};
		411	};
245		412
246	sub register {
247	my ($self, $name) = @_;
248
249	$self->{wkname} = $name;
250	$AnyEvent::MP::Base::WKP{$name} = "$self";
251	}
252
253	=item $port->destroy
254
255	Explicitly destroy/remove/nuke/vaporise the port.
256
257	Ports are normally kept alive by there mere existance alone, and need to
258	be destroyed explicitly.
259
260	=cut	413	=cut
261		414
262	sub destroy {	415	sub psub(&) {
263	my ($self) = @_;	416	my $cb = shift;
264		417
265	delete $AnyEvent::MP::Base::WKP{ $self->{wkname} };	418	my $port = $SELF
		419	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
266		420
267	delete $AnyEvent::MP::Base::PORT{$_}	421	sub {
268	for @{ $self->{names} };	422	local $SELF = $port;
		423
		424	if (wantarray) {
		425	my @res = eval { &$cb };
		426	_self_die if $@;
		427	@res
		428	} else {
		429	my $res = eval { &$cb };
		430	_self_die if $@;
		431	$res
		432	}
		433	}
269	}	434	}
270		435
271	=back	436	=back
272		437
273	=head1 FUNCTIONS FOR NODES	438	=head1 FUNCTIONS FOR NODES
274		439
275	=over 4	440	=over 4
276
277	=item mon $noderef, $callback->($noderef, $status, $)
278
279	Monitors the given noderef.
280		441
281	=item become_public endpoint...	442	=item become_public endpoint...
282		443
283	Tells the node to become a public node, i.e. reachable from other nodes.	444	Tells the node to become a public node, i.e. reachable from other nodes.
284		445
…		…
304		465
305	=over 4	466	=over 4
306		467
307	=cut	468	=cut
308		469
309	=item wkp => $name, @reply	470	=item lookup => $name, @reply
310		471
311	Replies with the port ID of the specified well-known port, or C<undef>.	472	Replies with the port ID of the specified well-known port, or C<undef>.
312		473
313	=item devnull => ...	474	=item devnull => ...
314		475

Diff Legend

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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents): Revision 1.10 by root, Sun Aug 2 18:05:43 2009 UTC vs. Revision 1.23 by root, Tue Aug 4 18:46:16 2009 UTC

Diff Legend

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.10 by root, Sun Aug 2 18:05:43 2009 UTC vs.
Revision 1.23 by root, Tue Aug 4 18:46:16 2009 UTC