… | |
… | |
38 | |
38 | |
39 | If you need some form of RPC, you could use the L<AnyEvent::Fork::RPC> |
39 | If you need some form of RPC, you could use the L<AnyEvent::Fork::RPC> |
40 | companion module, which adds simple RPC/job queueing to a process created |
40 | companion module, which adds simple RPC/job queueing to a process created |
41 | by this module. |
41 | by this module. |
42 | |
42 | |
|
|
43 | And if you need some automatic process pool management on top of |
|
|
44 | L<AnyEvent::Fork::RPC>, you can look at the L<AnyEvent::Fork::Pool> |
|
|
45 | companion module. |
|
|
46 | |
43 | Or you can implement it yourself in whatever way you like, use some |
47 | Or you can implement it yourself in whatever way you like: use some |
44 | message-passing module such as L<AnyEvent::MP>, some pipe such as |
48 | message-passing module such as L<AnyEvent::MP>, some pipe such as |
45 | L<AnyEvent::ZeroMQ>, use L<AnyEvent::Handle> on both sides to send |
49 | L<AnyEvent::ZeroMQ>, use L<AnyEvent::Handle> on both sides to send |
46 | e.g. JSON or Storable messages, and so on. |
50 | e.g. JSON or Storable messages, and so on. |
47 | |
51 | |
48 | =head2 COMPARISON TO OTHER MODULES |
52 | =head2 COMPARISON TO OTHER MODULES |
… | |
… | |
250 | ->send_arg ("/bin/echo", "hi") |
254 | ->send_arg ("/bin/echo", "hi") |
251 | ->run ("run", my $cv = AE::cv); |
255 | ->run ("run", my $cv = AE::cv); |
252 | |
256 | |
253 | my $stderr = $cv->recv; |
257 | my $stderr = $cv->recv; |
254 | |
258 | |
|
|
259 | =head2 For stingy users: put the worker code into a C<DATA> section. |
|
|
260 | |
|
|
261 | When you want to be stingy with files, you cna put your code into the |
|
|
262 | C<DATA> section of your module (or program): |
|
|
263 | |
|
|
264 | use AnyEvent::Fork; |
|
|
265 | |
|
|
266 | AnyEvent::Fork |
|
|
267 | ->new |
|
|
268 | ->eval (do { local $/; <DATA> }) |
|
|
269 | ->run ("doit", sub { ... }); |
|
|
270 | |
|
|
271 | __DATA__ |
|
|
272 | |
|
|
273 | sub doit { |
|
|
274 | ... do something! |
|
|
275 | } |
|
|
276 | |
|
|
277 | =head2 For stingy standalone programs: do not rely on external files at |
|
|
278 | all. |
|
|
279 | |
|
|
280 | For single-file scripts it can be inconvenient to rely on external |
|
|
281 | files - even when using < C<DATA> section, you still need to C<exec> |
|
|
282 | an external perl interpreter, which might not be available when using |
|
|
283 | L<App::Staticperl>, L<Urlader> or L<PAR::Packer> for example. |
|
|
284 | |
|
|
285 | Two modules help here - L<AnyEvent::Fork::Early> forks a template process |
|
|
286 | for all further calls to C<new_exec>, and L<AnyEvent::Fork::Template> |
|
|
287 | forks the main program as a template process. |
|
|
288 | |
|
|
289 | Here is how your main program should look like: |
|
|
290 | |
|
|
291 | #! perl |
|
|
292 | |
|
|
293 | # optional, as the very first thing. |
|
|
294 | # in case modules want to create their own processes. |
|
|
295 | use AnyEvent::Fork::Early; |
|
|
296 | |
|
|
297 | # next, load all modules you need in your template process |
|
|
298 | use Example::My::Module |
|
|
299 | use Example::Whatever; |
|
|
300 | |
|
|
301 | # next, put your run function definition and anything else you |
|
|
302 | # need, but do not use code outside of BEGIN blocks. |
|
|
303 | sub worker_run { |
|
|
304 | my ($fh, @args) = @_; |
|
|
305 | ... |
|
|
306 | } |
|
|
307 | |
|
|
308 | # now preserve everything so far as AnyEvent::Fork object |
|
|
309 | # in §TEMPLATE. |
|
|
310 | use AnyEvent::Fork::Template; |
|
|
311 | |
|
|
312 | # do not put code outside of BEGIN blocks until here |
|
|
313 | |
|
|
314 | # now use the $TEMPLATE process in any way you like |
|
|
315 | |
|
|
316 | # for example: create 10 worker processes |
|
|
317 | my @worker; |
|
|
318 | my $cv = AE::cv; |
|
|
319 | for (1..10) { |
|
|
320 | $cv->begin; |
|
|
321 | $TEMPLATE->fork->send_arg ($_)->run ("worker_run", sub { |
|
|
322 | push @worker, shift; |
|
|
323 | $cv->end; |
|
|
324 | }); |
|
|
325 | } |
|
|
326 | $cv->recv; |
|
|
327 | |
255 | =head1 CONCEPTS |
328 | =head1 CONCEPTS |
256 | |
329 | |
257 | This module can create new processes either by executing a new perl |
330 | This module can create new processes either by executing a new perl |
258 | process, or by forking from an existing "template" process. |
331 | process, or by forking from an existing "template" process. |
259 | |
332 | |
… | |
… | |
377 | use AnyEvent; |
450 | use AnyEvent; |
378 | use AnyEvent::Util (); |
451 | use AnyEvent::Util (); |
379 | |
452 | |
380 | use IO::FDPass; |
453 | use IO::FDPass; |
381 | |
454 | |
382 | our $VERSION = 0.7; |
455 | our $VERSION = 1.1; |
383 | |
456 | |
384 | # the early fork template process |
457 | # the early fork template process |
385 | our $EARLY; |
458 | our $EARLY; |
386 | |
459 | |
387 | # the empty template process |
460 | # the empty template process |
… | |
… | |
536 | The path to the perl interpreter is divined using various methods - first |
609 | The path to the perl interpreter is divined using various methods - first |
537 | C<$^X> is investigated to see if the path ends with something that sounds |
610 | C<$^X> is investigated to see if the path ends with something that sounds |
538 | as if it were the perl interpreter. Failing this, the module falls back to |
611 | as if it were the perl interpreter. Failing this, the module falls back to |
539 | using C<$Config::Config{perlpath}>. |
612 | using C<$Config::Config{perlpath}>. |
540 | |
613 | |
|
|
614 | The path to perl can also be overriden by setting the global variable |
|
|
615 | C<$AnyEvent::Fork::PERL> - it's value will be used for all subsequent |
|
|
616 | invocations. |
|
|
617 | |
541 | =cut |
618 | =cut |
|
|
619 | |
|
|
620 | our $PERL; |
542 | |
621 | |
543 | sub new_exec { |
622 | sub new_exec { |
544 | my ($self) = @_; |
623 | my ($self) = @_; |
545 | |
624 | |
546 | return $EARLY->fork |
625 | return $EARLY->fork |
547 | if $EARLY; |
626 | if $EARLY; |
548 | |
627 | |
|
|
628 | unless (defined $PERL) { |
549 | # first find path of perl |
629 | # first find path of perl |
550 | my $perl = $; |
630 | my $perl = $; |
551 | |
631 | |
552 | # first we try $^X, but the path must be absolute (always on win32), and end in sth. |
632 | # first we try $^X, but the path must be absolute (always on win32), and end in sth. |
553 | # that looks like perl. this obviously only works for posix and win32 |
633 | # that looks like perl. this obviously only works for posix and win32 |
554 | unless ( |
634 | unless ( |
555 | ($^O eq "MSWin32" || $perl =~ m%^/%) |
635 | ($^O eq "MSWin32" || $perl =~ m%^/%) |
556 | && $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i |
636 | && $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i |
557 | ) { |
637 | ) { |
558 | # if it doesn't look perlish enough, try Config |
638 | # if it doesn't look perlish enough, try Config |
559 | require Config; |
639 | require Config; |
560 | $perl = $Config::Config{perlpath}; |
640 | $perl = $Config::Config{perlpath}; |
561 | $perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/; |
641 | $perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/; |
|
|
642 | } |
|
|
643 | |
|
|
644 | $PERL = $perl; |
562 | } |
645 | } |
563 | |
646 | |
564 | require Proc::FastSpawn; |
647 | require Proc::FastSpawn; |
565 | |
648 | |
566 | my ($fh, $slave) = AnyEvent::Util::portable_socketpair; |
649 | my ($fh, $slave) = AnyEvent::Util::portable_socketpair; |
… | |
… | |
574 | #local $ENV{PERL5LIB} = join ":", grep !ref, @INC; |
657 | #local $ENV{PERL5LIB} = join ":", grep !ref, @INC; |
575 | my %env = %ENV; |
658 | my %env = %ENV; |
576 | $env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC; |
659 | $env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC; |
577 | |
660 | |
578 | my $pid = Proc::FastSpawn::spawn ( |
661 | my $pid = Proc::FastSpawn::spawn ( |
579 | $perl, |
662 | $PERL, |
580 | ["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$], |
663 | ["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$], |
581 | [map "$_=$env{$_}", keys %env], |
664 | [map "$_=$env{$_}", keys %env], |
582 | ) or die "unable to spawn AnyEvent::Fork server: $!"; |
665 | ) or die "unable to spawn AnyEvent::Fork server: $!"; |
583 | |
666 | |
584 | $self->_new ($fh, $pid) |
667 | $self->_new ($fh, $pid) |
… | |
… | |
774 | |
857 | |
775 | $self->[CB] = $cb; |
858 | $self->[CB] = $cb; |
776 | $self->_cmd (r => $func); |
859 | $self->_cmd (r => $func); |
777 | } |
860 | } |
778 | |
861 | |
|
|
862 | =back |
|
|
863 | |
|
|
864 | =head2 EXPERIMENTAL METHODS |
|
|
865 | |
|
|
866 | These methods might go away completely or change behaviour, at any time. |
|
|
867 | |
|
|
868 | =over 4 |
|
|
869 | |
779 | =item $proc->to_fh ($cb->($fh)) # EXPERIMENTAL, MIGHT BE REMOVED |
870 | =item $proc->to_fh ($cb->($fh)) # EXPERIMENTAL, MIGHT BE REMOVED |
780 | |
871 | |
781 | Flushes all commands out to the process and then calls the callback with |
872 | Flushes all commands out to the process and then calls the callback with |
782 | the communications socket. |
873 | the communications socket. |
783 | |
874 | |
784 | The process object becomes unusable on return from this function - any |
875 | The process object becomes unusable on return from this function - any |
785 | further method calls result in undefined behaviour. |
876 | further method calls result in undefined behaviour. |
786 | |
877 | |
787 | The point of this method is to give you a file handle thta you cna pass |
878 | The point of this method is to give you a file handle thta you cna pass |
788 | to another process. In that other process, you can call C<new_from_fh |
879 | to another process. In that other process, you can call C<new_from_fh |
789 | AnyEvent::Fork::RPC> to create a new C<AnyEvent::Fork> object from it, |
880 | AnyEvent::Fork> to create a new C<AnyEvent::Fork> object from it, thereby |
790 | thereby effectively passing a fork object to another process. |
881 | effectively passing a fork object to another process. |
791 | |
882 | |
792 | =cut |
883 | =cut |
793 | |
884 | |
794 | sub to_fh { |
885 | sub to_fh { |
795 | my ($self, $cb) = @_; |
886 | my ($self, $cb) = @_; |
… | |
… | |
972 | L<AnyEvent::Fork::Template>, to create a process by forking the main |
1063 | L<AnyEvent::Fork::Template>, to create a process by forking the main |
973 | program at a convenient time (part of this distribution). |
1064 | program at a convenient time (part of this distribution). |
974 | |
1065 | |
975 | L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN). |
1066 | L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN). |
976 | |
1067 | |
|
|
1068 | L<AnyEvent::Fork::Pool>, for simple worker process pool (on CPAN). |
|
|
1069 | |
977 | =head1 AUTHOR AND CONTACT INFORMATION |
1070 | =head1 AUTHOR AND CONTACT INFORMATION |
978 | |
1071 | |
979 | Marc Lehmann <schmorp@schmorp.de> |
1072 | Marc Lehmann <schmorp@schmorp.de> |
980 | http://software.schmorp.de/pkg/AnyEvent-Fork |
1073 | http://software.schmorp.de/pkg/AnyEvent-Fork |
981 | |
1074 | |