tomahawk/queue

Tomahawk Queue

Tomahawk Queue

A nice and simple PHP Worker Queue library, _(*1)

Requirements

• PHP 7.0 +
• pcntl extension.
• posix extension.

Installation

You can install Tomahawk Queue using composer:, _(*2)

composer require tomahawk/queue, _(*3)

1. Setup configuration

First you need to create a new file called tomahawk.xml, _(*4)

You will need to configure the following things:, _(*5)

• Storage directory - for logs and pid files
• Bootstrap file (optional) - Allows you to add event listeners and extend storage
• Your workers

Below is an example:, _(*6)

<tomahawk
    storage="./storage"
    bootstrap="./queue-bootstrap.php">

    <workers>
        <worker pidkey="emails" name="Emails" queues="emails" />
    </workers>

</tomahawk>

2. Create Bootstrap file

Bootstrap example file, _(*7)

<?php

use Tomahawk\Queue\Application;
use Tomahawk\Queue\Storage\StorageInterface;
use Tomahawk\Queue\Storage\RedisStorage;
use Predis\Client;
use Pimple\Container;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * Get the Autoloader
 */
require_once(__DIR__.'/vendor/autoload.php');

/**
 * Set Default Timezone
 */

date_default_timezone_set('Europe/London');

// Get the container
$container = Application::getContainer();

// Set storage for jobs
$container[StorageInterface::class] = function(Container $c) {
    $client = new Client([
         'scheme' => 'tcp',
         'host'   => '10.0.0.1',
         'port'   => 6379,
    ]);
    return new RedisStorage($client);
};

$eventDispatcher = $container[EventDispatcherInterface::class];

// Add events
$eventDispatcher->addListener(\Tomahawk\Queue\JobEvents::PROCESSED, function(\Tomahawk\Queue\Event\PreProcessEvent $event) {
    // Log to a file
});

$container[EventDispatcherInterface::class];

Using the CLI

Create a new worker

./bin/tomahawk-queue work emails emails --daemon, _(*8)

Queue a new job to worker

./bin/tomahawk-queue queue emails JobClass {"id":"1"}, _(*9)

List running workers

./bin/tomahawk-queue list, _(*10)

Stop a running worker

./bin/tomahawk-queue stop emails, _(*11)

Load and run all workers defined in configuration file

./bin/tomahawk-queue load, _(*12)

Using the Queue Manager

If you have your works setup on a different VM or server you can still push jobs onto the queue using the Queue Manager., _(*13)

Below is an example of how to do this, _(*14)

```php <?php, <sub>(*15)</sub>

use Predis\Client; use Tomahawk\Queue\Manager; use Tomahawk\Queue\Storage\RedisStorage;, <sub>(*16)</sub>

$client = new Client([ 'scheme' => 'tcp', 'host' => '10.0.0.1', 'port' => 6379, ]); $storage = new RedisStorage($client);, <sub>(*17)</sub>

$manager = new Manager($storage);, <sub>(*18)</sub>

$arguments = [ 'email' => '...', 'subject' => '...', ];, <sub>(*19)</sub>

$manager->queue('queue_email', 'JobClass', $arguments); ```, <sub>(*20)</sub>

License

Tomahawk Queue is open-sourced software licensed under the MIT license, <sub>(*21)</sub>