= sfWorker Plugin =

== Overview ==
sfWorkerPlugin manage workers from symfony requests.
Here workers means external process which may be longer than a single http request.
Like you spawn a process external to symfony which will goes on running after
the http request which created it.

**Note**: This is most likely limited to unix-like servers (e.g. linux/macos).
I am unsure about window support for those functions.


== Installation ==

To install sfWorkerPlugin:

{{{
./symfony plugin-install symfony/sfWorkerPlugin
}}}

To install from svn:
{{{
svn co http://svn.symfony-project.com/plugins/sfWorkerPlugin plugins/sfWorkerPlugin
}}}

Clear your cache

{{{
./symfony cc
}}}


== Usage ==
sfWorker is a class which implements 3 functions:
**sfWorker::spawn**, **sfWorker::isRunning**, **sfWorker::kill**.

== Interactive Demo Module ==
There is a demo module included in the plugin to experiment with
sfWorkerPlugin function.

In your application setting.yml, typically at apps/frontend/config/setting.yml,
add sfWorkerPluginDemo in the enabled modules. something like the following:
{{{
    enabled_modules:        [default, sfWorkerPluginDemo]
}}}
After that, use your favorite web browser to point at sfWorkPluginDemo module in
frontend and you will be able to play with a nice interactive demo module.

== TODO ==
 * to complete the documentation
 * to complete the module example. all is good up to the routing...

== License ==

For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.