AnyEvent-MP/MP/Intro.pod

=head1 Message Passing for the Non-Blocked Mind

=head1 Introduction and Terminology

This is a tutorial about how to get the swing of the new L<AnyEvent::MP>
module, which allows programs to transparently pass messages within the
process and to other processes on the same or a different host.

What kind of messages? Basically a message here means a list of Perl
strings, numbers, hashes and arrays, anything that can be expressed as a
L<JSON> text (as JSON is used by default in the protocol). Here are two
examples:

    write_log => 1251555874, "action was successful.\n"
    123, ["a", "b", "c"], { foo => "bar" }

When using L<AnyEvent::MP> it is customary to use a descriptive string as
first element of a message, that indictes the type of the message. This
element is called a I<tag> in L<AnyEvent::MP>, as some API functions
(C<rcv>) support matching it directly.

Supposedly you want to send a ping message with your current time to
somewhere, this is how such a message might look like (in Perl syntax):

   ping => 1251381636

Now that we know what a message is, to which entities are those
messages being I<passed>? They are I<passed> to I<ports>. A I<port> is
a destination for messages but also a context to execute code: when
a runtime error occurs while executing code belonging to a port, the
exception will be raised on the port and can even travel to interested
parties on other nodes, which makes supervision of distributed processes
easy.

How do these ports relate to things you know? Each I<port> belongs
to a I<node>, and a I<node> is just the UNIX process that runs your
L<AnyEvent::MP> application.

Each I<node> is distinguished from other I<nodes> running on the same or
another host in a network by its I<node ID>. A I<node ID> is simply a
unique string chosen manually or assigned by L<AnyEvent::MP> in some way
(UNIX nodename, random string...).

Here is a diagram about how I<nodes>, I<ports> and UNIX processes relate
to each other. The setup consists of two nodes (more are of course
possible): Node C<A> (in UNIX process 7066) with the ports C<ABC> and
C<DEF>. And the node C<B> (in UNIX process 8321) with the ports C<FOO> and
C<BAR>.


  |- PID: 7066 -|                  |- PID: 8321 -|
  |             |                  |             |
  | Node ID: A  |                  | Node ID: B  |
  |             |                  |             |
  |   Port ABC =|= <----\ /-----> =|= Port FOO   |
  |             |        X         |             |
  |   Port DEF =|= <----/ \-----> =|= Port BAR   |
  |             |                  |             |
  |-------------|                  |-------------|

The strings for the I<port IDs> here are just for illustrative
purposes: Even though I<ports> in L<AnyEvent::MP> are also identified by
strings, they can't be choosen manually and are assigned by the system
dynamically. These I<port IDs> are unique within a network and can also be
used to identify senders or as message tags for instance.

The next sections will explain the API of L<AnyEvent::MP> by going through
a few simple examples. Later some more complex idioms are introduced,
which are hopefully useful to solve some real world problems.

=head1 Passing Your First Message

As a start lets have a look at the messaging API. The following example
is just a demo to show the basic elements of message passing with
L<AnyEvent::MP>.

The example should print: C<Ending with: 123>, in a rather complicated
way, by passing some message to a port.

   use AnyEvent;
   use AnyEvent::MP;

   my $end_cv = AnyEvent->condvar;

   my $port = port;

   rcv $port, test => sub {
      my ($data) = @_;
      $end_cv->send ($data);
   };

   snd $port, test => 123;

   print "Ending with: " . $end_cv->recv . "\n";

It already uses most of the essential functions inside
L<AnyEvent::MP>: First there is the C<port> function which will create a
I<port> and will return it's I<port ID>, a simple string.

This I<port ID> can be used to send messages to the port and install
handlers to receive messages on the port. Since it is a simple string
it can be safely passed to other I<nodes> in the network when you want
to refer to that specific port (usually used for RPC, where you need
to tell the other end which I<port> to send the reply to - messages in
L<AnyEvent::MP> have a destination, but no source).

The next function is C<rcv>:

   rcv $port, test => sub { ... };

It installs a receiver callback on the I<port> that specified as the first
argument (it only works for "local" ports, i.e. ports created on the same
node). The next argument, in this example C<test>, specifies a I<tag> to
match. This means that whenever a message with the first element being
the string C<test> is received, the callback is called with the remaining
parts of that message.

Messages can be sent with the C<snd> function, which is used like this in
the example above:

   snd $port, test => 123;

This will send the message C<'test', 123> to the I<port> with the I<port
ID> stored in C<$port>. Since in this case the receiver has a I<tag> match
on C<test> it will call the callback with the first argument being the
number C<123>.

The callback is a typicall AnyEvent idiom: the callback just passes
that number on to the I<condition variable> C<$end_cv> which will then
pass the value to the print. Condition variables are out of the scope
of this tutorial and not often used with ports, so please consult the
L<AnyEvent::Intro> about them.

Passing messages inside just one process is boring. Before we can move on
and do interprocess message passing we first have to make sure some things
have been set up correctly for our nodes to talk to each other.

=head1 System Requirements and System Setup

Before we can start with real IPC we have to make sure some things work on
your system.

First we have to setup a I<shared secret>: for two L<AnyEvent::MP>
I<nodes> to be able to communicate with each other over the network it is
necessary to setup the same I<shared secret> for both of them, so they can
prove their trustworthyness to each other.

The easiest way is to set this up is to use the F<aemp> utility:

   aemp gensecret

This creates a F<$HOME/.perl-anyevent-mp> config file and generates a
random shared secret. You can copy this file to any other system and
then communicate over the network (via TCP) with it. You can also select
your own shared secret (F<aemp setsecret>) and for increased security
requirements you can even create (or configure) a TLS certificate (F<aemp
gencert>), causing connections to not just be securely authenticated, but
also to be encrypted and protected against tinkering.

Connections will only be successfully established when the I<nodes>
that want to connect to each other have the same I<shared secret> (or
successfully verify the TLS certificate of the other side, in which case
no shared secret is required).

B<If something does not work as expected, and for example tcpdump shows
that the connections are closed almost immediately, you should make sure
that F<~/.perl-anyevent-mp> is the same on all hosts/user accounts that
you try to connect with each other!>

Thats is all for now, you will find some more advanced fiddling with the
C<aemp> utility later.


=head1 Passing Messages Between Processes

=head2 The Receiver

Lets split the previous example up into two programs: one that contains
the sender and one for the receiver. First the receiver application, in
full:

   use AnyEvent;
   use AnyEvent::MP;
   use AnyEvent::MP::Global;

   initialise_node "eg_simple_receiver";

   my $port = port;

   AnyEvent::MP::Global::register $port, "eg_receivers";

   rcv $port, test => sub {
      my ($data, $reply_port) = @_;

      print "Received data: " . $data . "\n";
   };

   AnyEvent->condvar->recv;

=head3 AnyEvent::MP::Global

Now, that wasn't too bad, was it? Ok, let's step through the new functions
and modules that have been used.

For starters, there is now an additional module being
used: L<AnyEvent::MP::Global>. This module provides us with a I<global
registry>, which lets us register ports in groups that are visible on all
I<nodes> in a network.

What is this useful for? Well, the I<port IDs> are random-looking strings,
assigned by L<AnyEvent::MP>. We cannot know those I<port IDs> in advance,
so we don't know which I<port ID> to send messages to, especially when the
message is to be passed between different I<nodes> (or UNIX processes). To
find the right I<port> of another I<node> in the network we will need
to communicate this somehow to the sender. And exactly that is what
L<AnyEvent::MP::Global> provides.

Especially in larger, more anonymous networks this is handy: imagine you
have a few database backends, a few web frontends and some processing
distributed over a number of hosts: all of these would simply register
themselves in the appropriate group, and your web frontends can start to
find some database backend.

=head3 C<initialise_node> And The Network

Now, let's have a look at the new function, C<initialise_node>:

   initialise_node "eg_simple_receiver";

Before we are able to send messages to other nodes we have to initialise
ourself to become a "distributed node". Initialising a node means naming
the node, optionally binding some TCP listeners so that other nodes can
contact it and connecting to a predefined set of seed addresses so the
node can discover the existing network - and the existing network can
discover the node!

The first argument, the string C<"eg_simple_receiver">, is the so-called
I<profile> to use: A profile holds some information about the application
that is going to be a node in an L<AnyEvent::MP> network. Customarily you
don't specify a profile name at all: in this case, AnyEvent::MP will use
the POSIX nodename.

The profile allows you to set the I<node ID> that your application will
use (the node ID defaults to the profile name if not specified). You can
also set I<binds> in the profile, meaning that you can define TCP ports
that the application will listen on for incoming connections from other
nodes of the network.

You should also configure I<seeds> in the profile: A I<seed> is just a
TCP address of some other node in the network. To explain this a bit
more detailed we have to look at the topology of an L<AnyEvent::MP>
network. The topology is called a I<fully connected mesh>, here an example
with 4 nodes:

   N1--N2
   | \/ |
   | /\ |
   N3--N4

Now imagine another I<node> C<N5>. wants to connect itself to that network:

   N1--N2
   | \/ |    N5
   | /\ |
   N3--N4

The new node needs to know the I<binds> of all nodes already
connected. Exactly this is what the I<seeds> are for: Let's assume that
the new node (C<N5>) uses the TCP address of the node C<N2> as seed.  This
cuases it to connect to C<N2>:

   N1--N2____
   | \/ |    N5
   | /\ |
   N3--N4

C<N2> then tells C<N5> about the I<binds> of the other nodes it is
connected to, and C<N5> creates the rest of the connections:

    /--------\
   N1--N2____|
   | \/ |    N5
   | /\ |   /|
   N3--N4--- |
    \________/

All done: C<N5> is now happily connected to the rest of the network.

=head3 Setting Up The Profiles

Ok, so much to the profile. Now let's setup the C<eg_simple_receiver>
I<profile> for later use. For the receiver we just give the receiver a
I<bind>:

   aemp profile eg_simple_receiver setbinds localhost:12266

We use C<localhost> in the example, but in the real world, you usually
want to use the "real" IP address of your node, so hosts can connect to
it. Of course, you can specify many binds, and it is also perfectly useful
to run multiple nodes on the same host. Just keep in mind that other nodes
will try to I<connect> to those addresses, and this better succeeds if you
want your network to be in good working conditions.

While we are at it, we setup the I<profile> for the sender in the
second part of this example, too. We will call the sender I<profile>
C<eg_simple_sender>. For the sender we set up a I<seed> pointing to the
receiver:

   aemp profile eg_simple_sender setseeds localhost:12266
   aemp profile eg_simple_sender setbinds

You might wonder why we setup I<binds> to be empty here: actually, the the
I<fully> in the I<fully connected mesh> is not the complete truth: If you
don't configure any I<binds> for a node profile it will parse and try to
resolve the node ID to find addresses to bind to. In this case we pretend
that we do not want this and epxlicitly specify an empty binds list, so
the node will not actually listen on any TCP ports.

Nodes without listeners will not be able to send messages to other nodes
without listeners, but they can still talk to all other nodes. For this
example, as well as in many cases in the real world, we can live with this
restriction, and this makes it easier to avoid DNS (assuming your setup is
broken, eliminating one potential problem :).

Whee, setting up nodes can be complicated at first, but you only have to
do it once per network, and you can leave this boring task to the admins
or end-users that want to use your stuff :)

=head3 Registering The Receiver

Coming back to our example, we have now introduced the basic purpose of
L<AnyEvent::MP::Global> and C<initialise_node> and its use of profiles. We
also set up our profiles for later use and now we will finally continue
talking about the receiver.

Let's look at the next line(s):

   my $port = port;
   AnyEvent::MP::Global::register $port, "eg_receivers";

The C<port> function has already been discussed. It simply creates a new
I<port> and returns the I<port ID>. The C<register> function, however,
is new:  The first argument is the I<port ID> that we want to add to a
I<global group>, and its second argument is the name of that I<global
group>.

You can choose the name of such a I<global group> freely (prefixing your
package name is highly recommended!). The purpose of such a group is to
store a set of I<port IDs>. This set is made available throughout the
whole L<AnyEvent::MP> network, so that each node can see which ports
belong to that group.

Later we will see how the sender looks for the ports in this I<global
group> to send messages to them.

The last step in the example is to set up a receiver callback for those
messages, just as was discussed in the first example. We again match
for the tag C<test>. The difference is that this time we don't exit the
application after receiving the first message. Instead we continue to wait
for new messages indefinitely.

=head2 The Sender

Ok, now let's take a look at the sender code:

   use AnyEvent;
   use AnyEvent::MP;
   use AnyEvent::MP::Global;

   initialise_node "eg_simple_sender";

   my $find_timer =
      AnyEvent->timer (after => 0, interval => 1, cb => sub {
         my $ports = AnyEvent::MP::Global::find "eg_receivers"
            or return;

         snd $_, test => time
            for @$ports;
      });

   AnyEvent->condvar->recv;

It's even less code. The C<initialise_node> serves the same purpose as in
the receiver, we just specify a different profile, the profile we set up
without the binds.

Next we set up a timer that repeatedly (every second) calls this chunk of
code:

   my $ports = AnyEvent::MP::Global::find "eg_receivers"
      or return;

   snd $_, test => time
      for @$ports;

The only new function here is the C<find> function of
L<AnyEvent::MP::Global>. It searches in the global group named
C<eg_receivers> for ports. If none are found, it returns C<undef>, which
makes our code return instantly and wait for the next round, as nobody is
interested in our message.

As soon as the receiver application has connected and the information
about the newly added port in the receiver has propagated to the sender
node, C<find> returns an array reference that contains the I<port ID> of
the receiver I<port(s)>.

We then just send a message with a tag and the current time to every
I<port> in the global group.

=head3 Multiple Receivers

You can even run multiple receivers - the only problem is that they will
use the same node ID. To avoid this problem, you can either not specify a
profile name at all and rely on DNS and your POSIX node name, or you can
use a special feature called "anonymous nodes":

   aemp profile eg_simple_receiver setnodeid anon/

The special name C<anon/> will be replaced by a random string each time
the node starts. This way you can start many receivers (they do not bind
on a TCP port, so cnanot collide with each other), and all of them will
receive the central time signal.

That's all for now - next time we will teach you about monitoring by
writing a simple chat client and server :)

=head1 SEE ALSO

L<AnyEvent>

L<AnyEvent::Handle>

L<AnyEvent::MP>

L<AnyEvent::MP::Global>

=head1 AUTHOR

  Robin Redeker <elmex@ta-sa.org>

Revision:	1.27
Committed:	Sat Aug 29 16:27:50 2009 UTC (14 years, 9 months ago) by root
Branch:	MAIN
CVS Tags:	rel-0_9
Changes since 1.26:	+62 -38 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.4	=head1 Message Passing for the Non-Blocked Mind
2	elmex	1.1
3	root	1.8	=head1 Introduction and Terminology
4	elmex	1.1
5	root	1.4	This is a tutorial about how to get the swing of the new L<AnyEvent::MP>
6	root	1.23	module, which allows programs to transparently pass messages within the
7			process and to other processes on the same or a different host.
8	elmex	1.1
9	root	1.23	What kind of messages? Basically a message here means a list of Perl
10	root	1.15	strings, numbers, hashes and arrays, anything that can be expressed as a
11	root	1.23	L<JSON> text (as JSON is used by default in the protocol). Here are two
12			examples:
13	elmex	1.1
14	root	1.23	write_log => 1251555874, "action was successful.\n"
15			123, ["a", "b", "c"], { foo => "bar" }
16	elmex	1.21
17	root	1.23	When using L<AnyEvent::MP> it is customary to use a descriptive string as
18			first element of a message, that indictes the type of the message. This
19			element is called a I<tag> in L<AnyEvent::MP>, as some API functions
20			(C<rcv>) support matching it directly.
21
22			Supposedly you want to send a ping message with your current time to
23			somewhere, this is how such a message might look like (in Perl syntax):
24
25			ping => 1251381636
26
27			Now that we know what a message is, to which entities are those
28			messages being I<passed>? They are I<passed> to I<ports>. A I<port> is
29			a destination for messages but also a context to execute code: when
30			a runtime error occurs while executing code belonging to a port, the
31			exception will be raised on the port and can even travel to interested
32			parties on other nodes, which makes supervision of distributed processes
33			easy.
34
35			How do these ports relate to things you know? Each I<port> belongs
36			to a I<node>, and a I<node> is just the UNIX process that runs your
37			L<AnyEvent::MP> application.
38
39			Each I<node> is distinguished from other I<nodes> running on the same or
40			another host in a network by its I<node ID>. A I<node ID> is simply a
41			unique string chosen manually or assigned by L<AnyEvent::MP> in some way
42			(UNIX nodename, random string...).
43
44			Here is a diagram about how I<nodes>, I<ports> and UNIX processes relate
45			to each other. The setup consists of two nodes (more are of course
46			possible): Node C<A> (in UNIX process 7066) with the ports C<ABC> and
47			C<DEF>. And the node C<B> (in UNIX process 8321) with the ports C<FOO> and
48			C<BAR>.
49	elmex	1.17
50
51			\|- PID: 7066 -\| \|- PID: 8321 -\|
52			\| \| \| \|
53			\| Node ID: A \| \| Node ID: B \|
54			\| \| \| \|
55			\| Port ABC =\|= <----\ /-----> =\|= Port FOO \|
56			\| \| X \| \|
57			\| Port DEF =\|= <----/ \-----> =\|= Port BAR \|
58			\| \| \| \|
59			\|-------------\| \|-------------\|
60
61	root	1.23	The strings for the I<port IDs> here are just for illustrative
62			purposes: Even though I<ports> in L<AnyEvent::MP> are also identified by
63			strings, they can't be choosen manually and are assigned by the system
64			dynamically. These I<port IDs> are unique within a network and can also be
65			used to identify senders or as message tags for instance.
66
67			The next sections will explain the API of L<AnyEvent::MP> by going through
68			a few simple examples. Later some more complex idioms are introduced,
69			which are hopefully useful to solve some real world problems.
70	root	1.8
71	elmex	1.16	=head1 Passing Your First Message
72
73	root	1.24	As a start lets have a look at the messaging API. The following example
74			is just a demo to show the basic elements of message passing with
75			L<AnyEvent::MP>.
76
77			The example should print: C<Ending with: 123>, in a rather complicated
78			way, by passing some message to a port.
79	elmex	1.16
80			use AnyEvent;
81			use AnyEvent::MP;
82
83			my $end_cv = AnyEvent->condvar;
84
85			my $port = port;
86
87			rcv $port, test => sub {
88			my ($data) = @_;
89			$end_cv->send ($data);
90			};
91
92			snd $port, test => 123;
93
94			print "Ending with: " . $end_cv->recv . "\n";
95
96	root	1.24	It already uses most of the essential functions inside
97			L<AnyEvent::MP>: First there is the C<port> function which will create a
98			I<port> and will return it's I<port ID>, a simple string.
99
100			This I<port ID> can be used to send messages to the port and install
101			handlers to receive messages on the port. Since it is a simple string
102			it can be safely passed to other I<nodes> in the network when you want
103			to refer to that specific port (usually used for RPC, where you need
104			to tell the other end which I<port> to send the reply to - messages in
105			L<AnyEvent::MP> have a destination, but no source).
106	elmex	1.17
107	root	1.24	The next function is C<rcv>:
108	elmex	1.16
109	elmex	1.17	rcv $port, test => sub { ... };
110	elmex	1.16
111	root	1.24	It installs a receiver callback on the I<port> that specified as the first
112			argument (it only works for "local" ports, i.e. ports created on the same
113			node). The next argument, in this example C<test>, specifies a I<tag> to
114			match. This means that whenever a message with the first element being
115			the string C<test> is received, the callback is called with the remaining
116	elmex	1.17	parts of that message.
117
118	root	1.24	Messages can be sent with the C<snd> function, which is used like this in
119			the example above:
120	elmex	1.17
121			snd $port, test => 123;
122
123	root	1.24	This will send the message C<'test', 123> to the I<port> with the I<port
124			ID> stored in C<$port>. Since in this case the receiver has a I<tag> match
125			on C<test> it will call the callback with the first argument being the
126			number C<123>.
127
128			The callback is a typicall AnyEvent idiom: the callback just passes
129			that number on to the I<condition variable> C<$end_cv> which will then
130			pass the value to the print. Condition variables are out of the scope
131			of this tutorial and not often used with ports, so please consult the
132	elmex	1.17	L<AnyEvent::Intro> about them.
133
134	root	1.24	Passing messages inside just one process is boring. Before we can move on
135			and do interprocess message passing we first have to make sure some things
136			have been set up correctly for our nodes to talk to each other.
137	elmex	1.17
138			=head1 System Requirements and System Setup
139
140	root	1.25	Before we can start with real IPC we have to make sure some things work on
141			your system.
142	elmex	1.17
143	root	1.25	First we have to setup a I<shared secret>: for two L<AnyEvent::MP>
144			I<nodes> to be able to communicate with each other over the network it is
145			necessary to setup the same I<shared secret> for both of them, so they can
146			prove their trustworthyness to each other.
147	elmex	1.17
148			The easiest way is to set this up is to use the F<aemp> utility:
149
150			aemp gensecret
151
152	root	1.25	This creates a F<$HOME/.perl-anyevent-mp> config file and generates a
153			random shared secret. You can copy this file to any other system and
154			then communicate over the network (via TCP) with it. You can also select
155			your own shared secret (F<aemp setsecret>) and for increased security
156			requirements you can even create (or configure) a TLS certificate (F<aemp
157			gencert>), causing connections to not just be securely authenticated, but
158			also to be encrypted and protected against tinkering.
159
160			Connections will only be successfully established when the I<nodes>
161			that want to connect to each other have the same I<shared secret> (or
162			successfully verify the TLS certificate of the other side, in which case
163			no shared secret is required).
164	elmex	1.17
165			B<If something does not work as expected, and for example tcpdump shows
166			that the connections are closed almost immediately, you should make sure
167			that F<~/.perl-anyevent-mp> is the same on all hosts/user accounts that
168			you try to connect with each other!>
169	elmex	1.16
170	root	1.25	Thats is all for now, you will find some more advanced fiddling with the
171			C<aemp> utility later.
172
173	elmex	1.18
174			=head1 Passing Messages Between Processes
175
176			=head2 The Receiver
177
178	root	1.25	Lets split the previous example up into two programs: one that contains
179			the sender and one for the receiver. First the receiver application, in
180			full:
181	elmex	1.18
182			use AnyEvent;
183			use AnyEvent::MP;
184			use AnyEvent::MP::Global;
185
186			initialise_node "eg_simple_receiver";
187
188			my $port = port;
189
190			AnyEvent::MP::Global::register $port, "eg_receivers";
191
192			rcv $port, test => sub {
193			my ($data, $reply_port) = @_;
194
195			print "Received data: " . $data . "\n";
196			};
197
198			AnyEvent->condvar->recv;
199
200			=head3 AnyEvent::MP::Global
201
202	root	1.25	Now, that wasn't too bad, was it? Ok, let's step through the new functions
203			and modules that have been used.
204
205			For starters, there is now an additional module being
206			used: L<AnyEvent::MP::Global>. This module provides us with a I<global
207			registry>, which lets us register ports in groups that are visible on all
208			I<nodes> in a network.
209
210			What is this useful for? Well, the I<port IDs> are random-looking strings,
211			assigned by L<AnyEvent::MP>. We cannot know those I<port IDs> in advance,
212			so we don't know which I<port ID> to send messages to, especially when the
213			message is to be passed between different I<nodes> (or UNIX processes). To
214			find the right I<port> of another I<node> in the network we will need
215			to communicate this somehow to the sender. And exactly that is what
216			L<AnyEvent::MP::Global> provides.
217
218			Especially in larger, more anonymous networks this is handy: imagine you
219			have a few database backends, a few web frontends and some processing
220			distributed over a number of hosts: all of these would simply register
221			themselves in the appropriate group, and your web frontends can start to
222			find some database backend.
223	elmex	1.18
224	root	1.25	=head3 C<initialise_node> And The Network
225	elmex	1.18
226	root	1.26	Now, let's have a look at the new function, C<initialise_node>:
227	elmex	1.18
228			initialise_node "eg_simple_receiver";
229
230			Before we are able to send messages to other nodes we have to initialise
231	root	1.26	ourself to become a "distributed node". Initialising a node means naming
232			the node, optionally binding some TCP listeners so that other nodes can
233			contact it and connecting to a predefined set of seed addresses so the
234			node can discover the existing network - and the existing network can
235			discover the node!
236
237			The first argument, the string C<"eg_simple_receiver">, is the so-called
238			I<profile> to use: A profile holds some information about the application
239			that is going to be a node in an L<AnyEvent::MP> network. Customarily you
240			don't specify a profile name at all: in this case, AnyEvent::MP will use
241			the POSIX nodename.
242
243			The profile allows you to set the I<node ID> that your application will
244			use (the node ID defaults to the profile name if not specified). You can
245			also set I<binds> in the profile, meaning that you can define TCP ports
246			that the application will listen on for incoming connections from other
247			nodes of the network.
248
249			You should also configure I<seeds> in the profile: A I<seed> is just a
250			TCP address of some other node in the network. To explain this a bit
251			more detailed we have to look at the topology of an L<AnyEvent::MP>
252			network. The topology is called a I<fully connected mesh>, here an example
253			with 4 nodes:
254	elmex	1.18
255			N1--N2
256			\| \/ \|
257			\| /\ \|
258			N3--N4
259
260			Now imagine another I<node> C<N5>. wants to connect itself to that network:
261
262			N1--N2
263			\| \/ \| N5
264			\| /\ \|
265			N3--N4
266
267	root	1.26	The new node needs to know the I<binds> of all nodes already
268			connected. Exactly this is what the I<seeds> are for: Let's assume that
269			the new node (C<N5>) uses the TCP address of the node C<N2> as seed. This
270			cuases it to connect to C<N2>:
271	elmex	1.18
272			N1--N2____
273			\| \/ \| N5
274			\| /\ \|
275			N3--N4
276
277	root	1.26	C<N2> then tells C<N5> about the I<binds> of the other nodes it is
278			connected to, and C<N5> creates the rest of the connections:
279	elmex	1.18
280			/--------\
281			N1--N2____\|
282			\| \/ \| N5
283			\| /\ \| /\|
284			N3--N4--- \|
285			\________/
286
287	root	1.26	All done: C<N5> is now happily connected to the rest of the network.
288	elmex	1.18
289	elmex	1.19	=head3 Setting Up The Profiles
290
291	root	1.26	Ok, so much to the profile. Now let's setup the C<eg_simple_receiver>
292			I<profile> for later use. For the receiver we just give the receiver a
293			I<bind>:
294	elmex	1.19
295			aemp profile eg_simple_receiver setbinds localhost:12266
296
297	root	1.26	We use C<localhost> in the example, but in the real world, you usually
298			want to use the "real" IP address of your node, so hosts can connect to
299			it. Of course, you can specify many binds, and it is also perfectly useful
300			to run multiple nodes on the same host. Just keep in mind that other nodes
301			will try to I<connect> to those addresses, and this better succeeds if you
302			want your network to be in good working conditions.
303
304			While we are at it, we setup the I<profile> for the sender in the
305			second part of this example, too. We will call the sender I<profile>
306			C<eg_simple_sender>. For the sender we set up a I<seed> pointing to the
307	elmex	1.19	receiver:
308
309			aemp profile eg_simple_sender setseeds localhost:12266
310	elmex	1.22	aemp profile eg_simple_sender setbinds
311	elmex	1.19
312	root	1.26	You might wonder why we setup I<binds> to be empty here: actually, the the
313			I<fully> in the I<fully connected mesh> is not the complete truth: If you
314			don't configure any I<binds> for a node profile it will parse and try to
315			resolve the node ID to find addresses to bind to. In this case we pretend
316			that we do not want this and epxlicitly specify an empty binds list, so
317			the node will not actually listen on any TCP ports.
318
319			Nodes without listeners will not be able to send messages to other nodes
320			without listeners, but they can still talk to all other nodes. For this
321			example, as well as in many cases in the real world, we can live with this
322			restriction, and this makes it easier to avoid DNS (assuming your setup is
323			broken, eliminating one potential problem :).
324	elmex	1.19
325	root	1.27	Whee, setting up nodes can be complicated at first, but you only have to
326			do it once per network, and you can leave this boring task to the admins
327			or end-users that want to use your stuff :)
328
329	elmex	1.19	=head3 Registering The Receiver
330
331	root	1.27	Coming back to our example, we have now introduced the basic purpose of
332			L<AnyEvent::MP::Global> and C<initialise_node> and its use of profiles. We
333			also set up our profiles for later use and now we will finally continue
334			talking about the receiver.
335	elmex	1.19
336	root	1.27	Let's look at the next line(s):
337	elmex	1.19
338			my $port = port;
339			AnyEvent::MP::Global::register $port, "eg_receivers";
340
341	root	1.27	The C<port> function has already been discussed. It simply creates a new
342			I<port> and returns the I<port ID>. The C<register> function, however,
343			is new: The first argument is the I<port ID> that we want to add to a
344			I<global group>, and its second argument is the name of that I<global
345	elmex	1.19	group>.
346
347	root	1.27	You can choose the name of such a I<global group> freely (prefixing your
348			package name is highly recommended!). The purpose of such a group is to
349			store a set of I<port IDs>. This set is made available throughout the
350			whole L<AnyEvent::MP> network, so that each node can see which ports
351			belong to that group.
352
353			Later we will see how the sender looks for the ports in this I<global
354			group> to send messages to them.
355
356			The last step in the example is to set up a receiver callback for those
357			messages, just as was discussed in the first example. We again match
358			for the tag C<test>. The difference is that this time we don't exit the
359			application after receiving the first message. Instead we continue to wait
360			for new messages indefinitely.
361	elmex	1.19
362	elmex	1.20	=head2 The Sender
363	root	1.8
364	root	1.27	Ok, now let's take a look at the sender code:
365	root	1.4
366	elmex	1.1	use AnyEvent;
367			use AnyEvent::MP;
368	elmex	1.20	use AnyEvent::MP::Global;
369	elmex	1.1
370	elmex	1.20	initialise_node "eg_simple_sender";
371	elmex	1.1
372	elmex	1.20	my $find_timer =
373			AnyEvent->timer (after => 0, interval => 1, cb => sub {
374			my $ports = AnyEvent::MP::Global::find "eg_receivers"
375			or return;
376
377			snd $_, test => time
378			for @$ports;
379			});
380	elmex	1.1
381			AnyEvent->condvar->recv;
382
383	root	1.27	It's even less code. The C<initialise_node> serves the same purpose as in
384			the receiver, we just specify a different profile, the profile we set up
385			without the binds.
386	root	1.10
387	root	1.27	Next we set up a timer that repeatedly (every second) calls this chunk of
388			code:
389	elmex	1.1
390	elmex	1.20	my $ports = AnyEvent::MP::Global::find "eg_receivers"
391			or return;
392	elmex	1.2
393	elmex	1.20	snd $_, test => time
394			for @$ports;
395	elmex	1.1
396	root	1.27	The only new function here is the C<find> function of
397			L<AnyEvent::MP::Global>. It searches in the global group named
398			C<eg_receivers> for ports. If none are found, it returns C<undef>, which
399			makes our code return instantly and wait for the next round, as nobody is
400			interested in our message.
401
402			As soon as the receiver application has connected and the information
403			about the newly added port in the receiver has propagated to the sender
404			node, C<find> returns an array reference that contains the I<port ID> of
405			the receiver I<port(s)>.
406
407			We then just send a message with a tag and the current time to every
408			I<port> in the global group.
409
410			=head3 Multiple Receivers
411
412			You can even run multiple receivers - the only problem is that they will
413			use the same node ID. To avoid this problem, you can either not specify a
414			profile name at all and rely on DNS and your POSIX node name, or you can
415			use a special feature called "anonymous nodes":
416
417			aemp profile eg_simple_receiver setnodeid anon/
418
419			The special name C<anon/> will be replaced by a random string each time
420			the node starts. This way you can start many receivers (they do not bind
421			on a TCP port, so cnanot collide with each other), and all of them will
422			receive the central time signal.
423	elmex	1.7
424	root	1.27	That's all for now - next time we will teach you about monitoring by
425			writing a simple chat client and server :)
426	elmex	1.7
427	elmex	1.1	=head1 SEE ALSO
428
429			L<AnyEvent>
430
431			L<AnyEvent::Handle>
432
433			L<AnyEvent::MP>
434
435	elmex	1.20	L<AnyEvent::MP::Global>
436
437	elmex	1.1	=head1 AUTHOR
438
439			Robin Redeker <elmex@ta-sa.org>
440	root	1.4