Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplario/quedis
Quedis - redis queue for bosses
https://github.com/simplario/quedis
message php queue redis
Last synced: 3 months ago
JSON representation
Quedis - redis queue for bosses
- Host: GitHub
- URL: https://github.com/simplario/quedis
- Owner: simplario
- License: mit
- Created: 2017-09-17T13:15:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-31T22:22:49.000Z (about 7 years ago)
- Last Synced: 2024-04-24T19:12:15.015Z (7 months ago)
- Topics: message, php, queue, redis
- Language: PHP
- Homepage:
- Size: 89.8 KB
- Stars: 30
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quedis
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
## Install
- PHP 5.6+
``` bash
# via composer
$ composer require simplario/quedis
```
## Testing
``` bash
$ composer test
```
## Start working
``` php
put('transaction-queue', 'transaction-11');
$message12 = $quedis->put('transaction-queue', new \Simplario\Quedis\Message('transaction-12'));
// with delay
$message22 = $quedis->put('transaction-queue', 'transaction-21', 60 * 5);
$message22 = $quedis->put('transaction-queue', 'transaction-22', (new \DateTime())->modify('+1 day'));
// with priority
$message32 = $quedis->put('transaction-queue', 'transaction-31', 0, 'high');
$message32 = $quedis->put('transaction-queue', 'transaction-32', 0, 'low');
// Get Quedis statistic
// =========================================
// for concrete queue
$queueStat = $quedis->stats('transaction-queue');
// for all queues
$statsAll = $quedis->stats();
// Stop/start queue
// =========================================
// stop queue
$quedis->stop('transaction-queue');
// for all queues
$quedis->start('transaction-queue');
// check
$isStop = $quedis->isStop('transaction-queue');
print_r($isStop);
/**
*
* Take message from Quedis
*
* Message flows (like in the Beanstalk: http://beanstalkc.readthedocs.io/en/latest/tutorial.html )
* ------------------------------------------------------------------------------------------------
*
* 1) put pop
* -----> [READY] --------> *poof*
*
*
* 2) put reserve delete
* -----> [READY] ---------> [RESERVED] --------> *poof*
*
*
* 3) put with delay release with delay
* ----------------> [DELAYED] <------------.
* | |
* | (time passes) |
* | |
* put v reserve | delete
* -----------------> [READY] ---------> [RESERVED] --------> *poof*
* ^ ^ | |
* | \ release | |
* | ``-------------' |
* | |
* | kick |
* | |
* | bury |
* [BURIED] <---------------'
* |
* | delete
* ``--------> *poof*
*
*/
// just pop single message
$message = $quedis->pop('transaction-queue');
print_r($message);
// just pop single message with timeout (redis blpop timeout)
$message = $quedis->pop('transaction-queue', 10);
print_r($message);
// reserve flow
$message = $quedis->reserve('transaction-queue', 10);
$quedis->delete($message);
// reserve > bury > kick > reserve > delete
$message = $quedis->reserve('transaction-queue', 10);
// something goes wrong ...
$quedis->bury($message);
// ok lets retry one more time ...
$quedis->kick($message);
$messageSame = $quedis->reserve($message);
// all is ok!
$quedis->delete($messageSame);
// Iterator usage
// =========================================
// iterate reserve all messages
$iterator = $quedis->iterator('transaction-queue', 'reserve', 10);
foreach($iterator as $index => $message){
print_r($message);
$quedis->delete($message);
}
// or like standalone with pop logic
$queue = new \Simplario\Quedis\Queue(new \Predis\Client(), 'super-puper-quedis');
$iterator = new \Simplario\Quedis\Iterator($queue, 'transaction-queue', 'pop', 10);
foreach($iterator as $index => $message){
print_r($message);
}
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/simplario/quedis.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[ico-travis]: https://img.shields.io/travis/simplario/quedis/master.svg
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/simplario/quedis.svg
[ico-code-quality]: https://img.shields.io/scrutinizer/g/simplario/quedis.svg
[ico-downloads]: https://img.shields.io/packagist/dt/simplario/quedis.svg
[link-packagist]: https://packagist.org/packages/simplario/quedis
[link-travis]: https://travis-ci.org/simplario/quedis
[link-scrutinizer]: https://scrutinizer-ci.com/g/simplario/quedis/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/simplario/quedis
[link-author]: https://github.com/vlad-groznov
[link-contributors]: ../../contributors