RabbitMQ and PHP client for Laravel that allows you to add and listen queues messages just simple.
- Simple queue configuration
- Multiple server connections
- Add message to queues easily
- Listen queues with useful options
- videlalvaro/php-amqplib: 2.*
1.0.3
Preparation
Open your composer.json file and add the following to the require array:
"mookofe/tail": "1.*"
Install dependencies
$ php composer install
Or
$ php composer update
After installing the package, open your Laravel config file config/app.php and add the following lines.
In the $providers array add the following service provider for this package.
'Mookofe\Tail\ServiceProvider',
In the $aliases array add the following facade for this package.
'Tail' => 'Mookofe\Tail\Facades\Tail',
By default the library will use the RabbitMQ installation credentials (on a fresh installation the user "guest" is created with password "guest").
To override the default connection or add more servers run:
$ php artisan vendor:publish --provider="Mookofe\Tail\ServiceProvider" --tag="config"
Edit the RabbitMQ connections file at: app/config/tail-settings.php
return array(
'default' => 'default_connection',
'connections' => array(
'default_connection' => array(
'host' => 'localhost',
'port' => 5672,
'username' => 'guest',
'password' => 'guest',
'vhost' => '/',
'exchange' => 'default_exchange_name',
'consumer_tag' => 'consumer',
),
'other_server' => array(
'host' => '192.168.0.10',
'port' => 5672,
'username' => 'guest',
'password' => 'guest',
'vhost' => '/',
'exchange' => 'default_exchange_name',
'consumer_tag' => 'consumer',
),
),
);
Adding a simple message
Tail::add('queue-name', 'message');
Adding message changing RabbitMQ server
Tail::add('queue-name', 'message', array('connection_name' => 'connection_name_config_file'));
Adding message with different exchange
Tail::add('queue-name', 'message', array('exchange' => 'exchange_name'));
Adding message with different options
$options = array (
'connection_name' => 'connection_name_config_file',
'exchange' => 'exchange_name',
'vhost' => 'vhost'
);
Tail::add('queue-name', 'message', $options);
Using Tail object
$message = new Tail::createMessage;
$message->queue_name = 'queue-name';
$message->message = 'message';
$message->connection_name = 'connection_name_in_config_file';
$message->exchange = 'exchange_name';
$message->vhost = 'vhost';
$message->save();
Closure based listener
Tail::listen('queue-name', function ($message) {
//Your message logic code
});
Closure listener with options
$options = array(
'message_limit' => 50,
'time' => 60,
'empty_queue_timeout' => 5,
'connection_name' => 'connection_name_in_config_file',
'exchange' => 'exchange_name',
'vhost' => 'vhost'
);
Tail::listenWithOptions('queue-name', $options, function ($message) {
//Your message logic code
});
Options definitions:
Name | Description | Default value |
---|---|---|
queue_name | Queue name on RabbitMQ | * Required |
message_limit | Number of messages to be processed | 0: Unlimited |
time | Time in seconds the process will be running | 0: Unlimited |
empty_queue_timeout | Time in seconds to kill listening when the queue is empty | 0: Unlimited |
connection_name | Server connection name | Defined at connections file |
exchange | Exchange name on RabbitMQ Server | Specified on connections file |
vhost | Virtual host on RabbitMQ Server | Specified on connections file |
By default the listen process will be running forever unless you specify one of the running time arguments above (message_limit, time, empty_queue_timeout). They can be mixed all together, so when one of the condition is met the process will be stopped.
This package is open-sourced software licensed under the MIT license