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.33 by root, Wed Aug 5 22:40:51 2009 UTC vs.
Revision 1.46 by root, Thu Aug 13 01:46:10 2009 UTC

8 8
9 $NODE # contains this node's noderef 9 $NODE # contains this node's noderef
10 NODE # returns this node's noderef 10 NODE # returns this node's noderef
11 NODE $port # returns the noderef of the port 11 NODE $port # returns the noderef of the port
12 12
13 $SELF # receiving/own port id in rcv callbacks
14
15 # ports are message endpoints
16
17 # sending messages
13 snd $port, type => data...; 18 snd $port, type => data...;
19 snd $port, @msg;
20 snd @msg_with_first_element_being_a_port;
14 21
15 $SELF # receiving/own port id in rcv callbacks 22 # miniports
23 my $miniport = port { my @msg = @_; 0 };
16 24
25 # full ports
26 my $port = port;
17 rcv $port, smartmatch => $cb->($port, @msg); 27 rcv $port, smartmatch => $cb->(@msg);
18
19 # examples:
20 rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; 28 rcv $port, ping => sub { snd $_[0], "pong"; 0 };
21 rcv $port1, pong => sub { warn "pong received\n" }; 29 rcv $port, pong => sub { warn "pong received\n"; 0 };
22 snd $port2, ping => $port1; 30
31 # remote ports
32 my $port = spawn $node, $initfunc, @initdata;
23 33
24 # more, smarter, matches (_any_ is exported by this module) 34 # more, smarter, matches (_any_ is exported by this module)
25 rcv $port, [child_died => $pid] => sub { ... 35 rcv $port, [child_died => $pid] => sub { ...
26 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3 36 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
27 37
38 # monitoring
39 mon $port, $cb->(@msg) # callback is invoked on death
40 mon $port, $otherport # kill otherport on abnormal death
41 mon $port, $otherport, @msg # send message on death
42
43=head1 CURRENT STATUS
44
45 AnyEvent::MP - stable API, should work
46 AnyEvent::MP::Intro - outdated
47 AnyEvent::MP::Kernel - WIP
48 AnyEvent::MP::Transport - mostly stable
49
50 stay tuned.
51
28=head1 DESCRIPTION 52=head1 DESCRIPTION
29 53
30This module (-family) implements a simple message passing framework. 54This module (-family) implements a simple message passing framework.
31 55
32Despite its simplicity, you can securely message other processes running 56Despite its simplicity, you can securely message other processes running
35For an introduction to this module family, see the L<AnyEvent::MP::Intro> 59For an introduction to this module family, see the L<AnyEvent::MP::Intro>
36manual page. 60manual page.
37 61
38At the moment, this module family is severly broken and underdocumented, 62At the moment, this module family is severly broken and underdocumented,
39so do not use. This was uploaded mainly to reserve the CPAN namespace - 63so do not use. This was uploaded mainly to reserve the CPAN namespace -
40stay tuned! The basic API should be finished, however. 64stay tuned!
41 65
42=head1 CONCEPTS 66=head1 CONCEPTS
43 67
44=over 4 68=over 4
45 69
90 114
91=cut 115=cut
92 116
93package AnyEvent::MP; 117package AnyEvent::MP;
94 118
95use AnyEvent::MP::Base; 119use AnyEvent::MP::Kernel;
96 120
97use common::sense; 121use common::sense;
98 122
99use Carp (); 123use Carp ();
100 124
101use AE (); 125use AE ();
102 126
103use base "Exporter"; 127use base "Exporter";
104 128
105our $VERSION = '0.1'; 129our $VERSION = $AnyEvent::MP::Kernel::VERSION;
130
106our @EXPORT = qw( 131our @EXPORT = qw(
107 NODE $NODE *SELF node_of _any_ 132 NODE $NODE *SELF node_of _any_
108 resolve_node initialise_node 133 resolve_node initialise_node
109 snd rcv mon kil reg psub 134 snd rcv mon kil reg psub spawn
110 port 135 port
111); 136);
112 137
113our $SELF; 138our $SELF;
114 139
127 152
128=item $noderef = node_of $port 153=item $noderef = node_of $port
129 154
130Extracts and returns the noderef from a portid or a noderef. 155Extracts and returns the noderef from a portid or a noderef.
131 156
157=item initialise_node $noderef, $seednode, $seednode...
158
159=item initialise_node "slave/", $master, $master...
160
161Before a node can talk to other nodes on the network it has to initialise
162itself - the minimum a node needs to know is it's own name, and optionally
163it should know the noderefs of some other nodes in the network.
164
165This function initialises a node - it must be called exactly once (or
166never) before calling other AnyEvent::MP functions.
167
168All arguments are noderefs, which can be either resolved or unresolved.
169
170There are two types of networked nodes, public nodes and slave nodes:
171
172=over 4
173
174=item public nodes
175
176For public nodes, C<$noderef> must either be a (possibly unresolved)
177noderef, in which case it will be resolved, or C<undef> (or missing), in
178which case the noderef will be guessed.
179
180Afterwards, the node will bind itself on all endpoints and try to connect
181to all additional C<$seednodes> that are specified. Seednodes are optional
182and can be used to quickly bootstrap the node into an existing network.
183
184=item slave nodes
185
186When the C<$noderef> is the special string C<slave/>, then the node will
187become a slave node. Slave nodes cannot be contacted from outside and will
188route most of their traffic to the master node that they attach to.
189
190At least one additional noderef is required: The node will try to connect
191to all of them and will become a slave attached to the first node it can
192successfully connect to.
193
194=back
195
196This function will block until all nodes have been resolved and, for slave
197nodes, until it has successfully established a connection to a master
198server.
199
200Example: become a public node listening on the default node.
201
202 initialise_node;
203
204Example: become a public node, and try to contact some well-known master
205servers to become part of the network.
206
207 initialise_node undef, "master1", "master2";
208
209Example: become a public node listening on port C<4041>.
210
211 initialise_node 4041;
212
213Example: become a public node, only visible on localhost port 4044.
214
215 initialise_node "locahost:4044";
216
217Example: become a slave node to any of the specified master servers.
218
219 initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
220
132=item $cv = resolve_node $noderef 221=item $cv = resolve_node $noderef
133 222
134Takes an unresolved node reference that may contain hostnames and 223Takes an unresolved node reference that may contain hostnames and
135abbreviated IDs, resolves all of them and returns a resolved node 224abbreviated IDs, resolves all of them and returns a resolved node
136reference. 225reference.
233 $port 322 $port
234} 323}
235 324
236=item reg $port, $name 325=item reg $port, $name
237 326
238Registers the given port under the name C<$name>. If the name already 327=item reg $name
239exists it is replaced. 328
329Registers the given port (or C<$SELF><<< if missing) under the name
330C<$name>. If the name already exists it is replaced.
240 331
241A port can only be registered under one well known name. 332A port can only be registered under one well known name.
242 333
243A port automatically becomes unregistered when it is killed. 334A port automatically becomes unregistered when it is killed.
244 335
245=cut 336=cut
246 337
247sub reg(@) { 338sub reg(@) {
248 my ($port, $name) = @_; 339 my $port = @_ > 1 ? shift : $SELF || Carp::croak 'reg: called with one argument only, but $SELF not set,';
249 340
250 $REG{$name} = $port; 341 $REG{$_[0]} = $port;
251} 342}
252 343
253=item rcv $port, $callback->(@msg) 344=item rcv $port, $callback->(@msg)
254 345
255Replaces the callback on the specified miniport (after converting it to 346Replaces the callback on the specified miniport (after converting it to
260=item rcv $port, $smartmatch => $callback->(@msg), ... 351=item rcv $port, $smartmatch => $callback->(@msg), ...
261 352
262=item rcv $port, [$smartmatch...] => $callback->(@msg), ... 353=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
263 354
264Register callbacks to be called on matching messages on the given full 355Register callbacks to be called on matching messages on the given full
265port (after converting it to one if required). 356port (after converting it to one if required) and return the port.
266 357
267The callback has to return a true value when its work is done, after 358The callback has to return a true value when its work is done, after
268which is will be removed, or a false value in which case it will stay 359which is will be removed, or a false value in which case it will stay
269registered. 360registered.
270 361
271The global C<$SELF> (exported by this module) contains C<$port> while 362The global C<$SELF> (exported by this module) contains C<$port> while
272executing the callback. 363executing the callback.
273 364
274Runtime errors wdurign callback execution will result in the port being 365Runtime errors during callback execution will result in the port being
275C<kil>ed. 366C<kil>ed.
276 367
277If the match is an array reference, then it will be matched against the 368If the match is an array reference, then it will be matched against the
278first elements of the message, otherwise only the first element is being 369first elements of the message, otherwise only the first element is being
279matched. 370matched.
282exported by this module) matches any single element of the message. 373exported by this module) matches any single element of the message.
283 374
284While not required, it is highly recommended that the first matching 375While not required, it is highly recommended that the first matching
285element is a string identifying the message. The one-string-only match is 376element is a string identifying the message. The one-string-only match is
286also the most efficient match (by far). 377also the most efficient match (by far).
378
379Example: create a port and bind receivers on it in one go.
380
381 my $port = rcv port,
382 msg1 => sub { ...; 0 },
383 msg2 => sub { ...; 0 },
384 ;
385
386Example: create a port, bind receivers and send it in a message elsewhere
387in one go:
388
389 snd $otherport, reply =>
390 rcv port,
391 msg1 => sub { ...; 0 },
392 ...
393 ;
287 394
288=cut 395=cut
289 396
290sub rcv($@) { 397sub rcv($@) {
291 my $port = shift; 398 my $port = shift;
398 } 505 }
399} 506}
400 507
401=item $guard = mon $port, $cb->(@reason) 508=item $guard = mon $port, $cb->(@reason)
402 509
403=item $guard = mon $port, $otherport 510=item $guard = mon $port, $rcvport
404 511
512=item $guard = mon $port
513
405=item $guard = mon $port, $otherport, @msg 514=item $guard = mon $port, $rcvport, @msg
406 515
407Monitor the given port and do something when the port is killed. 516Monitor the given port and do something when the port is killed or
517messages to it were lost, and optionally return a guard that can be used
518to stop monitoring again.
408 519
520C<mon> effectively guarantees that, in the absence of hardware failures,
521that after starting the monitor, either all messages sent to the port
522will arrive, or the monitoring action will be invoked after possible
523message loss has been detected. No messages will be lost "in between"
524(after the first lost message no further messages will be received by the
525port). After the monitoring action was invoked, further messages might get
526delivered again.
527
409In the first form, the callback is simply called with any number 528In the first form (callback), the callback is simply called with any
410of C<@reason> elements (no @reason means that the port was deleted 529number of C<@reason> elements (no @reason means that the port was deleted
411"normally"). Note also that I<< the callback B<must> never die >>, so use 530"normally"). Note also that I<< the callback B<must> never die >>, so use
412C<eval> if unsure. 531C<eval> if unsure.
413 532
414In the second form, the other port will be C<kil>'ed with C<@reason>, iff 533In the second form (another port given), the other port (C<$rcvport>)
415a @reason was specified, i.e. on "normal" kils nothing happens, while 534will be C<kil>'ed with C<@reason>, iff a @reason was specified, i.e. on
416under all other conditions, the other port is killed with the same reason. 535"normal" kils nothing happens, while under all other conditions, the other
536port is killed with the same reason.
417 537
538The third form (kill self) is the same as the second form, except that
539C<$rvport> defaults to C<$SELF>.
540
418In the last form, a message of the form C<@msg, @reason> will be C<snd>. 541In the last form (message), a message of the form C<@msg, @reason> will be
542C<snd>.
543
544As a rule of thumb, monitoring requests should always monitor a port from
545a local port (or callback). The reason is that kill messages might get
546lost, just like any other message. Another less obvious reason is that
547even monitoring requests can get lost (for exmaple, when the connection
548to the other node goes down permanently). When monitoring a port locally
549these problems do not exist.
419 550
420Example: call a given callback when C<$port> is killed. 551Example: call a given callback when C<$port> is killed.
421 552
422 mon $port, sub { warn "port died because of <@_>\n" }; 553 mon $port, sub { warn "port died because of <@_>\n" };
423 554
424Example: kill ourselves when C<$port> is killed abnormally. 555Example: kill ourselves when C<$port> is killed abnormally.
425 556
426 mon $port, $self; 557 mon $port;
427 558
428Example: send us a restart message another C<$port> is killed. 559Example: send us a restart message when another C<$port> is killed.
429 560
430 mon $port, $self => "restart"; 561 mon $port, $self => "restart";
431 562
432=cut 563=cut
433 564
434sub mon { 565sub mon {
435 my ($noderef, $port) = split /#/, shift, 2; 566 my ($noderef, $port) = split /#/, shift, 2;
436 567
437 my $node = $NODE{$noderef} || add_node $noderef; 568 my $node = $NODE{$noderef} || add_node $noderef;
438 569
439 my $cb = shift; 570 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
440 571
441 unless (ref $cb) { 572 unless (ref $cb) {
442 if (@_) { 573 if (@_) {
443 # send a kill info message 574 # send a kill info message
444 my (@msg) = ($cb, @_); 575 my (@msg) = ($cb, @_);
475=cut 606=cut
476 607
477sub mon_guard { 608sub mon_guard {
478 my ($port, @refs) = @_; 609 my ($port, @refs) = @_;
479 610
611 #TODO: mon-less form?
612
480 mon $port, sub { 0 && @refs } 613 mon $port, sub { 0 && @refs }
481} 614}
482 615
483=item lnk $port1, $port2
484
485Link two ports. This is simply a shorthand for:
486
487 mon $port1, $port2;
488 mon $port2, $port1;
489
490It means that if either one is killed abnormally, the other one gets
491killed as well.
492
493=item kil $port[, @reason] 616=item kil $port[, @reason]
494 617
495Kill the specified port with the given C<@reason>. 618Kill the specified port with the given C<@reason>.
496 619
497If no C<@reason> is specified, then the port is killed "normally" (linked 620If no C<@reason> is specified, then the port is killed "normally" (linked
504will be reported as reason C<< die => $@ >>. 627will be reported as reason C<< die => $@ >>.
505 628
506Transport/communication errors are reported as C<< transport_error => 629Transport/communication errors are reported as C<< transport_error =>
507$message >>. 630$message >>.
508 631
509=back
510
511=head1 FUNCTIONS FOR NODES
512
513=over 4
514
515=item initialise_node $noderef, $seednode, $seednode...
516
517=item initialise_node "slave/", $master, $master...
518
519Initialises a node - must be called exactly once before calling other
520AnyEvent::MP functions when talking to other nodes is required.
521
522All arguments are noderefs, which can be either resolved or unresolved.
523
524There are two types of networked nodes, public nodes and slave nodes:
525
526=over 4
527
528=item public nodes
529
530For public nodes, C<$noderef> must either be a (possibly unresolved)
531noderef, in which case it will be resolved, or C<undef> (or missing), in
532which case the noderef will be guessed.
533
534Afterwards, the node will bind itself on all endpoints and try to connect
535to all additional C<$seednodes> that are specified. Seednodes are optional
536and can be used to quickly bootstrap the node into an existing network.
537
538=item slave nodes
539
540When the C<$noderef> is the special string C<slave/>, then the node will
541become a slave node. Slave nodes cannot be contacted from outside and will
542route most of their traffic to the master node that they attach to.
543
544At least one additional noderef is required: The node will try to connect
545to all of them and will become a slave attached to the first node it can
546successfully connect to.
547
548=back
549
550This function will block until all nodes have been resolved and, for slave
551nodes, until it has successfully established a connection to a master
552server.
553
554Example: become a public node listening on the default node.
555
556 initialise_node;
557
558Example: become a public node, and try to contact some well-known master
559servers to become part of the network.
560
561 initialise_node undef, "master1", "master2";
562
563Example: become a public node listening on port C<4041>.
564
565 initialise_node 4041;
566
567Example: become a public node, only visible on localhost port 4044.
568
569 initialise_node "locahost:4044";
570
571Example: become a slave node to any of the specified master servers.
572
573 initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
574
575=cut 632=cut
633
634=item $port = spawn $node, $initfunc[, @initdata]
635
636Creates a port on the node C<$node> (which can also be a port ID, in which
637case it's the node where that port resides).
638
639The port ID of the newly created port is return immediately, and it is
640permissible to immediately start sending messages or monitor the port.
641
642After the port has been created, the init function is
643called. This function must be a fully-qualified function name
644(e.g. C<MyApp::Chat::Server::init>). To specify a function in the main
645program, use C<::name>.
646
647If the function doesn't exist, then the node tries to C<require>
648the package, then the package above the package and so on (e.g.
649C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
650exists or it runs out of package names.
651
652The init function is then called with the newly-created port as context
653object (C<$SELF>) and the C<@initdata> values as arguments.
654
655A common idiom is to pass your own port, monitor the spawned port, and
656in the init function, monitor the original port. This two-way monitoring
657ensures that both ports get cleaned up when there is a problem.
658
659Example: spawn a chat server port on C<$othernode>.
660
661 # this node, executed from within a port context:
662 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
663 mon $server;
664
665 # init function on C<$othernode>
666 sub connect {
667 my ($srcport) = @_;
668
669 mon $srcport;
670
671 rcv $SELF, sub {
672 ...
673 };
674 }
675
676=cut
677
678sub _spawn {
679 my $port = shift;
680 my $init = shift;
681
682 local $SELF = "$NODE#$port";
683 eval {
684 &{ load_func $init }
685 };
686 _self_die if $@;
687}
688
689sub spawn(@) {
690 my ($noderef, undef) = split /#/, shift, 2;
691
692 my $id = "$RUNIQ." . $ID++;
693
694 $_[0] =~ /::/
695 or Carp::croak "spawn init function must be a fully-qualified name, caught";
696
697 ($NODE{$noderef} || add_node $noderef)
698 ->send (["", "AnyEvent::MP::_spawn" => $id, @_]);
699
700 "$noderef#$id"
701}
576 702
577=back 703=back
578 704
579=head1 NODE MESSAGES 705=head1 NODE MESSAGES
580 706
622 748
623=back 749=back
624 750
625=head1 AnyEvent::MP vs. Distributed Erlang 751=head1 AnyEvent::MP vs. Distributed Erlang
626 752
627AnyEvent::MP got lots of its ideas from distributed erlang (erlang node 753AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
628== aemp node, erlang process == aemp port), so many of the documents and 754== aemp node, Erlang process == aemp port), so many of the documents and
629programming techniques employed by erlang apply to AnyEvent::MP. Here is a 755programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
630sample: 756sample:
631 757
632 http://www.erlang.se/doc/programming_rules.shtml 758 http://www.Erlang.se/doc/programming_rules.shtml
633 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 759 http://Erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
634 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6 760 http://Erlang.org/download/Erlang-book-part1.pdf # chapters 5 and 6
635 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 761 http://Erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
636 762
637Despite the similarities, there are also some important differences: 763Despite the similarities, there are also some important differences:
638 764
639=over 4 765=over 4
640 766
651 777
652Erlang uses processes that selctively receive messages, and therefore 778Erlang uses processes that selctively receive messages, and therefore
653needs a queue. AEMP is event based, queuing messages would serve no useful 779needs a queue. AEMP is event based, queuing messages would serve no useful
654purpose. 780purpose.
655 781
656(But see L<Coro::MP> for a more erlang-like process model on top of AEMP). 782(But see L<Coro::MP> for a more Erlang-like process model on top of AEMP).
657 783
658=item * Erlang sends are synchronous, AEMP sends are asynchronous. 784=item * Erlang sends are synchronous, AEMP sends are asynchronous.
659 785
660Sending messages in erlang is synchronous and blocks the process. AEMP 786Sending messages in Erlang is synchronous and blocks the process. AEMP
661sends are immediate, connection establishment is handled in the 787sends are immediate, connection establishment is handled in the
662background. 788background.
663 789
664=item * Erlang can silently lose messages, AEMP cannot. 790=item * Erlang can silently lose messages, AEMP cannot.
665 791
668and c, and the other side only receives messages a and c). 794and c, and the other side only receives messages a and c).
669 795
670AEMP guarantees correct ordering, and the guarantee that there are no 796AEMP guarantees correct ordering, and the guarantee that there are no
671holes in the message sequence. 797holes in the message sequence.
672 798
673=item * In erlang, processes can be declared dead and later be found to be 799=item * In Erlang, processes can be declared dead and later be found to be
674alive. 800alive.
675 801
676In erlang it can happen that a monitored process is declared dead and 802In Erlang it can happen that a monitored process is declared dead and
677linked processes get killed, but later it turns out that the process is 803linked processes get killed, but later it turns out that the process is
678still alive - and can receive messages. 804still alive - and can receive messages.
679 805
680In AEMP, when port monitoring detects a port as dead, then that port will 806In AEMP, when port monitoring detects a port as dead, then that port will
681eventually be killed - it cannot happen that a node detects a port as dead 807eventually be killed - it cannot happen that a node detects a port as dead
682and then later sends messages to it, finding it is still alive. 808and then later sends messages to it, finding it is still alive.
683 809
684=item * Erlang can send messages to the wrong port, AEMP does not. 810=item * Erlang can send messages to the wrong port, AEMP does not.
685 811
686In erlang it is quite possible that a node that restarts reuses a process 812In Erlang it is quite possible that a node that restarts reuses a process
687ID known to other nodes for a completely different process, causing 813ID known to other nodes for a completely different process, causing
688messages destined for that process to end up in an unrelated process. 814messages destined for that process to end up in an unrelated process.
689 815
690AEMP never reuses port IDs, so old messages or old port IDs floating 816AEMP never reuses port IDs, so old messages or old port IDs floating
691around in the network will not be sent to an unrelated port. 817around in the network will not be sent to an unrelated port.
697securely authenticate nodes. 823securely authenticate nodes.
698 824
699=item * The AEMP protocol is optimised for both text-based and binary 825=item * The AEMP protocol is optimised for both text-based and binary
700communications. 826communications.
701 827
702The AEMP protocol, unlike the erlang protocol, supports both 828The AEMP protocol, unlike the Erlang protocol, supports both
703language-independent text-only protocols (good for debugging) and binary, 829language-independent text-only protocols (good for debugging) and binary,
704language-specific serialisers (e.g. Storable). 830language-specific serialisers (e.g. Storable).
705 831
706It has also been carefully designed to be implementable in other languages 832It has also been carefully designed to be implementable in other languages
707with a minimum of work while gracefully degrading fucntionality to make the 833with a minimum of work while gracefully degrading fucntionality to make the
708protocol simple. 834protocol simple.
709 835
836=item * AEMP has more flexible monitoring options than Erlang.
837
838In Erlang, you can chose to receive I<all> exit signals as messages
839or I<none>, there is no in-between, so monitoring single processes is
840difficult to implement. Monitoring in AEMP is more flexible than in
841Erlang, as one can choose between automatic kill, exit message or callback
842on a per-process basis.
843
844=item * Erlang tries to hide remote/local connections, AEMP does not.
845
846Monitoring in Erlang is not an indicator of process death/crashes,
847as linking is (except linking is unreliable in Erlang).
848
849In AEMP, you don't "look up" registered port names or send to named ports
850that might or might not be persistent. Instead, you normally spawn a port
851on the remote node. The init function monitors the you, and you monitor
852the remote port. Since both monitors are local to the node, they are much
853more reliable.
854
855This also saves round-trips and avoids sending messages to the wrong port
856(hard to do in Erlang).
857
858=back
859
860=head1 RATIONALE
861
862=over 4
863
864=item Why strings for ports and noderefs, why not objects?
865
866We considered "objects", but found that the actual number of methods
867thatc an be called are very low. Since port IDs and noderefs travel over
868the network frequently, the serialising/deserialising would add lots of
869overhead, as well as having to keep a proxy object.
870
871Strings can easily be printed, easily serialised etc. and need no special
872procedures to be "valid".
873
874=item Why favour JSON, why not real serialising format such as Storable?
875
876In fact, any AnyEvent::MP node will happily accept Storable as framing
877format, but currently there is no way to make a node use Storable by
878default.
879
880The default framing protocol is JSON because a) JSON::XS is many times
881faster for small messages and b) most importantly, after years of
882experience we found that object serialisation is causing more problems
883than it gains: Just like function calls, objects simply do not travel
884easily over the network, mostly because they will always be a copy, so you
885always have to re-think your design.
886
887Keeping your messages simple, concentrating on data structures rather than
888objects, will keep your messages clean, tidy and efficient.
889
710=back 890=back
711 891
712=head1 SEE ALSO 892=head1 SEE ALSO
713 893
714L<AnyEvent>. 894L<AnyEvent>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines