System.Process.PID1

Documentation

data RunOptions

Holder for pid1 run options

Instances

Show RunOptions

Methods

showsPrec :: Int -> RunOptions -> ShowS

show :: RunOptions -> String

showList :: [RunOptions] -> ShowS

defaultRunOptions :: RunOptions

return default RunOptions

Since: 0.1.1.0

getRunEnv :: RunOptions -> Maybe [(String, String)]

Get environment variable overrides for the given RunOptions

Since: 0.1.1.0

getRunExitTimeoutSec :: RunOptions -> Int

Return the timeout (in seconds) timeout (in seconds) to wait for all child processes to exit after receiving SIGTERM or SIGINT signal

Since: 0.1.2.0

getRunGroup :: RunOptions -> Maybe String

Get the process setGroupID group for the given RunOptions

Since: 0.1.1.0

getRunUser :: RunOptions -> Maybe String

Get the process setUserID user for the given RunOptions

Since: 0.1.1.0

getRunWorkDir :: RunOptions -> Maybe FilePath

Get the process current directory for the given RunOptions

Since: 0.1.1.0

run

Arguments

:: FilePath

command to run

-> [String]

command line arguments

-> Maybe [(String, String)]

optional environment variable override, default is current env

-> IO a

Run the given command with specified arguments, with optional environment variable override (default is to use the current process's environment).

This function will check if the current process has a process ID of 1. If it does, it will install signal handlers for SIGTERM and SIGINT, set up a loop to reap all orphans, spawn a child process, and when that child dies, kill all other processes (first with a SIGTERM and then a SIGKILL) and exit with the child's exit code.

If this process is not PID1, then it will simply exec the given command.

This function will never exit: it will always terminate your process, unless some exception is thrown.

Since: 0.1.0.0

runWithOptions

Arguments

:: RunOptions

run options

-> FilePath

command to run

-> [String]

command line arguments

-> IO a

Variant of run that runs a command, with optional environment posix user/group and working directory (default is to use the current process's user, group, environment, and current directory).

Since: 0.1.1.0

setRunEnv :: [(String, String)] -> RunOptions -> RunOptions

Set environment variable overrides for the given RunOptions

Since: 0.1.1.0

setRunExitTimeoutSec :: Int -> RunOptions -> RunOptions

Set the timeout in seconds for the process reaper to wait for all child processes to exit after receiving SIGTERM or SIGINT signal

Since: 0.1.2.0

setRunGroup :: String -> RunOptions -> RunOptions

Set the process setGroupID group for the given RunOptions

Since: 0.1.1.0

setRunUser :: String -> RunOptions -> RunOptions

Set the process setUserID user for the given RunOptions

Since: 0.1.1.0

setRunWorkDir :: FilePath -> RunOptions -> RunOptions

Set the process current directory for the given RunOptions

Since: 0.1.1.0