cmdrsharp/amqp-route-messenger

A client for publishing and listening for routed exchange messages.

1.2.0.1 2019-04-28 09:00 UTC

Requires

• php: >=7.2
• illuminate/support: >=5.8
• php-amqplib/php-amqplib: ^2.9.0

Requires (Dev)

• orchestra/testbench: ^3.8
• phpunit/phpunit: 8.0.*

MIT

README

A client for publishing and listening for routed exchange messages.

Current Requirements

• PHP 7.2 or newer
• Laravel 5.8 or newer

Installation

Via composer

$ composer require cmdrsharp/amqp-route-messenger

After installation, publish the configuration file.

php artisan vendor:publish --provider="CmdrSharp\AmqpRouteMessenger\AmqpRouteMessengerServiceProvider"

Which will create a amqproutemessenger.php file in your Laravel config directory. This will contain bindings for the RabbitMQ Queue Details. It is recommended to simply define these in your .env file. The config file will automatically read from these values.

RABBITMQ_HOST=
RABBITMQ_PORT=5672
RABBITMQ_VHOST=/
RABBITMQ_LOGIN=
RABBITMQ_PASSWORD=

For SSL Connections, just specify (in your .env file) the path to the CA Certificate, and whether to use peer verification. If these are specified, an AMQPSSLConnection will be established.

RABBITMQ_CA_FILE="/path/to/yourca.crt"
RABBITMQ_VERIFY_PEER=true

Usage

Inject the contract into the class where you need the client:

/**
 * @var ClientInterface
 */
protected $client;

/**
 * @param ClientInterface $client
 */
public function __construct(ClientInterface $client)
{
    $this->client = $client;
}

Alternatively, if you don't wish to autoload, you may also require it directly.

use CmdrSharp\AmqpRouteMessenger\Client;

/**
 * @var ClientInterface
 */
protected $client;

public function __construct()
{
    $this->client = new Client();
}

Example: Publish a message with a correlation ID

All we are doing here is declaring which exchange to publish the message to, and then publishing it with a specified correlation ID. declareExchange accepts an optional second parameter which makes it passive

$instance = $this->client->declareExchange('messages')->publish('correlation_id', 'your message');

// Don't forget to close the channel and connection when done!
$instance->closeChannel()->closeConnection();

Example: Read a message with a correlation ID

It is recommended that the consumer is set up prior to any messages being published. This is to ensure that the queue bindings have been created, so that published messages are routed correctly.

$instance = $this->client->declareExchange('messages')
	->declareQueue()
	->bindQueue('correlation_id');

// Note: Reading does freeze the thread until it receives a message.
$message = $instance->read();

// Again, don't forget to close the channel and connection!
$instance->closeChannel()->closeConnection();

Example: Reading and Publishing put together

$instance = $this->client->declareExchange('messages')
	->declareQueue()
	->bindQueue('correlation_id');

$instance->publish('correlation_id', 'your message');

$message = $instance->read(10); // Optional timeout in seconds.

$instance->closeChannel()->closeConnection();

Versioning

This package follows Explicit Versioning.

Authors

CmdrSharp

License

The MIT License (MIT)