riverline / worker-bundle
Symfony2 Bundle to use queue with workers
Installs: 74 639
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 2
Forks: 7
Open Issues: 2
Requires
- php: >=7.1.3
- ext-zlib: *
- symfony/config: ^2.0|^3.0|^4.0
- symfony/console: ^2.0|^3.0|^4.0
- symfony/dependency-injection: ^2.0|^3.0|^4.0
- symfony/http-kernel: ^2.0|^3.0|^4.0
Requires (Dev)
- aws/aws-sdk-php: ^3.0
- phpunit/phpunit: ^4.8
- predis/predis: ^1.1
- stomp-php/stomp-php: ^4.3
Suggests
- amazonwebservices/aws-sdk-for-php: ^1.0
- aws/aws-sdk-php: ^3.0
- predis/predis: ^1.0
- stomp-php/stomp-php: ^4.0
README
What is Riverline\WorkerBundle
Riverline\WorkerBundle
add abstraction to queue providers and allow to create Workers to consume queue workload.
Requirements
- PHP 5.3
- Symfony 2.x
Installation
Riverline\WorkerBundle
is compatible with composer and any prs-0 autoloader
Configuration
riverline_worker: providers: predis: class: Riverline\WorkerBundle\Provider\PRedis arguments: - { host: redis.example.com } sqs: #v1 class: Riverline\WorkerBundle\Provider\AwsSQS arguments: - { key: xxxxxx, secret: xxxxx } - sqs.eu-west-1.amazonaws.com sqs: #v3 class: Riverline\WorkerBundle\Provider\AwsSQSv3 arguments: - version: "latest" region: "us-west-2" credentials: key: "xxxxxx" secret: "xxxxxx" gearman: class: Riverline\WorkerBundle\Provider\Gearman arguments: - [ gearman1.example.com, gearman2.examplet.com ] amqp: ## WIP class: Riverline\WorkerBundle\Provider\AMQP semaphore: class: Riverline\WorkerBundle\Provider\Semaphore activemq: class: Riverline\WorkerBundle\Provider\ActiveMQ arguments: - tcp://localhost:61613 - login - passcode - false # Boolean indicates if message is persistent - false # Boolean indicates if broker statistics plugin is enabled http://activemq.apache.org/statisticsplugin.html - true # Boolean indicates if sync mode is enabled queues: queue1: name: ThisIsMyQueue provider: predis queue2: name: https://eu-west-1.queue.amazonaws.com/xxxxxx/xxxx provider: sqs
Usage
You can access any configured provider or queue through the Symfony Container
<?php $provider = $this->get('riverline_worker.provider.predis'); $provider->put('ThisIsMyQueue', 'Hello World'); $queue = $this->get('riverline_worker.queue.queue1'); echo $queue->count()." item(s) in the queue";
You can easily create Workers
<?php // src/Acme/DemoBundle/Command/DemoWorkerCommand.php namespace Acme\DemoBundle\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Riverline\WorkerBundle\Command\Worker; use Riverline\WorkerBundle\Command\WorkerControlCodes; class DemoWorkerCommand extends Worker { protected function configureWorker() { $this // Queue name from the configuration ->setQueueName('queue1') // Inhered Command methods ->setName('demo-worker') ->setDescription('Test a worker') ; } protected function executeWorker(InputInterface $input, OutputInterface $output, $workload) { $output->writeln($workload); // Stop worker and dot not process other workloads if ($someReasonToStopAndExit) { return WorkerControlCodes::STOP_EXECUTION; } // else continue return WorkerControlCodes::CAN_CONTINUE; } }
Then you can launch your worker like any other command
$ php app/console demo-worker Hello World
You can pass options.
$ php app/console --worker-wait-timeout=60 --worker-limit=10 --memory-limit=128 --worker-exit-on-exception
This command wait 60 seconds for a workload from the queue, will process a maximum of 10 workloads or exit when usaed memory exceed 128Mb and exit if the executeWorker()
throw an exception.