… | |
… | |
2 | |
2 | |
3 | AnyEvent::Fork::RPC - simple RPC extension for AnyEvent::Fork |
3 | AnyEvent::Fork::RPC - simple RPC extension for AnyEvent::Fork |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
|
|
7 | use AnyEvent::Fork; |
7 | use AnyEvent::Fork::RPC; |
8 | use AnyEvent::Fork::RPC; |
8 | # use AnyEvent::Fork is not needed |
|
|
9 | |
9 | |
10 | my $rpc = AnyEvent::Fork |
10 | my $rpc = AnyEvent::Fork |
11 | ->new |
11 | ->new |
12 | ->require ("MyModule") |
12 | ->require ("MyModule") |
13 | ->AnyEvent::Fork::RPC::run ( |
13 | ->AnyEvent::Fork::RPC::run ( |
… | |
… | |
26 | $cv->recv; |
26 | $cv->recv; |
27 | |
27 | |
28 | =head1 DESCRIPTION |
28 | =head1 DESCRIPTION |
29 | |
29 | |
30 | This module implements a simple RPC protocol and backend for processes |
30 | This module implements a simple RPC protocol and backend for processes |
31 | created via L<AnyEvent::Fork> (or L<AnyEvent::Fork::Remote>), allowing you |
31 | created via L<AnyEvent::Fork> or L<AnyEvent::Fork::Remote>, allowing you |
32 | to call a function in the child process and receive its return values (up |
32 | to call a function in the child process and receive its return values (up |
33 | to 4GB serialised). |
33 | to 4GB serialised). |
34 | |
34 | |
35 | It implements two different backends: a synchronous one that works like a |
35 | It implements two different backends: a synchronous one that works like a |
36 | normal function call, and an asynchronous one that can run multiple jobs |
36 | normal function call, and an asynchronous one that can run multiple jobs |
37 | concurrently in the child, using AnyEvent. |
37 | concurrently in the child, using AnyEvent. |
38 | |
38 | |
39 | It also implements an asynchronous event mechanism from the child to the |
39 | It also implements an asynchronous event mechanism from the child to the |
40 | parent, that could be used for progress indications or other information. |
40 | parent, that could be used for progress indications or other information. |
41 | |
|
|
42 | Loading this module also always loads L<AnyEvent::Fork>, so you can make a |
|
|
43 | separate C<use AnyEvent::Fork> if you wish, but you don't have to. |
|
|
44 | |
41 | |
45 | =head1 EXAMPLES |
42 | =head1 EXAMPLES |
46 | |
43 | |
47 | =head2 Example 1: Synchronous Backend |
44 | =head2 Example 1: Synchronous Backend |
48 | |
45 | |
… | |
… | |
52 | silly, but illustrates the use of events. |
49 | silly, but illustrates the use of events. |
53 | |
50 | |
54 | First the parent process: |
51 | First the parent process: |
55 | |
52 | |
56 | use AnyEvent; |
53 | use AnyEvent; |
|
|
54 | use AnyEvent::Fork; |
57 | use AnyEvent::Fork::RPC; |
55 | use AnyEvent::Fork::RPC; |
58 | |
56 | |
59 | my $done = AE::cv; |
57 | my $done = AE::cv; |
60 | |
58 | |
61 | my $rpc = AnyEvent::Fork |
59 | my $rpc = AnyEvent::Fork |
62 | ->new |
60 | ->new |
63 | ->require ("MyWorker") |
61 | ->require ("MyWorker") |
64 | ->AnyEvent::Fork::RPC::run ("MyWorker::run", |
62 | ->AnyEvent::Fork::RPC::run ("MyWorker::run", |
65 | on_error => sub { warn "FATAL: $_[0]"; exit 1 }, |
63 | on_error => sub { warn "ERROR: $_[0]"; exit 1 }, |
66 | on_event => sub { warn "$_[0] requests handled\n" }, |
64 | on_event => sub { warn "$_[0] requests handled\n" }, |
67 | on_destroy => $done, |
65 | on_destroy => $done, |
68 | ); |
66 | ); |
69 | |
67 | |
70 | for my $id (1..6) { |
68 | for my $id (1..6) { |
… | |
… | |
177 | you really I<are> done. |
175 | you really I<are> done. |
178 | |
176 | |
179 | =head2 Example 2: Asynchronous Backend |
177 | =head2 Example 2: Asynchronous Backend |
180 | |
178 | |
181 | This example implements multiple count-downs in the child, using |
179 | This example implements multiple count-downs in the child, using |
182 | L<AnyEvent> timers. While this is a bit silly (one could use timers in te |
180 | L<AnyEvent> timers. While this is a bit silly (one could use timers in the |
183 | parent just as well), it illustrates the ability to use AnyEvent in the |
181 | parent just as well), it illustrates the ability to use AnyEvent in the |
184 | child and the fact that responses can arrive in a different order then the |
182 | child and the fact that responses can arrive in a different order then the |
185 | requests. |
183 | requests. |
186 | |
184 | |
187 | It also shows how to embed the actual child code into a C<__DATA__> |
185 | It also shows how to embed the actual child code into a C<__DATA__> |
… | |
… | |
192 | so silly anymore. |
190 | so silly anymore. |
193 | |
191 | |
194 | Without further ado, here is the code: |
192 | Without further ado, here is the code: |
195 | |
193 | |
196 | use AnyEvent; |
194 | use AnyEvent; |
|
|
195 | use AnyEvent::Fork; |
197 | use AnyEvent::Fork::RPC; |
196 | use AnyEvent::Fork::RPC; |
198 | |
197 | |
199 | my $done = AE::cv; |
198 | my $done = AE::cv; |
200 | |
199 | |
201 | my $rpc = AnyEvent::Fork |
200 | my $rpc = AnyEvent::Fork |
202 | ->new |
201 | ->new |
203 | ->require ("AnyEvent::Fork::RPC::Async") |
202 | ->require ("AnyEvent::Fork::RPC::Async") |
204 | ->eval (do { local $/; <DATA> }) |
203 | ->eval (do { local $/; <DATA> }) |
205 | ->AnyEvent::Fork::RPC::run ("run", |
204 | ->AnyEvent::Fork::RPC::run ("run", |
206 | async => 1, |
205 | async => 1, |
207 | on_error => sub { warn "FATAL: $_[0]"; exit 1 }, |
206 | on_error => sub { warn "ERROR: $_[0]"; exit 1 }, |
208 | on_event => sub { print $_[0] }, |
207 | on_event => sub { print $_[0] }, |
209 | on_destroy => $done, |
208 | on_destroy => $done, |
210 | ); |
209 | ); |
211 | |
210 | |
212 | for my $count (3, 2, 1) { |
211 | for my $count (3, 2, 1) { |
… | |
… | |
288 | |
287 | |
289 | This concludes the async example. Since L<AnyEvent::Fork> does not |
288 | This concludes the async example. Since L<AnyEvent::Fork> does not |
290 | actually fork, you are free to use about any module in the child, not just |
289 | actually fork, you are free to use about any module in the child, not just |
291 | L<AnyEvent>, but also L<IO::AIO>, or L<Tk> for example. |
290 | L<AnyEvent>, but also L<IO::AIO>, or L<Tk> for example. |
292 | |
291 | |
|
|
292 | =head2 Example 3: Asynchronous backend with Coro |
|
|
293 | |
|
|
294 | With L<Coro> you can create a nice asynchronous backend implementation by |
|
|
295 | defining an rpc server function that creates a new Coro thread for every |
|
|
296 | request that calls a function "normally", i.e. the parameters from the |
|
|
297 | parent process are passed to it, and any return values are returned to the |
|
|
298 | parent process, e.g.: |
|
|
299 | |
|
|
300 | package My::Arith; |
|
|
301 | |
|
|
302 | sub add { |
|
|
303 | return $_[0] + $_[1]; |
|
|
304 | } |
|
|
305 | |
|
|
306 | sub mul { |
|
|
307 | return $_[0] * $_[1]; |
|
|
308 | } |
|
|
309 | |
|
|
310 | sub run { |
|
|
311 | my ($done, $func, @arg) = @_; |
|
|
312 | |
|
|
313 | Coro::async_pool { |
|
|
314 | $done->($func->(@arg)); |
|
|
315 | }; |
|
|
316 | } |
|
|
317 | |
|
|
318 | The C<run> function creates a new thread for every invocation, using the |
|
|
319 | first argument as function name, and calls the C<$done> callback on it's |
|
|
320 | return values. This makes it quite natural to define the C<add> and C<mul> |
|
|
321 | functions to add or multiply two numbers and return the result. |
|
|
322 | |
|
|
323 | Since this is the asynchronous backend, it's quite possible to define RPC |
|
|
324 | function that do I/O or wait for external events - their execution will |
|
|
325 | overlap as needed. |
|
|
326 | |
|
|
327 | The above could be used like this: |
|
|
328 | |
|
|
329 | my $rpc = AnyEvent::Fork |
|
|
330 | ->new |
|
|
331 | ->require ("MyWorker") |
|
|
332 | ->AnyEvent::Fork::RPC::run ("My::Arith::run", |
|
|
333 | on_error => ..., on_event => ..., on_destroy => ..., |
|
|
334 | ); |
|
|
335 | |
|
|
336 | $rpc->(add => 1, 3, Coro::rouse_cb); say Coro::rouse_wait; |
|
|
337 | $rpc->(mul => 3, 2, Coro::rouse_cb); say Coro::rouse_wait; |
|
|
338 | |
|
|
339 | The C<say>'s will print C<4> and C<6>. |
|
|
340 | |
|
|
341 | =head2 Example 4: Forward AnyEvent::Log messages using C<on_event> |
|
|
342 | |
|
|
343 | This partial example shows how to use the C<event> function to forward |
|
|
344 | L<AnyEvent::Log> messages to the parent. |
|
|
345 | |
|
|
346 | For this, the parent needs to provide a suitable C<on_event>: |
|
|
347 | |
|
|
348 | ->AnyEvent::Fork::RPC::run ( |
|
|
349 | on_event => sub { |
|
|
350 | if ($_[0] eq "ae_log") { |
|
|
351 | my (undef, $level, $message) = @_; |
|
|
352 | AE::log $level, $message; |
|
|
353 | } else { |
|
|
354 | # other event types |
|
|
355 | } |
|
|
356 | }, |
|
|
357 | ) |
|
|
358 | |
|
|
359 | In the child, as early as possible, the following code should reconfigure |
|
|
360 | L<AnyEvent::Log> to log via C<AnyEvent::Fork::RPC::event>: |
|
|
361 | |
|
|
362 | $AnyEvent::Log::LOG->log_cb (sub { |
|
|
363 | my ($timestamp, $orig_ctx, $level, $message) = @{+shift}; |
|
|
364 | |
|
|
365 | if (defined &AnyEvent::Fork::RPC::event) { |
|
|
366 | AnyEvent::Fork::RPC::event (ae_log => $level, $message); |
|
|
367 | } else { |
|
|
368 | warn "[$$ before init] $message\n"; |
|
|
369 | } |
|
|
370 | }); |
|
|
371 | |
|
|
372 | There is an important twist - the C<AnyEvent::Fork::RPC::event> function |
|
|
373 | is only defined when the child is fully initialised. If you redirect the |
|
|
374 | log messages in your C<init> function for example, then the C<event> |
|
|
375 | function might not yet be available. This is why the log callback checks |
|
|
376 | whether the fucntion is there using C<defined>, and only then uses it to |
|
|
377 | log the message. |
|
|
378 | |
293 | =head1 PARENT PROCESS USAGE |
379 | =head1 PARENT PROCESS USAGE |
294 | |
380 | |
295 | This module exports nothing, and only implements a single function: |
381 | This module exports nothing, and only implements a single function: |
296 | |
382 | |
297 | =over 4 |
383 | =over 4 |
… | |
… | |
304 | |
390 | |
305 | use Errno (); |
391 | use Errno (); |
306 | use Guard (); |
392 | use Guard (); |
307 | |
393 | |
308 | use AnyEvent; |
394 | use AnyEvent; |
309 | # explicit version on next line, as some cpan-testers test with the 0.1 version, |
|
|
310 | # ignoring dependencies, and this line will at least give a clear indication of that. |
|
|
311 | use AnyEvent::Fork 0.6; # we don't actually depend on it, this is for convenience |
|
|
312 | |
395 | |
313 | our $VERSION = 1.1; |
396 | our $VERSION = 1.21; |
314 | |
397 | |
315 | =item my $rpc = AnyEvent::Fork::RPC::run $fork, $function, [key => value...] |
398 | =item my $rpc = AnyEvent::Fork::RPC::run $fork, $function, [key => value...] |
316 | |
399 | |
317 | The traditional way to call it. But it is way cooler to call it in the |
400 | The traditional way to call it. But it is way cooler to call it in the |
318 | following way: |
401 | following way: |
… | |
… | |
338 | Called on (fatal) errors, with a descriptive (hopefully) message. If |
421 | Called on (fatal) errors, with a descriptive (hopefully) message. If |
339 | this callback is not provided, but C<on_event> is, then the C<on_event> |
422 | this callback is not provided, but C<on_event> is, then the C<on_event> |
340 | callback is called with the first argument being the string C<error>, |
423 | callback is called with the first argument being the string C<error>, |
341 | followed by the error message. |
424 | followed by the error message. |
342 | |
425 | |
343 | If neither handler is provided it prints the error to STDERR and will |
426 | If neither handler is provided, then the error is reported with loglevel |
344 | start failing badly. |
427 | C<error> via C<AE::log>. |
345 | |
428 | |
346 | =item on_event => $cb->(...) |
429 | =item on_event => $cb->(...) |
347 | |
430 | |
348 | Called for every call to the C<AnyEvent::Fork::RPC::event> function in the |
431 | Called for every call to the C<AnyEvent::Fork::RPC::event> function in the |
349 | child, with the arguments of that function passed to the callback. |
432 | child, with the arguments of that function passed to the callback. |
… | |
… | |
371 | It is called very early - before the serialisers are created or the |
454 | It is called very early - before the serialisers are created or the |
372 | C<$function> name is resolved into a function reference, so it could be |
455 | C<$function> name is resolved into a function reference, so it could be |
373 | used to load any modules that provide the serialiser or function. It can |
456 | used to load any modules that provide the serialiser or function. It can |
374 | not, however, create events. |
457 | not, however, create events. |
375 | |
458 | |
|
|
459 | =item done => $function (default C<CORE::exit>) |
|
|
460 | |
|
|
461 | The function to call when the asynchronous backend detects an end of file |
|
|
462 | condition when reading from the communications socket I<and> there are no |
|
|
463 | outstanding requests. It's ignored by the synchronous backend. |
|
|
464 | |
|
|
465 | By overriding this you can prolong the life of a RPC process after e.g. |
|
|
466 | the 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 |
|
|
468 | could provide L<EV::loop> as C<done> function). |
|
|
469 | |
|
|
470 | Of course, in that case you are responsible for exiting at the appropriate |
|
|
471 | time and not returning from |
|
|
472 | |
376 | =item async => $boolean (default: 0) |
473 | =item async => $boolean (default: 0) |
377 | |
474 | |
378 | The default server used in the child does all I/O blockingly, and only |
475 | The default server used in the child does all I/O blockingly, and only |
379 | allows a single RPC call to execute concurrently. |
476 | allows a single RPC call to execute concurrently. |
380 | |
477 | |
… | |
… | |
418 | =over 4 |
515 | =over 4 |
419 | |
516 | |
420 | =item octet strings - C<$AnyEvent::Fork::RPC::STRING_SERIALISER> |
517 | =item octet strings - C<$AnyEvent::Fork::RPC::STRING_SERIALISER> |
421 | |
518 | |
422 | This serialiser concatenates length-prefixes octet strings, and is the |
519 | This serialiser concatenates length-prefixes octet strings, and is the |
423 | default. |
520 | default. That means you can only pass (and return) strings containing |
|
|
521 | character codes 0-255. |
424 | |
522 | |
425 | Implementation: |
523 | Implementation: |
426 | |
524 | |
427 | ( |
525 | ( |
428 | sub { pack "(w/a*)*", @_ }, |
526 | sub { pack "(w/a*)*", @_ }, |
429 | sub { unpack "(w/a*)*", shift } |
527 | sub { unpack "(w/a*)*", shift } |
|
|
528 | ) |
|
|
529 | |
|
|
530 | =item json - C<$AnyEvent::Fork::RPC::CBOR_XS_SERIALISER> |
|
|
531 | |
|
|
532 | This serialiser creates CBOR::XS arrays - you have to make sure the |
|
|
533 | L<CBOR::XS> module is installed for this serialiser to work. It can be |
|
|
534 | beneficial for sharing when you preload the L<CBOR::XS> module in a template |
|
|
535 | process. |
|
|
536 | |
|
|
537 | L<CBOR::XS> is about as fast as the octet string serialiser, but supports |
|
|
538 | complex data structures (similar to JSON) and is faster than any of the |
|
|
539 | other serialisers. If you have the L<CBOR::XS> module available, it's the |
|
|
540 | best choice. |
|
|
541 | |
|
|
542 | Note that the CBOR::XS module supports some extensions to encode cyclic |
|
|
543 | and self-referencing data structures, which are not enabled. You need to |
|
|
544 | write your own serialiser to take advantage of these. |
|
|
545 | |
|
|
546 | Implementation: |
|
|
547 | |
|
|
548 | use CBOR::XS (); |
|
|
549 | ( |
|
|
550 | sub { CBOR::XS::encode_cbor \@_ }, |
|
|
551 | sub { @{ CBOR::XS::decode_cbor shift } } |
430 | ) |
552 | ) |
431 | |
553 | |
432 | =item json - C<$AnyEvent::Fork::RPC::JSON_SERIALISER> |
554 | =item json - C<$AnyEvent::Fork::RPC::JSON_SERIALISER> |
433 | |
555 | |
434 | This serialiser creates JSON arrays - you have to make sure the L<JSON> |
556 | This serialiser creates JSON arrays - you have to make sure the L<JSON> |
… | |
… | |
449 | |
571 | |
450 | =item storable - C<$AnyEvent::Fork::RPC::STORABLE_SERIALISER> |
572 | =item storable - C<$AnyEvent::Fork::RPC::STORABLE_SERIALISER> |
451 | |
573 | |
452 | This serialiser uses L<Storable>, which means it has high chance of |
574 | This serialiser uses L<Storable>, which means it has high chance of |
453 | serialising just about anything you throw at it, at the cost of having |
575 | serialising just about anything you throw at it, at the cost of having |
454 | very high overhead per operation. It also comes with perl. |
576 | very high overhead per operation. It also comes with perl. It should be |
|
|
577 | used when you need to serialise complex data structures. |
455 | |
578 | |
456 | Implementation: |
579 | Implementation: |
457 | |
580 | |
458 | use Storable (); |
581 | use Storable (); |
459 | ( |
582 | ( |
460 | sub { Storable::freeze \@_ }, |
583 | sub { Storable::freeze \@_ }, |
461 | sub { @{ Storable::thaw shift } } |
584 | sub { @{ Storable::thaw shift } } |
462 | ) |
585 | ) |
463 | |
586 | |
|
|
587 | =item portable storable - C<$AnyEvent::Fork::RPC::NSTORABLE_SERIALISER> |
|
|
588 | |
|
|
589 | This serialiser also uses L<Storable>, but uses it's "network" format |
|
|
590 | to serialise data, which makes it possible to talk to different |
|
|
591 | perl binaries (for example, when talking to a process created with |
|
|
592 | L<AnyEvent::Fork::Remote>). |
|
|
593 | |
|
|
594 | Implementation: |
|
|
595 | |
|
|
596 | use Storable (); |
|
|
597 | ( |
|
|
598 | sub { Storable::nfreeze \@_ }, |
|
|
599 | sub { @{ Storable::thaw shift } } |
|
|
600 | ) |
|
|
601 | |
464 | =back |
602 | =back |
465 | |
603 | |
466 | =back |
604 | =back |
467 | |
605 | |
468 | See the examples section earlier in this document for some actual |
606 | See the examples section earlier in this document for some actual |
469 | examples. |
607 | examples. |
470 | |
608 | |
471 | =cut |
609 | =cut |
472 | |
610 | |
473 | our $STRING_SERIALISER = '(sub { pack "(w/a*)*", @_ }, sub { unpack "(w/a*)*", shift })'; |
611 | our $STRING_SERIALISER = '(sub { pack "(w/a*)*", @_ }, sub { unpack "(w/a*)*", shift })'; |
|
|
612 | our $CBOR_XS_SERIALISER = 'use CBOR::XS (); (sub { CBOR::XS::encode_cbor \@_ }, sub { @{ CBOR::XS::decode_cbor shift } })'; |
474 | our $JSON_SERIALISER = 'use JSON (); (sub { JSON::encode_json \@_ }, sub { @{ JSON::decode_json shift } })'; |
613 | our $JSON_SERIALISER = 'use JSON (); (sub { JSON::encode_json \@_ }, sub { @{ JSON::decode_json shift } })'; |
475 | our $STORABLE_SERIALISER = 'use Storable (); (sub { Storable::freeze \@_ }, sub { @{ Storable::thaw shift } })'; |
614 | our $STORABLE_SERIALISER = 'use Storable (); (sub { Storable::freeze \@_ }, sub { @{ Storable::thaw shift } })'; |
|
|
615 | our $NSTORABLE_SERIALISER = 'use Storable (); (sub { Storable::nfreeze \@_ }, sub { @{ Storable::thaw shift } })'; |
476 | |
616 | |
477 | sub run { |
617 | sub run { |
478 | my ($self, $function, %arg) = @_; |
618 | my ($self, $function, %arg) = @_; |
479 | |
619 | |
480 | my $serialiser = delete $arg{serialiser} || $STRING_SERIALISER; |
620 | my $serialiser = delete $arg{serialiser} || $STRING_SERIALISER; |
… | |
… | |
483 | my $on_destroy = delete $arg{on_destroy}; |
623 | my $on_destroy = delete $arg{on_destroy}; |
484 | |
624 | |
485 | # default for on_error is to on_event, if specified |
625 | # default for on_error is to on_event, if specified |
486 | $on_error ||= $on_event |
626 | $on_error ||= $on_event |
487 | ? sub { $on_event->(error => shift) } |
627 | ? sub { $on_event->(error => shift) } |
488 | : sub { die "AnyEvent::Fork::RPC: uncaught error: $_[0].\n" }; |
628 | : sub { AE::log die => "AnyEvent::Fork::RPC: uncaught error: $_[0]." }; |
489 | |
629 | |
490 | # default for on_event is to raise an error |
630 | # default for on_event is to raise an error |
491 | $on_event ||= sub { $on_error->("event received, but no on_event handler") }; |
631 | $on_event ||= sub { $on_error->("event received, but no on_event handler") }; |
492 | |
632 | |
493 | my ($f, $t) = eval $serialiser; die $@ if $@; |
633 | my ($f, $t) = eval $serialiser; die $@ if $@; |
… | |
… | |
514 | }; |
654 | }; |
515 | |
655 | |
516 | my $module = "AnyEvent::Fork::RPC::" . ($arg{async} ? "Async" : "Sync"); |
656 | my $module = "AnyEvent::Fork::RPC::" . ($arg{async} ? "Async" : "Sync"); |
517 | |
657 | |
518 | $self->require ($module) |
658 | $self->require ($module) |
519 | ->send_arg ($function, $arg{init}, $serialiser) |
659 | ->send_arg ($function, $arg{init}, $serialiser, $arg{done} || "$module\::do_exit") |
520 | ->run ("$module\::run", sub { |
660 | ->run ("$module\::run", sub { |
521 | $fh = shift; |
661 | $fh = shift; |
522 | |
662 | |
523 | my ($id, $len); |
663 | my ($id, $len); |
524 | $rw = AE::io $fh, 0, sub { |
664 | $rw = AE::io $fh, 0, sub { |
… | |
… | |
640 | See the examples section earlier in this document for some actual |
780 | See the examples section earlier in this document for some actual |
641 | examples. |
781 | examples. |
642 | |
782 | |
643 | =back |
783 | =back |
644 | |
784 | |
|
|
785 | =head2 PROCESS EXIT |
|
|
786 | |
|
|
787 | If and when the child process exits depends on the backend and |
|
|
788 | configuration. Apart from explicit exits (e.g. by calling C<exit>) or |
|
|
789 | runtime conditions (uncaught exceptions, signals etc.), the backends exit |
|
|
790 | under these conditions: |
|
|
791 | |
|
|
792 | =over 4 |
|
|
793 | |
|
|
794 | =item Synchronous Backend |
|
|
795 | |
|
|
796 | The synchronous backend is very simple: when the process waits for another |
|
|
797 | request to arrive and the writing side (usually in the parent) is closed, |
|
|
798 | it will exit normally, i.e. as if your main program reached the end of the |
|
|
799 | file. |
|
|
800 | |
|
|
801 | That means that if your parent process exits, the RPC process will usually |
|
|
802 | exit as well, either because it is idle anyway, or because it executes a |
|
|
803 | request. In the latter case, you will likely get an error when the RPc |
|
|
804 | process tries to send the results to the parent (because agruably, you |
|
|
805 | shouldn't exit your parent while there are still outstanding requests). |
|
|
806 | |
|
|
807 | The process is usually quiescent when it happens, so it should rarely be a |
|
|
808 | problem, and C<END> handlers can be used to clean up. |
|
|
809 | |
|
|
810 | =item Asynchronous Backend |
|
|
811 | |
|
|
812 | For the asynchronous backend, things are more complicated: Whenever it |
|
|
813 | listens for another request by the parent, it might detect that the socket |
|
|
814 | was closed (e.g. because the parent exited). It will sotp listening for |
|
|
815 | new requests and instead try to write out any remaining data (if any) or |
|
|
816 | simply check whether the socket can be written to. After this, the RPC |
|
|
817 | process is effectively done - no new requests are incoming, no outstanding |
|
|
818 | request data can be written back. |
|
|
819 | |
|
|
820 | Since chances are high that there are event watchers that the RPC server |
|
|
821 | knows nothing about (why else would one use the async backend if not for |
|
|
822 | the ability to register watchers?), the event loop would often happily |
|
|
823 | continue. |
|
|
824 | |
|
|
825 | This is why the asynchronous backend explicitly calls C<CORE::exit> when |
|
|
826 | it is done (under other circumstances, such as when there is an I/O error |
|
|
827 | and there is outstanding data to write, it will log a fatal message via |
|
|
828 | L<AnyEvent::Log>, also causing the program to exit). |
|
|
829 | |
|
|
830 | You can override this by specifying a function name to call via the C<done> |
|
|
831 | parameter instead. |
|
|
832 | |
|
|
833 | =back |
|
|
834 | |
645 | =head1 ADVANCED TOPICS |
835 | =head1 ADVANCED TOPICS |
646 | |
836 | |
647 | =head2 Choosing a backend |
837 | =head2 Choosing a backend |
648 | |
838 | |
649 | So how do you decide which backend to use? Well, that's your problem to |
839 | So how do you decide which backend to use? Well, that's your problem to |
… | |
… | |
729 | half it has passed earlier. |
919 | half it has passed earlier. |
730 | |
920 | |
731 | Here is some (untested) pseudocode to that effect: |
921 | Here is some (untested) pseudocode to that effect: |
732 | |
922 | |
733 | use AnyEvent::Util; |
923 | use AnyEvent::Util; |
|
|
924 | use AnyEvent::Fork; |
734 | use AnyEvent::Fork::RPC; |
925 | use AnyEvent::Fork::RPC; |
735 | use IO::FDPass; |
926 | use IO::FDPass; |
736 | |
927 | |
737 | my ($s1, $s2) = AnyEvent::Util::portable_socketpair; |
928 | my ($s1, $s2) = AnyEvent::Util::portable_socketpair; |
738 | |
929 | |
… | |
… | |
785 | |
976 | |
786 | =head1 SEE ALSO |
977 | =head1 SEE ALSO |
787 | |
978 | |
788 | L<AnyEvent::Fork>, to create the processes in the first place. |
979 | L<AnyEvent::Fork>, to create the processes in the first place. |
789 | |
980 | |
790 | L<AnyEvent::Fork::Remote>, like above, but helpful for remote processes. |
981 | L<AnyEvent::Fork::Remote>, likewise, but helpful for remote processes. |
791 | |
982 | |
792 | L<AnyEvent::Fork::Pool>, to manage whole pools of processes. |
983 | L<AnyEvent::Fork::Pool>, to manage whole pools of processes. |
793 | |
984 | |
794 | =head1 AUTHOR AND CONTACT INFORMATION |
985 | =head1 AUTHOR AND CONTACT INFORMATION |
795 | |
986 | |