Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe AbstractDaemonApplication
+ Graphe d'héritage de AbstractDaemonApplication:

Fonctions membres publiques

 __construct (Cli $input=null, Registry $config=null, Cli\CliOutput $output=null, Cli\CliInput $cliInput=null)
 
 signal ($signal)
 
 isActive ()
 
 loadConfiguration ($data)
 
 execute ()
 
 restart ()
 
 stop ()
 
- Fonctions membres publiques hérités de AbstractCliApplication
 __construct (Input\Cli $input=null, Registry $config=null, Cli\CliOutput $output=null, Cli\CliInput $cliInput=null)
 
 getOutput ()
 
 getCliInput ()
 
 out ($text='', $nl=true)
 
 in ()
 
- Fonctions membres publiques hérités de AbstractApplication
 __construct (Input $input=null, Registry $config=null)
 
 close ($code=0)
 
 execute ()
 
 get ($key, $default=null)
 
 getLogger ()
 
 set ($key, $value=null)
 
 setConfiguration (Registry $config)
 
 setLogger (LoggerInterface $logger)
 

Fonctions membres protégées

 changeIdentity ()
 
 daemonize ()
 
 detach ()
 
 fork ()
 
 gc ()
 
 setupSignalHandlers ()
 
 shutdown ($restart=false)
 
 writeProcessIdFile ()
 
 postFork ()
 
 pcntlChildExitStatus ($status)
 
 pcntlFork ()
 
 pcntlSignal ($signal, $handler, $restart=true)
 
 pcntlWait (&$status, $options=0)
 
- Fonctions membres protégées hérités de AbstractApplication
 doExecute ()
 
 initialise ()
 

Attributs protégés

 $exiting = false
 
 $parentId = 0
 
 $processId = 0
 
 $running = false
 
- Attributs protégés hérités de AbstractCliApplication
 $output
 
 $cliInput
 
- Attributs protégés hérités de AbstractApplication
 $config
 

Attributs protégés statiques

static $signals
 

Membres hérités additionnels

- Champs de données hérités de AbstractApplication
 $input = null
 

Description détaillée

Class to turn Cli applications into daemons. It requires CLI and PCNTL support built into PHP.

https://secure.php.net/manual/en/features.commandline.php 1.0 deprecated 925.

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Cli  $input = null,
Registry  $config = null,
Cli\CliOutput  $output = null,
Cli\CliInput  $cliInput = null 
)

Class constructor.

Paramètres
Input\Cli$inputAn optional argument to provide dependency injection for the application's input object. If the argument is an Input object that object will become the application's input object, otherwise a default input object is created.
Registry$configAn optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.
Cli\CliOutput$outputAn optional argument to provide dependency injection for the application's output object. If the argument is a Cli object that object will become the application's input object, otherwise a default output object is created.
Cli\CliInput$cliInputAn optional argument to provide dependency injection for the application's CLI input object. If the argument is a Cli object that object will become the application's input object, otherwise a default input object is created.
Depuis
1.0

Références AbstractCliApplication\$cliInput, AbstractApplication\$config, AbstractApplication\$input, AbstractCliApplication\$output, AbstractApplication\getLogger(), et null.

Documentation des fonctions membres

◆ changeIdentity()

changeIdentity ( )
protected

Method to change the identity of the daemon process and resources.

Renvoie
boolean True if identity successfully changed
Depuis
1.0
Voir également
posix_setuid()

Références $file, $info, $user, et AbstractApplication\getLogger().

Référencé par AbstractDaemonApplication\daemonize().

◆ daemonize()

◆ detach()

detach ( )
protected

This is truly where the magic happens. This is where we fork the process and kill the parent process, which is essentially what turns the application into a daemon.

Renvoie
void
Depuis
1.0
Exceptions

Références AbstractDaemonApplication\$processId, AbstractApplication\close(), AbstractDaemonApplication\fork(), AbstractApplication\getLogger(), et name.

Référencé par AbstractDaemonApplication\daemonize().

◆ execute()

◆ fork()

fork ( )
protected

Method to fork the process.

Renvoie
integer The child process id to the parent process, zero to the child process.
Depuis
1.0
Exceptions

Références elseif, AbstractApplication\getLogger(), AbstractDaemonApplication\pcntlFork(), et AbstractDaemonApplication\postFork().

Référencé par AbstractDaemonApplication\detach().

◆ gc()

gc ( )
protected

Method to perform basic garbage collection and memory management in the sense of clearing the stat cache. We will probably call this method pretty regularly in our main loop.

Renvoie
void
Depuis
1.0

Référencé par AbstractDaemonApplication\execute().

◆ isActive()

isActive ( )

Check to see if the daemon is active. This does not assume that $this daemon is active, but only if an instance of the application is active as a daemon.

Renvoie
boolean True if daemon is active.
Depuis
1.0

Références AbstractApplication\getLogger().

Référencé par AbstractDaemonApplication\daemonize(), AbstractDaemonApplication\shutdown(), et AbstractDaemonApplication\signal().

◆ loadConfiguration()

loadConfiguration (   $data)

Load an object or array into the application configuration object.

Paramètres
mixed$dataEither an array or object to be loaded into the configuration object.
Renvoie
AbstractDaemonApplication Instance of $this to allow chaining.
Depuis
1.0

Références $name, $options, $tmp, et null.

◆ pcntlChildExitStatus()

pcntlChildExitStatus (   $status)
protected

Method to return the exit code of a terminated child process.

Paramètres
integer$statusThe status parameter is the status parameter supplied to a successful call to pcntl_waitpid().
Renvoie
integer The child process exit code.
Voir également
pcntl_wexitstatus()
Depuis
1.0

Référencé par AbstractDaemonApplication\signal().

◆ pcntlFork()

pcntlFork ( )
protected

Method to return the exit code of a terminated child process.

Renvoie
integer On success, the PID of the child process is returned in the parent's thread of execution, and a 0 is returned in the child's thread of execution. On failure, a -1 will be returned in the parent's context, no child process will be created, and a PHP error is raised.
Voir également
pcntl_fork()
Depuis
1.0

Référencé par AbstractDaemonApplication\fork().

◆ pcntlSignal()

pcntlSignal (   $signal,
  $handler,
  $restart = true 
)
protected

Method to install a signal handler.

Paramètres
integer$signalThe signal number.
callable$handlerThe signal handler which may be the name of a user created function, or method, or either of the two global constants SIG_IGN or SIG_DFL.
boolean$restartSpecifies whether system call restarting should be used when this signal arrives.
Renvoie
boolean True on success.
Voir également
pcntl_signal()
Depuis
1.0

Référencé par AbstractDaemonApplication\setupSignalHandlers().

◆ pcntlWait()

pcntlWait ( $status,
  $options = 0 
)
protected

Method to wait on or return the status of a forked child.

Paramètres
integer&$statusStatus information.
integer$optionsIf wait3 is available on your system (mostly BSD-style systems), you can provide the optional options parameter.
Renvoie
integer The process ID of the child which exited, -1 on error or zero if WNOHANG was provided as an option (on wait3-available systems) and no child was available.
Voir également
pcntl_wait()
Depuis
1.0

Références $options.

Référencé par AbstractDaemonApplication\signal().

◆ postFork()

postFork ( )
protected

Method to handle post-fork triggering of the onFork event.

Renvoie
void
Depuis
1.0

Référencé par AbstractDaemonApplication\fork().

◆ restart()

restart ( )

Restart daemon process.

Renvoie
void
Depuis
1.0

Références AbstractApplication\getLogger(), name, et AbstractDaemonApplication\shutdown().

◆ setupSignalHandlers()

setupSignalHandlers ( )
protected

Method to attach the AbstractDaemonApplication signal handler to the known signals. Applications can override these handlers by using the pcntl_signal() function and attaching a different callback method.

Renvoie
boolean
Depuis
1.0
Voir également
pcntl_signal()

Références AbstractApplication\getLogger(), null, et AbstractDaemonApplication\pcntlSignal().

Référencé par AbstractDaemonApplication\daemonize().

◆ shutdown()

shutdown (   $restart = false)
protected

Method to shut down the daemon and optionally restart it.

Paramètres
boolean$restartTrue to restart the daemon on exit.
Renvoie
void
Depuis
1.0

Références $GLOBALS, AbstractApplication\close(), AbstractApplication\getLogger(), et AbstractDaemonApplication\isActive().

Référencé par AbstractDaemonApplication\restart(), AbstractDaemonApplication\signal(), et AbstractDaemonApplication\stop().

◆ signal()

signal (   $signal)

Method to handle POSIX signals.

Paramètres
integer$signalThe received POSIX signal.
Renvoie
void
Depuis
1.0
Voir également
pcntl_signal()
Exceptions

Références AbstractApplication\close(), AbstractApplication\getLogger(), AbstractDaemonApplication\isActive(), AbstractDaemonApplication\pcntlChildExitStatus(), AbstractDaemonApplication\pcntlWait(), et AbstractDaemonApplication\shutdown().

◆ stop()

stop ( )

Stop daemon process.

Renvoie
void
Depuis
1.0

Références AbstractApplication\getLogger(), name, et AbstractDaemonApplication\shutdown().

◆ writeProcessIdFile()

writeProcessIdFile ( )
protected

Method to write the process id file out to disk.

Renvoie
boolean
Depuis
1.0

Références $file, $folder, et AbstractApplication\getLogger().

Référencé par AbstractDaemonApplication\daemonize().

Documentation des champs

◆ $exiting

$exiting = false
protected

◆ $parentId

$parentId = 0
protected

◆ $processId

$processId = 0
protected

◆ $running

$running = false
protected

◆ $signals

$signals
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :