prolic/humus-amqp

PHP-AMQP library with RabbitMQ Extensions

Fund package maintenance!
Patreon

v2.0.0 2020-03-28 19:52 UTC

This package is auto-updated.

Last update: 2020-07-29 20:16:36 UTC


README

PHP 7.4 AMQP library

Build Status Coverage Status Gitter Documentation Status

Documentation powered by Read the Docs.

Overview

PHP 7.4 AMQP libray supporting multiple drivers and providing full-featured Consumer, Producer, and JSON-RPC Client / Server implementations.

The JSON-RPC part implements JSON-RPC 2.0 Specification.

Current supported drivers are: php-amqp and PhpAmqpLib.

php-amqp needs at least to be v1.9.3 php-amqplib needs at least to be v2.11.0

This library ships with psr/container factories that help you setting up everything.

Zend Framework and Symfony Framework Integration

Installation

You can install prolic/humus-amqp via composer by adding "prolic/humus-amqp": "^2.0" as requirement to your composer.json.

Usage

Exchange

$exchangeName = 'test-exchange';
$exchange = ExchangeFactory::$exchangeName($container);

$exchange->publish('test-message');

Queue

$queueName = 'test-queue';
$queue = QueueFactory::$queueName($container);

$message = $queue->get();
$queue->ack($message->getDeliveryTag());

Producer

$producerName = 'test-producer';
$producer = ProducerFactory::$producerName($container);

$producer->confirmSelect();
$producer->publish(['foo' => 'bar'], 'my-routing-key');
$producer->waitForConfirm();

JSON RPC Client

$clientName = 'my-client';
$client = JsonRpcClientFactory::$clientName($container);
$client->addRequest(new JsonRpcRequest('my-server', 'method', ['my' => 'params'], 'id-1'));
$client->addRequest(new JsonRpcRequest('my-server', 'method', ['my' => 'other_params'], 'id-2'));
$responseCollection = $client->getResponseCollection();

JSON RPC Server

$serverName = 'my-server';
$server = JsonRpcServerFactory::$serverName($container);
$server->consume();

Notes

Upgrade from 1.x to 1.4

Before: If auto_setup_fabric was enabled, the queue and exchange binding was done automatically. The exchanges would also get created. Anonymous queues required to have auto_setup_fabric set to true.

New: If auto_setup_fabric is enabled or the queue is anonymous (has no name), the queue gets created and binding is done, but no exchanges are created. If you want to enable creating of depending exchanges (including exchange binding), set the new argument auto_setup_exchanges to true.

This is a slight BC break, but the old behaviour was so problematic, that I had to make this change either way.

AMQP-Extension

  1. We recommend using php-amqp >=v1.9.3 or compiling it from master, if you encounter any problems with the amqp extension, check their issue tracker, first.

The ext-amqp driver is the most performant.

PhpAmqpLib

  1. When using php-amqplib as driver, it's worth point out, that a StreamConnection (same goes for SSLConnection) does not have the possibility to timeout. If you want to let the consumer timeout, when no more messages are received, you should use the SocketConnection instead (assuming you don't need an SSL connection).

  2. When using php-amqplib as driver and you're using the LazyConnection, you should not create the channel yourself, call instead $channel = $connection->newChannel()

Support

Contribute

Please feel free to fork and extend existing or add new plugins and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and may adapt the documentation.

License

Released under the MIT.