BackgroundProcess
in package
Table of Contents
- $lock_file_dir : mixed
- $lock_file_postfix : mixed
- $lock_file_prefix : mixed
- $max_lock_file_age : mixed
- $max_process_check_sleep : mixed
- $max_process_check_timeout : mixed
- $max_processes : mixed
- $process_number_digits : mixed
- __construct() : mixed
- BackgroundProcess constructor.
- BackgroundExec() : bool
- getBaseLockFileName() : string
- getCurrentProcesses() : int
- getLockFileDirectory() : string
- getLockFilePrefix() : string
- getLockFiles() : array<string|int, mixed>|bool
- getMaxProcesses() : int
- getNextLockFileName() : string
- purgeLockFiles() : bool
- Delete any lock files older then max age, incase they are stale.
- ReplaceCommandVariables() : mixed
- run() : bool
- setLockFileDirectory() : bool
- setLockFilePrefix() : bool
- setMaxProcesses() : bool
- wait() : bool
- Waits for all background processes to finish.
Properties
$lock_file_dir
public
mixed
$lock_file_dir
= '/tmp/'
$lock_file_postfix
public
mixed
$lock_file_postfix
= '.lock'
$lock_file_prefix
public
mixed
$lock_file_prefix
= 'background_process'
$max_lock_file_age
public
mixed
$max_lock_file_age
= 86400
$max_process_check_sleep
public
mixed
$max_process_check_sleep
= 2
$max_process_check_timeout
public
mixed
$max_process_check_timeout
= 600
$max_processes
public
mixed
$max_processes
= 1
$process_number_digits
public
mixed
$process_number_digits
= 6
Methods
__construct()
BackgroundProcess constructor.
public
__construct() : mixed
Return values
mixed —BackgroundExec()
public
BackgroundExec( $cmd) : bool
Parameters
Return values
bool —getBaseLockFileName()
public
getBaseLockFileName([bool $include_dir = false ]) : string
Parameters
- $include_dir : bool = false
Return values
string —getCurrentProcesses()
public
getCurrentProcesses( $lock_files) : int
Parameters
Return values
int —getLockFileDirectory()
public
getLockFileDirectory() : string
Return values
string —getLockFilePrefix()
public
getLockFilePrefix() : string
Return values
string —getLockFiles()
public
getLockFiles([mixed $purge_lock_files = true ]) : array<string|int, mixed>|bool
Parameters
- $purge_lock_files : mixed = true
Return values
array<string|int, mixed>|bool —getMaxProcesses()
public
getMaxProcesses() : int
Return values
int —getNextLockFileName()
public
getNextLockFileName( $lock_files) : string
Parameters
Return values
string —purgeLockFiles()
Delete any lock files older then max age, incase they are stale.
public
purgeLockFiles( $lock_files[, mixed $check_pids = false ]) : bool
Parameters
Return values
bool —ReplaceCommandVariables()
public
ReplaceCommandVariables( $cmd, $next_lock_file_name) : mixed
Parameters
Return values
mixed —run()
public
run( $cmd[, mixed $skip_on_max_processes = false ]) : bool
Parameters
Return values
bool —setLockFileDirectory()
public
setLockFileDirectory( $dir) : bool
Parameters
Return values
bool —setLockFilePrefix()
public
setLockFilePrefix( $prefix) : bool
Parameters
Return values
bool —setMaxProcesses()
public
setMaxProcesses( $int) : bool
Parameters
Return values
bool —wait()
Waits for all background processes to finish.
public
wait([int $timeout = 300 ]) : bool
Parameters
- $timeout : int = 300
-
seconds.