https://github.com/flowpack/jobqueue-redis
A job queue backend for the Flow framework, based on Redis
https://github.com/flowpack/jobqueue-redis
flowframework neoscms redis
Last synced: 10 months ago
JSON representation
A job queue backend for the Flow framework, based on Redis
- Host: GitHub
- URL: https://github.com/flowpack/jobqueue-redis
- Owner: Flowpack
- License: mit
- Created: 2015-11-05T10:40:12.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T08:50:04.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T15:58:19.432Z (10 months ago)
- Topics: flowframework, neoscms, redis
- Language: PHP
- Size: 33.2 KB
- Stars: 7
- Watchers: 8
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flowpack.JobQueue.Redis
A job queue backend for the [Flowpack.JobQueue.Common](https://github.com/Flowpack/jobqueue-common) package based on [redis](http://redis.io/).
## Usage
Install the package using composer:
```
composer require flowpack/jobqueue-redis
```
If not already installed, that will fetch its requirements, namely `jobqueue-common`.
*NOTE:* This package needs a [redis](http://redis.io/) server and the [PHP redis extension](https://github.com/phpredis/phpredis) to be installed
Now the queue can be configured like this:
```yaml
Flowpack:
JobQueue:
Common:
queues:
'some-queue':
className: 'Flowpack\JobQueue\Redis\Queue\RedisQueue'
executeIsolated: true
options:
client:
host: 127.0.0.1
port: 6379
database: 15
password: 'some long secret'
defaultTimeout: 20
```
## Specific options
The `RedisQueue` supports following options:
| Option | Type | Default | Description |
|----------------|---------|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| defaultTimeout | integer | 60 | Number of seconds new messages are waited for before a timeout occurs (This is overridden by a "timeout" argument in the `waitAndTake()` and `waitAndReserve()` methods |
| client | array | ['host' => '127.0.0.1', 'port' => 6379, 'database' => 0, 'timeout' => , password => ''] | Redis connection settings |
### Submit options
The `RedisQueue` currently doesn't support any custom submit options
### Release options
The `RedisQueue` currently doesn't support any custom release options
## License
This package is licensed under the MIT license
## Contributions
Pull-Requests are more than welcome. Make sure to read the [Code Of Conduct](CodeOfConduct.rst).