View on
MetaCPAN
Detlef Pilzecker > Proc-Daemon-0.05 > Proc::Daemon

Download:
Proc/Proc-Daemon-0.05.tar.gz

Dependencies

Annotate this POD (1)

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source   Latest Release: Proc-Daemon-0.23

NAME ^

Proc::Daemon - Run Perl program(s) as a daemon process

SYNOPSIS ^

    use Proc::Daemon;

    $daemon = Proc::Daemon->new(
        work_dir => '/my/daemon/directory',
        .....
    );

    $Kid_PID = $daemon->Init;

    unless ( $Kid_PID ) {
        # code executed only by the child ...
    }

    $Kid_PID2 = $daemon->Init( { 
                    work_dir     => '/other/daemon/directory',
                    exec_command => 'perl /home/my_script.pl',
                } );

    $pid = $daemon->Status( ... );

    $stopped = $daemon->Kill_Daemon( ... );

DESCRIPTION ^

This module can be used by a Perl program to initialize itself as a daemon or to execute (exec) a system command as daemon. You can also check the status of the daemon (alive or dead) and you can kill the daemon.

A daemon is a process that runs in the background with no controlling terminal. Generally servers (like FTP, HTTP and SIP servers) run as daemon processes. Do not make the mistake to think that a daemon is a server. ;-)

Proc::Daemon does the following:

  1. The script forks a child.
  2. The forked child becomes a session leader, which detaches the program from the controlling terminal.
  3. This child forks another child (the final daemon process). This prevents the potential of acquiring a controlling terminal at all.
  4. The second child changes the current working directory to the value of 'work_dir'.
  5. The second child clears the file creation mask.
  6. The second child closes all open file descriptors.
  7. The second child opens STDIN, STDOUT and STDERR to the location defined in the constructor (new).
  8. The second child returns to the first process (grandparent), or the program defined in 'exec_command' is executed and the second child never returns.
  9. The first child transfers the PID of the second child (daemon) to the parent and exits. Additionally the PID of the daemon process can be written into a file if 'pid_file' is defined.

CONSTRUCTOR ^

new ( %ARGS )

The constructor creates a new Proc::Daemon object based on the hash %ARGS. The following keys from %ARGS are used:

work_dir

Defines the path to the daemon working directory. Defaults to /.

child_STDIN

Defines the path to STDIN of your daemon. Defaults to /dev/null.

child_STDOUT

Defines the path where the output of your daemon will go. Defaults to *\STDIN.

child_STDERR

Defines the path where the error output of your daemon will go. Defaults to *\STDIN.

pid_file

Defines the path to the file where the PID of the child process is stored. Defaults to undef (= write no file).

exec_command

Scalar (or arrayref) with system command(s) that will be executed by the daemon via Perls exec PROGRAM_LIST. In this case the child will never return to the parents process!

Example:

    my $daemon = Proc::Daemon->new(
        work_dir     => '/working/daemon/directory',
        child_STDOUT => '/path/to/daemon/output.file',
        child_STDERR => 'debug.txt',
        pid_file     => 'pid.txt',
        exec_command => 'perl /home/my_script.pl',
      # or
      # exec_command => [ 'perl /home/my_script.pl', 'perl /home/my_other_script.pl' ],
    );

In this example:

  • the PID of the daemon will be returned into $daemon of the parent process and a pid-file will be created at /working/daemon/directory/pid.txt
  • all STDOUT of the daemon will go to /path/to/daemon/output.file and all STDERR will go to /working/daemon/directory/debug.txt
  • the script /home/my_script.pl will be executed by perl and run as daemon. Therefore the child process will never return to this parent script.

METHODS ^

Init( [ { %ARGS } ] )

Become a daemon.

If used for the first time after new, you call Init with the object reference to start the daemon.

    $pid = $daemon->Init();

If you want to use the object reference created by new for other daemons, you write Init( { %ARGS } ). The argument must be a hashref. %ARGS are the same as described in new. Notice that you shouldn't call Init(), or this next daemon will do and write all in the same files as the first daemon. At least use an empty anonymous hash.

    $pid = $daemon->Init( {} );
    @pid = $daemon->Init( {
        work_dir     => '/other/daemon/directory',
        exec_command => [ 'perl /home/my_second_script.pl', 'perl /home/my_third_script.pl' ],
    } );

If you don't need the Proc::Daemon object reference in your script, you can also use the method without object reference:

    $pid = Proc::Daemon::Init( [ { %ARGS } ] );

If you call the Init method in the context without looking for a return value (void context) the parent process will exit here like in earlier versions:

    Proc::Daemon::Init;
Status( [ $ARG ] )

This function checks the status of the process (daemon). Returns the PID number (alive) or 0 (dead).

$ARG can be a string with:

  • undef, in this case it tries to get the PID to check out of the object reference settings.
  • a PID number to check.
  • the path to a file containing the PID to check.
  • the command line entry of the running program to check. This requires Proc::ProcessTable to be installed.
Kill_Daemon( [ $ARG ] )

This function kills the Daemon process. Returns the number of processes successfully killed (which mostly is not the same as the PID number), or 0 if the process wasn't found.

$ARG is the same as of Status().

Fork

Is like the Perl built-in fork, but it retries to fork over 30 seconds if necessary and if possible to fork at all. It returns the child PID to the parent process and 0 to the child process. If the fork is unsuccessful it warns and returns undef.

OTHER METHODS ^

Proc::Daemon also defines some other functions. See source code for more details:

OpenMax( [ $NUMBER ] )

Returns the maximum file descriptor number. If undetermined, $NUMBER (if undefined: 64) will be returned.

adjust_settings

Does some fixes/adjustments on the new settings together with fix_filename.

fix_filename( $KEYNAME )

Prevents double use of same filename in different processes.

get_pid( [ $STRING ] )

Returns the wanted PID if it can be found.

get_pid_by_proc_table_attr( $ATTR, $MATCH )

Returns the wanted PID by looking into the process table, or undef. Requires the Proc::ProcessTable module to be installed.

NOTES ^

Proc::Daemon::init is still available for backwards capability.

AUTHORS ^

Primary-maintainer and code writer until version 0.03:

Co-maintainer and code writer since version 0.04:

CREDITS ^

Initial implementation of Proc::Daemon derived from the following sources:

PREREQUISITES ^

This module requires the POSIX module to be installed.

The Proc::ProcessTable module is not essentially required but it can be usefull if it is installed (see above).

SEE ALSO ^

perl(1), POSIX, Proc::ProcessTable

COPYRIGHT ^

This module is Copyright (C) 1997-2010 by Earl Hood and Detlef Pilzecker.

All Rights Reserved.

This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

syntax highlighting: