actions_email_cron_job Class Reference

Public Member Functions
	handle ($params)
	performJob ($jobId)
	mutex ($name)
	clear_mutex ()
	out ($out)

Data Fields
const	JOB_IN_PROGRESS = 201
const	JOB_NOT_FOUND = 404
const	JOB_COMPLETE = 200
const	JOB_CANCELLED = 301

Detailed Description

Definition at line 3 of file email_cron_job.php.

Member Function Documentation

clear_mutex

(

)

Clears the most recently acquired mutex.

Definition at line 179 of file email_cron_job.php.

handle

(

$params

)

Definition at line 10 of file email_cron_job.php.

mutex

(

$name

)

Obtain a mutex (to make sure we aren't running multiple instances of this script concurrently.

This function will return true if it succeeded in obtaining the mutex (i.e. no other instance of this script is running. And false otherwise.

Parameters

string

$name

The name of the mutex to acquire.

Definition at line 162 of file email_cron_job.php.

out

(

$out

)

Definition at line 187 of file email_cron_job.php.

performJob

(

$jobId

)

Definition at line 94 of file email_cron_job.php.

Field Documentation

const JOB_CANCELLED = 301

Definition at line 7 of file email_cron_job.php.

const JOB_COMPLETE = 200

Definition at line 6 of file email_cron_job.php.

const JOB_IN_PROGRESS = 201

Definition at line 4 of file email_cron_job.php.

const JOB_NOT_FOUND = 404

Definition at line 5 of file email_cron_job.php.

---

The documentation for this class was generated from the following file:

• actions/email_cron_job.php