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

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.18 by root, Mon Aug 3 21:35:03 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 mon del _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 mon $portid, sub { }	150	=item kil $portid[, @reason]
124		151
125	#TODO monitor the given port	152	Kill the specified port with the given C<@reason>.
		153
		154	If no C<@reason> is specified, then the port is killed "normally" (linked
		155	ports will not be kileld, or even notified).
		156
		157	Otherwise, linked ports get killed with the same reason (second form of
		158	C<mon>, see below).
		159
		160	Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
		161	will be reported as reason C<< die => $@ >>.
		162
		163	Transport/communication errors are reported as C<< transport_error =>
		164	$message >>.
		165
		166	=item $guard = mon $portid, $cb->(@reason)
		167
		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";
126		196
127	=cut	197	=cut
128		198
129	sub mon {	199	sub mon {
130	my ($noderef, $port) = split /#/, shift, 2;	200	my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift);
131		201
132	my $node = AnyEvent::MP::Base::add_node $noderef;	202	my $node = $NODE{$noderef} \|\| add_node $noderef;
133		203
134	my $cb = shift;	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 @_ };
		214	}
		215	}
135		216
136	$node->monitor ($port, $cb);	217	$node->monitor ($port, $cb);
137		218
138	defined wantarray	219	defined wantarray
139	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }	220	and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
140	}	221	}
141		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;
		236	});
		237	});
		238
		239	=cut
		240
		241	sub mon_guard {
		242	my ($port, @refs) = @_;
		243
		244	mon $port, sub { 0 && @refs }
		245	}
		246
142	=item $local_port = create_port	247	=item $local_port = port
143		248
144	Create a new local port object. See the next section for allowed methods.	249	Create a new local port object that supports message matching.
145		250
146	=cut
147
148	sub create_port {
149	my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++;
150
151	my $self = bless {
152	id => "$NODE#$id",
153	names => [$id],
154	}, "AnyEvent::MP::Port";
155
156	$AnyEvent::MP::Base::PORT{$id} = sub {
157	unshift @_, $self;
158
159	for (@{ $self->{rc0}{$_[1]} }) {
160	$_ && &{$_->[0]}
161	&& undef $_;
162	}
163
164	for (@{ $self->{rcv}{$_[1]} }) {
165	$_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
166	&& &{$_->[0]}
167	&& undef $_;
168	}
169
170	for (@{ $self->{any} }) {
171	$_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
172	&& &{$_->[0]}
173	&& undef $_;
174	}
175	};
176
177	$self
178	}
179
180	=item $portid = miniport { my @msg = @_; $finished }	251	=item $portid = port { my @msg = @_; $finished }
181		252
182	Creates a "mini port", that is, a very lightweight port without any	253	Creates a "mini port", that is, a very lightweight port without any
183	pattern matching behind it, and returns its ID.	254	pattern matching behind it, and returns its ID.
184		255
185	The block will be called for every message received on the port. When the	256	The block will be called for every message received on the port. When the
…		…
195	snd $otherport, reply => $port;	266	snd $otherport, reply => $port;
196	};	267	};
197		268
198	=cut	269	=cut
199		270
200	sub miniport(&) {	271	sub port(;&) {
		272	my $id = "$UNIQ." . $ID++;
		273	my $port = "$NODE#$id";
		274
		275	if (@_) {
201	my $cb = shift;	276	my $cb = shift;
202	my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++;	277	$PORT{$id} = sub {
203		278	local $SELF = $port;
204	$AnyEvent::MP::Base::PORT{$id} = sub {	279	eval {
205	&$cb	280	&$cb
206	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	};
207	};	314	}
208		315
209	"$NODE#$id"	316	$port
210	}	317	}
211		318
212	package AnyEvent::MP::Port;	319	=item reg $portid, $name
213		320
214	=back	321	Registers the given port under the name C<$name>. If the name already
		322	exists it is replaced.
215		323
216	=head1 METHODS FOR PORT OBJECTS	324	A port can only be registered under one well known name.
217		325
218	=over 4	326	A port automatically becomes unregistered when it is killed.
219		327
220	=item "$port"
221
222	A port object stringifies to its port ID, so can be used directly for
223	C<snd> operations.
224
225	=cut	328	=cut
226		329
227	use overload	330	sub reg(@) {
228	'""' => sub { $_[0]{id} },	331	my ($portid, $name) = @_;
229	fallback => 1;
230		332
231	sub TO_JSON { $_[0]{id} }	333	$REG{$name} = $portid;
		334	}
232		335
233	=item $port->rcv (type => $callback->($port, @msg))	336	=item rcv $portid, tagstring => $callback->(@msg), ...
234		337
235	=item $port->rcv ($smartmatch => $callback->($port, @msg))	338	=item rcv $portid, $smartmatch => $callback->(@msg), ...
236		339
237	=item $port->rcv ([$smartmatch...] => $callback->($port, @msg))	340	=item rcv $portid, [$smartmatch...] => $callback->(@msg), ...
238		341
239	Register a callback on the given port.	342	Register callbacks to be called on matching messages on the given port.
240		343
241	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
242	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
243	registered.	346	registered.
244		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
245	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
246	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
247	matched.	356	matched.
248		357
249	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
…		…
254	also the most efficient match (by far).	363	also the most efficient match (by far).
255		364
256	=cut	365	=cut
257		366
258	sub rcv($@) {	367	sub rcv($@) {
259	my ($self, $match, $cb) = @_;	368	my ($noderef, $port) = split /#/, shift, 2;
260		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
261	if (!ref $match) {	382	if (!ref $match) {
262	push @{ $self->{rc0}{$match} }, [$cb];	383	push @{ $self->{rc0}{$match} }, [$cb];
263	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {	384	} elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
264	my ($type, @match) = @$match;	385	my ($type, @match) = @$match;
265	@match	386	@match
266	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]	387	? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
267	: push @{ $self->{rc0}{$match->[0]} }, [$cb];	388	: push @{ $self->{rc0}{$match->[0]} }, [$cb];
268	} else {	389	} else {
269	push @{ $self->{any} }, [$cb, $match];	390	push @{ $self->{any} }, [$cb, $match];
		391	}
270	}	392	}
271	}	393	}
272		394
273	=item $port->register ($name)	395	=item $closure = psub { BLOCK }
274		396
275	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
276	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.
277		400
278	A port can only be registered under one well known name.	401	This is useful when you register callbacks from C<rcv> callbacks:
279		402
280	=cut	403	rcv delayed_reply => sub {
		404	my ($delay, @reply) = @_;
		405	my $timer = AE::timer $delay, 0, psub {
		406	snd @reply, $SELF;
		407	};
		408	};
281		409
282	sub register {
283	my ($self, $name) = @_;
284
285	$self->{wkname} = $name;
286	$AnyEvent::MP::Base::WKP{$name} = "$self";
287	}
288
289	=item $port->destroy
290
291	Explicitly destroy/remove/nuke/vaporise the port.
292
293	Ports are normally kept alive by there mere existance alone, and need to
294	be destroyed explicitly.
295
296	=cut	410	=cut
297		411
298	sub destroy {	412	sub psub(&) {
299	my ($self) = @_;	413	my $cb = shift;
300		414
301	AnyEvent::MP::Base::del $self->{id};	415	my $port = $SELF
		416	or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
302		417
303	delete $AnyEvent::MP::Base::WKP{ $self->{wkname} };	418	sub {
		419	local $SELF = $port;
304		420
305	delete $AnyEvent::MP::Base::PORT{$_}	421	if (wantarray) {
306	for @{ $self->{names} };	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	}
307	}	431	}
308		432
309	=back	433	=back
310		434
311	=head1 FUNCTIONS FOR NODES	435	=head1 FUNCTIONS FOR NODES
312		436
313	=over 4	437	=over 4
314
315	=item mon $noderef, $callback->($noderef, $status, $)
316
317	Monitors the given noderef.
318		438
319	=item become_public endpoint...	439	=item become_public endpoint...
320		440
321	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.
322		442
…		…
342		462
343	=over 4	463	=over 4
344		464
345	=cut	465	=cut
346		466
347	=item wkp => $name, @reply	467	=item lookup => $name, @reply
348		468
349	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>.
350		470
351	=item devnull => ...	471	=item devnull => ...
352		472

Diff Legend

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

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.18 by root, Mon Aug 3 21:35:03 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.18 by root, Mon Aug 3 21:35:03 2009 UTC vs.
Revision 1.22 by root, Tue Aug 4 18:33:30 2009 UTC