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

Comparing AnyEvent-Fork-RPC/RPC.pm (file contents):
Revision 1.30 by root, Sun Aug 25 22:21:15 2013 UTC vs.
Revision 1.31 by root, Sat Aug 31 16:35:33 2013 UTC

454It is called very early - before the serialisers are created or the 454It is called very early - before the serialisers are created or the
455C<$function> name is resolved into a function reference, so it could be 455C<$function> name is resolved into a function reference, so it could be
456used to load any modules that provide the serialiser or function. It can 456used to load any modules that provide the serialiser or function. It can
457not, however, create events. 457not, however, create events.
458 458
459=item done => $function (default C<CORE::exit>)
460
461The function to call when the asynchronous backend detects an end of file
462condition when reading from the communications socket I<and> there are no
463outstanding requests. It's ignored by the synchronous backend.
464
465By overriding this you can prolong the life of a RPC process after e.g.
466the parent has exited by running the event loop in the provided function
467(or simply calling it, for example, when your child process uses L<EV> you
468could provide L<EV::loop> as C<done> function).
469
470Of course, in that case you are responsible for exiting at the appropriate
471time and not returning from
472
459=item async => $boolean (default: 0) 473=item async => $boolean (default: 0)
460 474
461The default server used in the child does all I/O blockingly, and only 475The default server used in the child does all I/O blockingly, and only
462allows a single RPC call to execute concurrently. 476allows a single RPC call to execute concurrently.
463 477
615 }; 629 };
616 630
617 my $module = "AnyEvent::Fork::RPC::" . ($arg{async} ? "Async" : "Sync"); 631 my $module = "AnyEvent::Fork::RPC::" . ($arg{async} ? "Async" : "Sync");
618 632
619 $self->require ($module) 633 $self->require ($module)
620 ->send_arg ($function, $arg{init}, $serialiser) 634 ->send_arg ($function, $arg{init}, $serialiser, $arg{done} || "CORE::exit")
621 ->run ("$module\::run", sub { 635 ->run ("$module\::run", sub {
622 $fh = shift; 636 $fh = shift;
623 637
624 my ($id, $len); 638 my ($id, $len);
625 $rw = AE::io $fh, 0, sub { 639 $rw = AE::io $fh, 0, sub {
741See the examples section earlier in this document for some actual 755See the examples section earlier in this document for some actual
742examples. 756examples.
743 757
744=back 758=back
745 759
760=head2 PROCESS EXIT
761
762If and when the child process exits depends on the backend and
763configuration. Apart from explicit exits (e.g. by calling C<exit>) or
764runtime conditions (uncaught exceptions, signals etc.), the backends exit
765under these conditions:
766
767=over 4
768
769=item Synchronous Backend
770
771The synchronous backend is very simple: when the process waits for another
772request to arrive and the writing side (usually in the parent) is closed,
773it will exit normally, i.e. as if your main program reached the end of the
774file.
775
776That means that if your parent process exits, the RPC process will usually
777exit as well, either because it is idle anyway, or because it executes a
778request. In the latter case, you will likely get an error when the RPc
779process tries to send the results to the parent (because agruably, you
780shouldn't exit your parent while there are still outstanding requests).
781
782The process is usually quiescent when it happens, so it should rarely be a
783problem, and C<END> handlers can be used to clean up.
784
785=item Asynchronous Backend
786
787For the asynchronous backend, things are more complicated: Whenever it
788listens for another request by the parent, it might detect that the socket
789was closed (e.g. because the parent exited). It will sotp listening for
790new requests and instead try to write out any remaining data (if any) or
791simply check whether the socket cna be written to. After this, the RPC
792process is effectively done - no new requests are incoming, no outstanding
793request data can be written back.
794
795Since chances are high that there are event watchers that the RPC server
796knows nothing about (why else would one use the async backend if not for
797the ability to register watchers?), the event loop would often happily
798continue.
799
800This is why the asynchronous backend explicitly calls C<CORE::exit> when
801it is done (it will raise an exception under other circumstances, which
802might lead to the process not exiting on it's own).
803
804You can override this by specifying a function name to call via the C<done>
805parameter instead.
806
807=back
808
746=head1 ADVANCED TOPICS 809=head1 ADVANCED TOPICS
747 810
748=head2 Choosing a backend 811=head2 Choosing a backend
749 812
750So how do you decide which backend to use? Well, that's your problem to 813So how do you decide which backend to use? Well, that's your problem to

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines