Worker class - Documentation for SproutCMS

Info Page:

Page options:

class Worker

Functions called by worker libraries to indicate status, etc

Name	Visibility	Description
exceptionHandler	public (static)	Exception and error handling for worker jobs
failure	public (static)	Report that a worker job failed.
message	public (static)	Save and output log message for the currently running worker job
metric	public (static)	Set a metric
shutdown	public (static)	Shutdown function, for catching fatal errors
start	public (static)	Called just before the worker thread is started.
success	public (static)	Report the successful completion of the worker job.

void Worker::exceptionHandler ( mixed $exception [, mixed $message [, mixed $file [, mixed $line ]]] );

Exception and error handling for worker jobs

void Worker::failure ( [ string $message ] );

Report that a worker job failed.
Terminates the script.

void Worker::message ( string $message );

Save and output log message for the currently running worker job

void Worker::metric ( int $num , int $value );

Set a metric

void Worker::shutdown ( );

Shutdown function, for catching fatal errors

unknown Worker::start ( mixed $job_id );

Called just before the worker thread is started.

void Worker::success ( );

Report the successful completion of the worker job.
Terminates the script.