graze/queue

:postbox: Flexible abstraction for working with queues in PHP.

Friday, May 25, 2018
by graze
Repository
25 Watchers
49 Stars
13,188 Installations

PHP
0 Dependents
0 Suggesters
11 Forks
6 Open issues
18 Versions
16 % Grown

The README.md

Queue

, _(*1)

![PHP ~5.5][ico-engine] ![Latest Version][ico-package] ![Quality Score][ico-quality] , _(*2)

This library provides a flexible abstraction layer for working with queues., _(*3)

It can be installed in whichever way you prefer, but we recommend Composer., _(*4)

~$ composer require graze/queue, _(*5)

, _(*6)

Documentation

Queue operations center around lists of Message objects. Whether you're sending one or multiple Messages, it's always an array. Workers work only on one Message object at a time, whether a list of one or multiple is received from the queue., _(*7)

use Aws\Sqs\SqsClient;
use Graze\Queue\Adapter\SqsAdapter;
use Graze\Queue\Client;
use Graze\Queue\Message\MessageInterface;

$client = new Client(new SqsAdapter(new SqsClient([
    'region'  => 'us-east-1',
    'version' => '2012-11-05',
    'credentials' => [
        'key'    => 'ive_got_the_key',
        'secret' => 'ive_got_the_secret'
    ],
]), 'queue_name'));

// Producer
$client->send([
    $client->create('foo'),
]);

// Consumer
$client->receive(function (MessageInterface $msg) {
    var_dump($msg->getBody());
    var_dump($msg->getMetadata()->getAll());
});

Adapters

The Adapter object is used to fulfill the low level requests to the queue provider., _(*8)

Currently supported queue providers are:, _(*9)

Array
AWS SQS (with the AWS SDK)

Handlers

The Handler object is used to execute worker callables with a list of received messages and handle Acknowledgement., _(*10)

The current handlers are:, _(*11)

Batch Acknowledgement to acknowledge batches
Eager Acknowledgement to acknowledge immediately after work
Null Acknowledgement for development

use Graze\Queue\Client;
use Graze\Queue\Adapter\ArrayAdapter;
use Graze\Queue\Handler\BatchAcknowledgementHandler;
use Graze\Queue\Message\MessageInterface;

// Create client with the Batch Acknowledgement Handler.
$client = new Client(new ArrayAdapter(), [
    'handler' => new BatchAcknowledgementHandler(),
]);

// Receive a maximum of 10 messages.
$client->receive(function (MessageInterface $message) {
    // Do some work.
}, 10);

Polling

Polling a queue is supported by passing null as the limit argument to the receive method. The second argument given to your worker is a Closure you should use to stop polling when you're finished working. Make sure you use a handler that acknowledges work effectively too!, _(*12)

Note that the individual Adapter objects may decide to stop polling at any time. A likely scenario where it may stop would be if the queue is of finite length and all possible messages have been received., _(*13)

use Graze\Queue\Client;
use Graze\Queue\Adapter\ArrayAdapter;
use Graze\Queue\Handler\BatchAcknowledgementHandler;
use Graze\Queue\Message\MessageInterface;

// Create client with the Batch Acknowledgement Handler.
$client = new Client(new ArrayAdapter(), [
    'handler' => new BatchAcknowledgeHandler(100), // Acknowledge after 100 messages.
]);

// Poll until `$done()` is called.
$client->receive(function (MessageInterface $message, Closure $done) {
    // Do some work.

    // You should always define a break condition (i.e. timeout, expired session, etc).
    if ($breakCondition) $done();
}, null);

License

The content of this library is released under the MIT License by Nature Delivered Ltd., _(*14)

You can find a copy of this license in LICENSE or at http://opensource.org/licenses/mit., _(*15)

The Versions

25/05 2018

dev-master

9999999-dev

:postbox: Flexible abstraction for working with queues in PHP.

library queue

:postbox: Flexible abstraction for working with queues in PHP.

graze/queue

The README.md

Queue

Documentation

Adapters

Handlers

Polling

License

The Versions

dev-master

The Requires

The Development Requires

by Graze Developers

v0.7.0

The Requires

The Development Requires

by Graze Developers

dev-extend-message-processing-time

The Requires

The Development Requires

by Graze Developers

0.6.1

The Requires

The Development Requires

by Graze Developers

dev-add-errors-to-sqs

The Requires

The Development Requires

by Graze Developers

v0.6.0

The Requires

The Development Requires

by Graze Developers

dev-rejection

The Requires

The Development Requires

by Graze Developers

dev-async-queues

The Requires

The Development Requires

by Graze Developers

v0.5.0

The Requires

The Development Requires

by Graze Developers

v0.4.0

The Requires

The Development Requires

by Graze Developers

1.0.x-dev

The Requires

The Development Requires

by Graze Developers

dev-hamcrest-assertion-count-patch

The Requires

The Development Requires

by Graze Developers

dev-sjparkinson-patch-1

The Requires

The Development Requires

by Graze Developers

v0.3.0

The Requires

The Development Requires

by Graze Developers

dev-delete-queue

The Requires

The Development Requires

by Graze Developers

v0.2.0

The Requires

The Development Requires

by Graze Developers

v0.1.1

The Requires

The Development Requires

by Graze Developers

v0.1.0