API17

JDaemon: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Layout updates
Doxiki2 (talk | contribs)
Updated to r1448:247ba8d88526
Line 1: Line 1:
__NOTOC__
__NOTOC__
=={{JVer|11.1}} JDaemon==
===Description===
{{Description:JDaemon}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JDaemon|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[Description:JDaemon|Edit Descripton]]<nowiki>]</nowiki>
</span>
</span>
{{Description:JDaemon}}
===Defined in===
libraries/joomla/application/cli/daemon.php
* see source code in [[jplatform:application/cli/daemon.php|BitBucket]]
===Subpackage===
[[Subpackage Application/11.1|Application]]
===Extends===
[[JCli/11.1|JCli]]
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|public
|[[JDaemon::isActive/11.1|isActive]]
|[[JDaemon::isActive/11.1|isActive]]
|Check to see if the daemon is active.  
|Check to see if the daemon is active.  
|-
|-
|public
|[[JDaemon::loadConfiguration/11.1|loadConfiguration]]
|Load an object or array into the application configuration object.
|-
|public
|[[JDaemon::restart/11.1|restart]]
|[[JDaemon::restart/11.1|restart]]
|Restart daemon process.  
|Restart daemon process.  
|-
|-
|public
|[[JDaemon::start/11.1|start]]
|[[JDaemon::start/11.1|start]]
|Spawn daemon process.  
|Spawn daemon process.  
|-
|-
|public
|[[JDaemon::stop/11.1|stop]]
|[[JDaemon::stop/11.1|stop]]
|Stop daemon process.  
|Stop daemon process.  
|-
|-
|public static
|[[JDaemon::signal/11.1|signal]]
|[[JDaemon::signal/11.1|signal]]
|Method to handle POSIX signals.  
|Method to handle POSIX signals.  
|-
|-
|protected
|[[JDaemon::__construct/11.1|__construct]]
|[[JDaemon::__construct/11.1|__construct]]
|Class constructor.  
|Class constructor.  
|-
|-
|protected
|[[JDaemon::changeIdentity/11.1|changeIdentity]]
|[[JDaemon::changeIdentity/11.1|changeIdentity]]
|Method to change the identity of the daemon process and resources.  
|Method to change the identity of the daemon process and resources.  
|-
|-
|protected
|[[JDaemon::daemonize/11.1|daemonize]]
|[[JDaemon::daemonize/11.1|daemonize]]
|Method to put the application into the background.  
|Method to put the application into the background.  
|-
|-
|protected
|[[JDaemon::fork/11.1|fork]]
|[[JDaemon::fork/11.1|fork]]
|This is truly where the magic happens.  
|This is truly where the magic happens.  
|-
|-
|protected
|[[JDaemon::gc/11.1|gc]]
|[[JDaemon::gc/11.1|gc]]
|Method to perform basic garbage collection and memory management in the sense of clearing the stat cache.  
|Method to perform basic garbage collection and memory management in the sense of clearing the stat cache.  
|-
|-
|[[JDaemon::loadConfiguration/11.1|loadConfiguration]]
|protected
|Load the configuration file into the site object.
|-
|[[JDaemon::setupSignalHandlers/11.1|setupSignalHandlers]]
|[[JDaemon::setupSignalHandlers/11.1|setupSignalHandlers]]
|Method to attach the  signal handler to the known signals.  
|Method to attach the  signal handler to the known signals.  
|-
|-
|protected
|[[JDaemon::shutdown/11.1|shutdown]]
|[[JDaemon::shutdown/11.1|shutdown]]
|Method to shut down the daemon and optionally restart it.  
|Method to shut down the daemon and optionally restart it.  
|-
|-
|protected
|[[JDaemon::writeProcessIdFile/11.1|writeProcessIdFile]]
|[[JDaemon::writeProcessIdFile/11.1|writeProcessIdFile]]
|Method to write the process id file out to disk.  
|Method to write the process id file out to disk.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/application/cli/daemon.php
* '''Extends''' [[JCli/11.1|JCli]]
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.application.cli.daemon' );</source>
<source lang="php">jimport( 'joomla.application.cli.daemon' );</source>
===See also===
===See also===
* JDaemon source code in [[jplatform:application/cli/daemon.php|BitBucket]]
* {{JVer|11.1}} '''JDaemon source code''' on [[jplatform:application/cli/daemon.php|BitBucket]]
* [[JDaemon|Other versions of this class]]
* {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]]
* [[JDaemon|Other versions of JDaemon]]
{{SeeAlso:JDaemon}}
{{SeeAlso:JDaemon}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JDaemon|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[SeeAlso:JDaemon|Edit See Also]]<nowiki>]</nowiki>
</span>
</span>
===Examples===
===User contributed notes===
<CodeExamplesForm />
<CodeExamplesForm />
<dpl>
<dpl>
Line 78: Line 90:
category=ClassExample
category=ClassExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JDaemon]]</noinclude>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JDaemon]]</noinclude>

Revision as of 22:57, 27 April 2011

Joomla 11.1 JDaemon

Description

Template:Description:JDaemon [Edit Descripton]

Methods

Visibility Method name Description
public isActive Check to see if the daemon is active.
public loadConfiguration Load an object or array into the application configuration object.
public restart Restart daemon process.
public start Spawn daemon process.
public stop Stop daemon process.
public static signal Method to handle POSIX signals.
protected __construct Class constructor.
protected changeIdentity Method to change the identity of the daemon process and resources.
protected daemonize Method to put the application into the background.
protected fork This is truly where the magic happens.
protected gc Method to perform basic garbage collection and memory management in the sense of clearing the stat cache.
protected setupSignalHandlers Method to attach the signal handler to the known signals.
protected shutdown Method to shut down the daemon and optionally restart it.
protected writeProcessIdFile Method to write the process id file out to disk.
  • Defined in libraries/joomla/application/cli/daemon.php
  • Extends JCli

Importing

jimport( 'joomla.application.cli.daemon' );

See also

Template:SeeAlso:JDaemon [Edit See Also]

User contributed notes

<CodeExamplesForm />