ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-MP/MP.pm
(Generate patch)

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.84 by root, Tue Sep 8 01:42:14 2009 UTC vs.
Revision 1.95 by root, Wed Sep 23 11:57:16 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::MP - multi-processing/message-passing framework 3AnyEvent::MP - erlang-style multi-processing/message-passing framework
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
… …
31 31
32 # create a port on another node 32 # create a port on another node
33 my $port = spawn $node, $initfunc, @initdata; 33 my $port = spawn $node, $initfunc, @initdata;
34 34
35 # monitoring 35 # monitoring
36 mon $port, $cb->(@msg) # callback is invoked on death 36 mon $localport, $cb->(@msg) # callback is invoked on death
37 mon $port, $otherport # kill otherport on abnormal death 37 mon $localport, $otherport # kill otherport on abnormal death
38 mon $port, $otherport, @msg # send message on death 38 mon $localport, $otherport, @msg # send message on death
39 39
40=head1 CURRENT STATUS 40=head1 CURRENT STATUS
41 41
42 bin/aemp - stable. 42 bin/aemp - stable.
43 AnyEvent::MP - stable API, should work. 43 AnyEvent::MP - stable API, should work.
44 AnyEvent::MP::Intro - explains most concepts. 44 AnyEvent::MP::Intro - explains most concepts.
45 AnyEvent::MP::Kernel - mostly stable. 45 AnyEvent::MP::Kernel - mostly stable API.
46 AnyEvent::MP::Global - stable but incomplete, protocol not yet final. 46 AnyEvent::MP::Global - stable API.
47
48stay tuned.
49 47
50=head1 DESCRIPTION 48=head1 DESCRIPTION
51 49
52This module (-family) implements a simple message passing framework. 50This module (-family) implements a simple message passing framework.
53 51
… …
109to have fixed listening addresses, seed nodes are perfectly normal nodes - 107to have fixed listening addresses, seed nodes are perfectly normal nodes -
110any node can function as a seed node for others. 108any node can function as a seed node for others.
111 109
112In addition to discovering the network, seed nodes are also used to 110In addition to discovering the network, seed nodes are also used to
113maintain the network and to connect nodes that otherwise would have 111maintain the network and to connect nodes that otherwise would have
114trouble connecting. They form the backbone of the AnyEvent::MP network. 112trouble connecting. They form the backbone of an AnyEvent::MP network.
115 113
116Seed nodes are expected to be long-running, and at least one seed node 114Seed nodes are expected to be long-running, and at least one seed node
117should always be available. 115should always be available. They should also be relatively responsive - a
116seed node that blocks for long periods will slow down everybody else.
118 117
119=item seeds - C<host:port> 118=item seeds - C<host:port>
120 119
121Seeds are transport endpoint(s) (usually a hostname/IP address and a 120Seeds are transport endpoint(s) (usually a hostname/IP address and a
122TCP port) of nodes thta should be used as seed nodes. 121TCP port) of nodes thta should be used as seed nodes.
… …
149our $VERSION = $AnyEvent::MP::Kernel::VERSION; 148our $VERSION = $AnyEvent::MP::Kernel::VERSION;
150 149
151our @EXPORT = qw( 150our @EXPORT = qw(
152 NODE $NODE *SELF node_of after 151 NODE $NODE *SELF node_of after
153 configure 152 configure
154 snd rcv mon mon_guard kil reg psub spawn 153 snd rcv mon mon_guard kil psub spawn cal
155 port 154 port
156); 155);
157 156
158our $SELF; 157our $SELF;
159 158
… …
228L<AnyEvent::MP::Global> module, which will then use it to keep 227L<AnyEvent::MP::Global> module, which will then use it to keep
229connectivity with at least one node at any point in time. 228connectivity with at least one node at any point in time.
230 229
231=back 230=back
232 231
233Example: become a distributed node using the locla node name as profile. 232Example: become a distributed node using the local node name as profile.
234This should be the most common form of invocation for "daemon"-type nodes. 233This should be the most common form of invocation for "daemon"-type nodes.
235 234
236 configure 235 configure
237 236
238Example: become an anonymous node. This form is often used for commandline 237Example: become an anonymous node. This form is often used for commandline
… …
566 } 565 }
567 566
568 $node->monitor ($port, $cb); 567 $node->monitor ($port, $cb);
569 568
570 defined wantarray 569 defined wantarray
571 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } 570 and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
572} 571}
573 572
574=item $guard = mon_guard $port, $ref, $ref... 573=item $guard = mon_guard $port, $ref, $ref...
575 574
576Monitors the given C<$port> and keeps the passed references. When the port 575Monitors the given C<$port> and keeps the passed references. When the port
… …
714 ? $action[0]() 713 ? $action[0]()
715 : snd @action; 714 : snd @action;
716 }; 715 };
717} 716}
718 717
718=item cal $port, @msg, $callback[, $timeout]
719
720A simple form of RPC - sends a message to the given C<$port> with the
721given contents (C<@msg>), but adds a reply port to the message.
722
723The reply port is created temporarily just for the purpose of receiving
724the reply, and will be C<kil>ed when no longer needed.
725
726A reply message sent to the port is passed to the C<$callback> as-is.
727
728If an optional time-out (in seconds) is given and it is not C<undef>,
729then the callback will be called without any arguments after the time-out
730elapsed and the port is C<kil>ed.
731
732If no time-out is given, then the local port will monitor the remote port
733instead, so it eventually gets cleaned-up.
734
735Currently this function returns the temporary port, but this "feature"
736might go in future versions unless you can make a convincing case that
737this is indeed useful for something.
738
739=cut
740
741sub cal(@) {
742 my $timeout = ref $_[-1] ? undef : pop;
743 my $cb = pop;
744
745 my $port = port {
746 undef $timeout;
747 kil $SELF;
748 &$cb;
749 };
750
751 if (defined $timeout) {
752 $timeout = AE::timer $timeout, 0, sub {
753 undef $timeout;
754 kil $port;
755 $cb->();
756 };
757 } else {
758 mon $_[0], sub {
759 kil $port;
760 $cb->();
761 };
762 }
763
764 push @_, $port;
765 &snd;
766
767 $port
768}
769
719=back 770=back
720 771
721=head1 AnyEvent::MP vs. Distributed Erlang 772=head1 AnyEvent::MP vs. Distributed Erlang
722 773
723AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node 774AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
724== aemp node, Erlang process == aemp port), so many of the documents and 775== aemp node, Erlang process == aemp port), so many of the documents and
725programming techniques employed by Erlang apply to AnyEvent::MP. Here is a 776programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
726sample: 777sample:
727 778
728 http://www.Erlang.se/doc/programming_rules.shtml 779 http://www.erlang.se/doc/programming_rules.shtml
729 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 780 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
730 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6 781 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
731 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 782 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
732 783
733Despite the similarities, there are also some important differences: 784Despite the similarities, there are also some important differences:
734 785
735=over 4 786=over 4
736 787

Diff Legend

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