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

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.144 by root, Fri Mar 23 21:16:25 2012 UTC vs.
Revision 1.153 by root, Sat Nov 2 01:30:49 2019 UTC

118each other. To do this, nodes should listen on one or more local transport 118each other. To do this, nodes should listen on one or more local transport
119endpoints - binds. 119endpoints - binds.
120 120
121Currently, only standard C<ip:port> specifications can be used, which 121Currently, only standard C<ip:port> specifications can be used, which
122specify TCP ports to listen on. So a bind is basically just a tcp socket 122specify TCP ports to listen on. So a bind is basically just a tcp socket
123in listening mode thta accepts conenctions form other nodes. 123in listening mode that accepts connections from other nodes.
124 124
125=item seed nodes 125=item seed nodes
126 126
127When a node starts, it knows nothing about the network it is in - it 127When a node starts, it knows nothing about the network it is in - it
128needs to connect to at least one other node that is already in the 128needs to connect to at least one other node that is already in the
129network. These other nodes are called "seed nodes". 129network. These other nodes are called "seed nodes".
130 130
131Seed nodes themselves are not special - they are seed nodes only because 131Seed nodes themselves are not special - they are seed nodes only because
132some other node I<uses> them as such, but any node can be used as seed 132some other node I<uses> them as such, but any node can be used as seed
133node for other nodes, and eahc node cna use a different set of seed nodes. 133node for other nodes, and eahc node can use a different set of seed nodes.
134 134
135In addition to discovering the network, seed nodes are also used to 135In addition to discovering the network, seed nodes are also used to
136maintain the network - all nodes using the same seed node form are part of 136maintain the network - all nodes using the same seed node are part of the
137the same network. If a network is split into multiple subnets because e.g. 137same network. If a network is split into multiple subnets because e.g. the
138the network link between the parts goes down, then using the same seed 138network link between the parts goes down, then using the same seed nodes
139nodes for all nodes ensures that eventually the subnets get merged again. 139for all nodes ensures that eventually the subnets get merged again.
140 140
141Seed nodes are expected to be long-running, and at least one seed node 141Seed nodes are expected to be long-running, and at least one seed node
142should always be available. They should also be relatively responsive - a 142should always be available. They should also be relatively responsive - a
143seed node that blocks for long periods will slow down everybody else. 143seed node that blocks for long periods will slow down everybody else.
144 144
168 168
169Any node that loads the L<AnyEvent::MP::Global> module becomes a global 169Any node that loads the L<AnyEvent::MP::Global> module becomes a global
170node and tries to keep connections to all other nodes. So while it can 170node and tries to keep connections to all other nodes. So while it can
171make sense to make every node "global" in small networks, it usually makes 171make sense to make every node "global" in small networks, it usually makes
172sense to only make seed nodes into global nodes in large networks (nodes 172sense to only make seed nodes into global nodes in large networks (nodes
173keep connections to seed nodes and global nodes, so makign them the same 173keep connections to seed nodes and global nodes, so making them the same
174reduces overhead). 174reduces overhead).
175 175
176=back 176=back
177 177
178=head1 VARIABLES/FUNCTIONS 178=head1 VARIABLES/FUNCTIONS
204use AnyEvent (); 204use AnyEvent ();
205use Guard (); 205use Guard ();
206 206
207use base "Exporter"; 207use base "Exporter";
208 208
209our $VERSION = $AnyEvent::MP::Config::VERSION; 209our $VERSION = '2.02'; # also in MP/Config.pm
210 210
211our @EXPORT = qw( 211our @EXPORT = qw(
212 configure
213
212 NODE $NODE 214 NODE $NODE
213 configure 215 *SELF
216
214 node_of port_is_local 217 node_of port_is_local
218
215 snd kil 219 snd kil
216 db_set db_del
217 db_mon db_family db_keys db_values
218
219 *SELF
220
221 port rcv mon mon_guard psub peval spawn cal 220 port rcv mon mon_guard psub peval spawn cal
222 db_set db_del db_reg 221 db_set db_del db_reg
223 db_mon db_family db_keys db_values 222 db_mon db_family db_keys db_values
224 223
225 after 224 after
265=over 4 264=over 4
266 265
267=item norc => $boolean (default false) 266=item norc => $boolean (default false)
268 267
269If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not> 268If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
270be consulted - all configuraiton options must be specified in the 269be consulted - all configuration options must be specified in the
271C<configure> call. 270C<configure> call.
272 271
273=item force => $boolean (default false) 272=item force => $boolean (default false)
274 273
275IF true, then the values specified in the C<configure> will take 274IF true, then the values specified in the C<configure> will take
311 310
312=item step 2, bind listener sockets 311=item step 2, bind listener sockets
313 312
314The next step is to look up the binds in the profile, followed by binding 313The next step is to look up the binds in the profile, followed by binding
315aemp protocol listeners on all binds specified (it is possible and valid 314aemp protocol listeners on all binds specified (it is possible and valid
316to have no binds, meaning that the node cannot be contacted form the 315to have no binds, meaning that the node cannot be contacted from the
317outside. This means the node cannot talk to other nodes that also have no 316outside. This means the node cannot talk to other nodes that also have no
318binds, but it can still talk to all "normal" nodes). 317binds, but it can still talk to all "normal" nodes).
319 318
320If the profile does not specify a binds list, then a default of C<*> is 319If the profile does not specify a binds list, then a default of C<*> is
321used, meaning the node will bind on a dynamically-assigned port on every 320used, meaning the node will bind on a dynamically-assigned port on every
418=cut 417=cut
419 418
420sub rcv($@); 419sub rcv($@);
421 420
422my $KILME = sub { 421my $KILME = sub {
423 (my $tag = substr $_[0], 0, 30) =~ s/([\x20-\x7e])/./g; 422 (my $tag = substr $_[0], 0, 30) =~ s/([^\x20-\x7e])/./g;
424 kil $SELF, unhandled_message => "no callback found for message '$tag'"; 423 kil $SELF, unhandled_message => "no callback found for message '$tag'";
425}; 424};
426 425
427sub port(;&) { 426sub port(;&) {
428 my $id = $UNIQ . ++$ID; 427 my $id = $UNIQ . ++$ID;
539 $port 538 $port
540} 539}
541 540
542=item peval $port, $coderef[, @args] 541=item peval $port, $coderef[, @args]
543 542
544Evaluates the given C<$codref> within the contetx of C<$port>, that is, 543Evaluates the given C<$codref> within the context of C<$port>, that is,
545when the code throews an exception the C<$port> will be killed. 544when the code throws an exception the C<$port> will be killed.
546 545
547Any remaining args will be passed to the callback. Any return values will 546Any remaining args will be passed to the callback. Any return values will
548be returned to the caller. 547be returned to the caller.
549 548
550This is useful when you temporarily want to execute code in the context of 549This is useful when you temporarily want to execute code in the context of
1057Same as C<db_family>, except it only queries the family I<values> and passes them 1056Same as C<db_family>, except it only queries the family I<values> and passes them
1058as array reference to the callback. 1057as array reference to the callback.
1059 1058
1060=item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted) 1059=item $guard = db_mon $family => $cb->(\%familyhash, \@added, \@changed, \@deleted)
1061 1060
1062Creates a monitor on the given database family. Each time a key is set 1061Creates a monitor on the given database family. Each time a key is
1063or or is deleted the callback is called with a hash containing the 1062set or is deleted the callback is called with a hash containing the
1064database family and three lists of added, changed and deleted subkeys, 1063database family and three lists of added, changed and deleted subkeys,
1065respectively. If no keys have changed then the array reference might be 1064respectively. If no keys have changed then the array reference might be
1066C<undef> or even missing. 1065C<undef> or even missing.
1067 1066
1068If not called in void context, a guard object is returned that, when 1067If not called in void context, a guard object is returned that, when
1096 return unless %$family; 1095 return unless %$family;
1097 undef $guard; 1096 undef $guard;
1098 print "My::Module::workers now nonempty\n"; 1097 print "My::Module::workers now nonempty\n";
1099 }; 1098 };
1100 1099
1101Example: print all changes to the family "AnyRvent::Fantasy::Module". 1100Example: print all changes to the family "AnyEvent::Fantasy::Module".
1102 1101
1103 my $guard = db_mon AnyRvent::Fantasy::Module => sub { 1102 my $guard = db_mon AnyEvent::Fantasy::Module => sub {
1104 my ($family, $a, $c, $d) = @_; 1103 my ($family, $a, $c, $d) = @_;
1105 1104
1106 print "+$_=$family->{$_}\n" for @$a; 1105 print "+$_=$family->{$_}\n" for @$a;
1107 print "*$_=$family->{$_}\n" for @$c; 1106 print "*$_=$family->{$_}\n" for @$c;
1108 print "-$_=$family->{$_}\n" for @$d; 1107 print "-$_=$family->{$_}\n" for @$d;
1159filter messages without dequeuing them. 1158filter messages without dequeuing them.
1160 1159
1161This is not a philosophical difference, but simply stems from AnyEvent::MP 1160This is not a philosophical difference, but simply stems from AnyEvent::MP
1162being event-based, while Erlang is process-based. 1161being event-based, while Erlang is process-based.
1163 1162
1164You cna have a look at L<Coro::MP> for a more Erlang-like process model on 1163You can have a look at L<Coro::MP> for a more Erlang-like process model on
1165top of AEMP and Coro threads. 1164top of AEMP and Coro threads.
1166 1165
1167=item * Erlang sends are synchronous, AEMP sends are asynchronous. 1166=item * Erlang sends are synchronous, AEMP sends are asynchronous.
1168 1167
1169Sending messages in Erlang is synchronous and blocks the process until 1168Sending messages in Erlang is synchronous and blocks the process until
1170a conenction has been established and the message sent (and so does not 1169a connection has been established and the message sent (and so does not
1171need a queue that can overflow). AEMP sends return immediately, connection 1170need a queue that can overflow). AEMP sends return immediately, connection
1172establishment is handled in the background. 1171establishment is handled in the background.
1173 1172
1174=item * Erlang suffers from silent message loss, AEMP does not. 1173=item * Erlang suffers from silent message loss, AEMP does not.
1175 1174
1314C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon> 1313C<grp_mon> can be replaced by C<db_mon> with minor changes - C<db_mon>
1315passes a hash as first argument, and an extra C<$chg> argument that can be 1314passes a hash as first argument, and an extra C<$chg> argument that can be
1316ignored: 1315ignored:
1317 1316
1318 db_mon $group => sub { 1317 db_mon $group => sub {
1319 my ($ports, $add, $chg, $lde) = @_; 1318 my ($ports, $add, $chg, $del) = @_;
1320 $ports = [keys %$ports]; 1319 $ports = [keys %$ports];
1321 1320
1322 # now $ports, $add and $del are the same as 1321 # now $ports, $add and $del are the same as
1323 # were originally passed by grp_mon. 1322 # were originally passed by grp_mon.
1324 ... 1323 ...
1377 1376
1378=back 1377=back
1379 1378
1380=head1 LOGGING 1379=head1 LOGGING
1381 1380
1382AnyEvent::MP does not normally log anything by itself, but sinc eit is the 1381AnyEvent::MP does not normally log anything by itself, but since it is the
1383root of the contetx hierarchy for AnyEvent::MP modules, it will receive 1382root of the context hierarchy for AnyEvent::MP modules, it will receive
1384all log messages by submodules. 1383all log messages by submodules.
1385 1384
1386=head1 SEE ALSO 1385=head1 SEE ALSO
1387 1386
1388L<AnyEvent::MP::Intro> - a gentle introduction. 1387L<AnyEvent::MP::Intro> - a gentle introduction.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines