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

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

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.11 by root, Sun Aug 2 18:08:38 2009 UTC vs. Revision 1.22 by root, Tue Aug 4 18:33:30 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.11 by root, Sun Aug 2 18:08:38 2009 UTC vs.
Revision 1.22 by root, Tue Aug 4 18:33:30 2009 UTC