genius13/codeigniter-job-queue-redis

Job Queue based on redis

Codeigniter-jobQueue

Job Queue based on redis and mcurl

by Marcos Sanz, _(*1)

Feel free to send me an email if you have any problems or you find bugs., _(*2)

Installation

First of all, you have to install codeigniter-redis library, and codeigniter-mcurl library. Just copy the files from this package to the correspoding folder in your application folder. For example, /application/libraries/jobs.php., _(*3)

Loading library

In /application/config/autoload.php, _(*4)

$autoload['libraries'] = array('jobs');

or, _(*5)

$this -> load -> library('jobs');

Application Usage

Variables: * $at ($timestamp) => Unix timestamp when you want to execute the job * $queue => Name of the queue. For example: high, normal, low, mail, archive * $controller => Name of the controller * $method => Name of the method from controller (Default: index) * $params => Array of params (Default: null). For example: array('param1','param2','param3') * $description => Description of the task (Default: null). For example: UpdateUserProfile * $belongTo ($user_id) => Id user from the job (Default: null). * $stat => Jobs stats. For example: delayed, waiting, running, complete and failed, _(*6)

Create new job

Function:, _(*7)

create($queue, $controller, $method, $params, $description, $belongTo)

For example:, _(*8)

$this -> jobs -> create('high', 'users', 'check_users', array('10'), 'checkUsers','1');

Create new schedule job

Function:, _(*9)

create_at($at, $queue, $controller, $method, $params, $description, $belongTo)

For example:, _(*10)

$this -> jobs -> create_at(1353456000, 'high', 'users', 'check_users', array('10'), 'checkUsers','1');

Get size from a given queue

Function:, _(*11)

get_queue_size($queue)

For example:, _(*12)

$this -> jobs -> get_queue_size('low');

Get size from the delayed queue

Function:, _(*13)

get_delayed_queue_size()

For example:, _(*14)

$this -> jobs -> get_delayed_queue_size();

Get size from the delated queue in a given timestamp

Function:, _(*15)

get_delayed_timestamp_size($timestamp)

For example:, _(*16)

$this -> jobs -> get_delayed_timestamp_size(1353456000);

Clear a queue

Function:, _(*17)

clear($queue)

For example:, _(*18)

$this -> jobs -> clear('low');

Destroy a queue

Function:, _(*19)

destroy($queue)

For example:, _(*20)

$this -> jobs -> destroy('low');

Remove a job

Function:, _(*21)

//TODO

Get peek from a given queue

Function:, _(*22)

peek($queue)

For example:, _(*23)

$this -> jobs -> peek('low');

Get queues memebers

Function:, _(*24)

queues()

For example:, _(*25)

$this -> jobs -> queues();

Get workers and current job in the worker

Function:, _(*26)

get_workers()

For example:, _(*27)

$this -> jobs -> get_workers();

Get jobs statuses or get jobs statuses from a user

Function:, _(*28)

get_statuses_jobs($user_id)

For example:, _(*29)

$this -> jobs -> get_statuses_jobs(); or $this -> jobs -> get_statuses_jobs(2341);

Get number of stats from a given stat

Function:, _(*30)

get_stat($stat)

For example:, _(*31)

$this -> jobs -> get_stat('running');

Clear stat

Function:, _(*32)

clear_stat()

For example:, _(*33)

$this -> jobs -> clear_stat();

Worker Usage

Variables: * $worker_name => Name of the machine or worker (Default: worker) * $queues => Name of the queues. For example: high * $interval => Seconds to sleep worker (Default: null), _(*34)

Main worker (Execute jobs)

Function:, _(*35)

worker($worker_name, $queues, $interval)

Delayed worker (Re-organize schedule jobs)

Function:, _(*36)

worker_delayed($worker_name, $interval)

Thanks,
-Marcos Sanz
marcossanzlatorre@gmail.com
@marsanla, _(*37)