dpid.h(3)							     libdaemon								 dpid.h(3)

NAME

       dpid.h -

       Contains an API for manipulating PID files.

SYNOPSIS

       #include <sys/types.h>

   Defines
       #define DAEMON_PID_FILE_KILL_WAIT_AVAILABLE   1
	   This variable is defined to 1 iff daemon_pid_file_kill_wait() is supported.

   Typedefs
       typedef const char *(* daemon_pid_file_proc_t )(void)
	   Prototype of a function for generating the name of a PID file.

   Functions
       const char * daemon_pid_file_proc_default (void)
	   A function for creating a pid file name from daemon_pid_file_ident.
       int daemon_pid_file_create (void)
	   Creates PID pid file for the current process.
       int daemon_pid_file_remove (void)
	   Removes the PID file of the current process.
       pid_t daemon_pid_file_is_running (void)
	   Returns the PID file of a running daemon, if available.
       int daemon_pid_file_kill (int s)
	   Kills a running daemon, if available.
       int daemon_pid_file_kill_wait (int s, int m)
	   Similar to daemon_pid_file_kill() but waits until the process died.

   Variables
       const char * daemon_pid_file_ident
	   Identification string for the PID file name, only used when daemon_pid_file_proc is set to daemon_pid_file_proc_default().
       daemon_pid_file_proc_t daemon_pid_file_proc
	   A function pointer which is used to generate the name of the PID file to manipulate.

Detailed Description
       Contains an API for manipulating PID files.

       Definition in file dpid.h.

Define Documentation
   #define DAEMON_PID_FILE_KILL_WAIT_AVAILABLE	 1
       This variable is defined to 1 iff daemon_pid_file_kill_wait() is supported. Since:
	   0.3

       See also:
	   daemon_pid_file_kill_wait()

       Definition at line 82 of file dpid.h.

Typedef Documentation
   typedef const char*(* daemon_pid_file_proc_t)(void)
       Prototype of a function for generating the name of a PID file.

       Definition at line 37 of file dpid.h.

Function Documentation
   int daemon_pid_file_create (void)
       Creates PID pid file for the current process. Returns:
	   zero on success, nonzero on failure

       Examples:
	   testd.c.

   pid_t daemon_pid_file_is_running (void)
       Returns the PID file of a running daemon, if available. Returns:
	   The PID or negative on failure

       Examples:
	   testd.c.

   int daemon_pid_file_kill (int s)
       Kills a running daemon, if available. Parameters:
	   s The signal to send

       Returns:
	   zero on success, nonzero on failure

   int daemon_pid_file_kill_wait (int s, int m)
       Similar to daemon_pid_file_kill() but waits until the process died. This functions is new in libdaemon 0.3. The macro
       DAEMON_PID_FILE_KILL_WAIT_AVAILABLE is defined iff libdaemon supports this function.

       Parameters:
	   s The signal to send
	   m Seconds to wait at maximum

       Returns:
	   zero on success, nonzero on failure (timeout condition is considered a failure)

       Since:
	   0.3

       See also:
	   DAEMON_PID_FILE_KILL_WAIT_AVAILABLE

       Examples:
	   testd.c.

   const char* daemon_pid_file_proc_default (void)
       A function for creating a pid file name from daemon_pid_file_ident. Returns:
	   The PID file path

   int daemon_pid_file_remove (void)
       Removes the PID file of the current process. Returns:
	   zero on success, nonzero on failure

       Examples:
	   testd.c.

Variable Documentation
   const char* daemon_pid_file_ident
       Identification string for the PID file name, only used when daemon_pid_file_proc is set to daemon_pid_file_proc_default(). Use
       daemon_ident_from_argv0() to generate an identification string from argv[0]

       Examples:
	   testd.c.

   daemon_pid_file_proc_t daemon_pid_file_proc
       A function pointer which is used to generate the name of the PID file to manipulate. Points to daemon_pid_file_proc_default() by default.

Author
       Generated automatically by Doxygen for libdaemon from the source code.

Version 0.14							    17 Jan 2010 							 dpid.h(3)