https://github.com/mle86/php-wq-redis
A Redis adapter for WQ (https://github.com/mle86/php-wq)
https://github.com/mle86/php-wq-redis
php php-library redis redis-client redis-queue work-queue wq
Last synced: 4 months ago
JSON representation
A Redis adapter for WQ (https://github.com/mle86/php-wq)
- Host: GitHub
- URL: https://github.com/mle86/php-wq-redis
- Owner: mle86
- License: mit
- Created: 2017-05-26T23:16:14.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-01T19:33:40.000Z (over 6 years ago)
- Last Synced: 2025-01-14T15:23:28.799Z (6 months ago)
- Topics: php, php-library, redis, redis-client, redis-queue, work-queue, wq
- Language: PHP
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WQ-Redis (`mle86/wq-redis`)
This package contains the PHP class
mle86\WQ\WorkServerAdapter\\RedisWorkServer.
It supplements the
[**mle86/wq**](https://github.com/mle86/php-wq) package
by implementing its `WorkServerAdapter` interface.
It connects to a [Redis](https://redis.io/) server
using the [phpredis](https://pecl.php.net/package/redis) extension.
# Version and Compatibility
This is
**version 1.0.2**
of `mle86/wq-redis`.
It was developed for
version 1.0.0
of `mle86/wq`
and should be compatible
with all of its future 1.x versions as well.
# Installation and Dependencies
```
$ sudo apt install php-redis # to install the phpredis extension
$ composer require mle86/wq-redis
```
It depends on PHP 7.1,
[mle86/wq](https://github.com/mle86/php-wq),
and the [phpredis](https://pecl.php.net/package/redis) extension.
# Class reference
(class mle86\WQ\WorkServerAdapter\\RedisWorkServer implements WorkServerAdapter)
It connects to a Redis server.
Because Redis does not have
delayed entries,
reserved entries,
or buried entries,
this class uses several custom workarounds
to emulate those features.
For every `$workQueue` used,
this class will create multiple Redis keys:
* \_wq.$workQueue (ready jobs – List)
* \_wq\_delay.$workQueue (delayed jobs – Ordered Set)
* \_wq\_buried.$workQueue (buried jobs – List)
The delaying mechanism was inspired by
[this StackOverflow response](http://stackoverflow.com/a/15016319).
* public function __construct (\Redis $serverConnection)
Takes an already-configured `Redis` instance to work with.
Does not attempt to establish a connection itself –
use the `connect()` factory method for that instead
or do it with `Redis::connect()` prior to using this constructor.
* public function connect ($host = "localhost", $port = 6379, $timeout = 0.0, $retry\_interval = 0)
Factory method.
This will create a new `Redis` instance by itself.
See [`Redis::connect()`](https://github.com/phpredis/phpredis#connect-open) for the parameter descriptions.
Interface methods
which are documented in the [`WorkServerAdapter`](https://github.com/mle86/php-wq/blob/master/doc/Ref_WorkServerAdapter_interface.md) interface:
* public function storeJob (string $workQueue, Job $job, int $delay = 0)
* public function getNextQueueEntry ($workQueue, int $timeout = DEFAULT\_TIMEOUT) : ?QueueEntry
* public function buryEntry (QueueEntry $entry)
* public function requeueEntry (QueueEntry $entry, int $delay, string $workQueue = null)
* public function deleteEntry (QueueEntry $entry)
# Usage example
```php
processNextJob("webhook", function(Job $job) {
$job->...;
});
}
```
This executes all jobs available in the local Redis server's “`webhook`” queue, forever.
It will however abort if one of the jobs throws an exception –
you might want to add a logging try-catch block around the `processNextJob()` call
as shown in [WQ's “Quick Start” example](https://github.com/mle86/php-wq#quick-start).