Skip to content

Latest commit

 

History

History
155 lines (95 loc) · 3.82 KB

README.md

File metadata and controls

155 lines (95 loc) · 3.82 KB
Raw

php-amqplib

Build Status

This library is a pure PHP implementation of the AMQP protocol. It's been tested against RabbitMQ.

Requirements: PHP 5.3 due to the use of namespaces.

BC BREAKING CHANGES

Since version 2.0 this library uses AMQP 0.9.1 by default. You shouldn't need to change your code, but test before upgrading.

New since version 2.0

Since now the library uses AMQP 0.9.1 we added support for the following RabbitMQ extensions:

  • Exchange to Exchange Bindings
  • Basic Nack

Extensions that modify existing methods like alternate exchanges are also supported.

Setup

Get the library source code:

$ git clone git://github.com/videlalvaro/php-amqplib.git

Class autoloading and dependencies are managed by composer so install it:

$ curl --silent https://getcomposer.org/installer | php

And then install the library dependencies and genereta the autoload.php file:

$ php composer.phar install

Usage

With RabbitMQ running open two Terminals and on the first one execute the following commands to start the consumer:

$ cd php-amqplib/demo
$ php amqp_consumer.php

Then on the other Terminal do:

$ cd php-amqplib/demo
$ php amqp_publisher.php some text to publish

You should see the message arriving to the process on the other Terminal

Then to stop the consumer, send to it the quit message:

$ php amqp_publisher.php quit

If you need to listen to the sockets used to connect to RabbitMQ then see the example in the non blocking consumer.

$ php amqp_consumer_non_blocking.php

More Examples

  • amqp_ha_consumer.php: demoes the use of mirrored queues
  • amqp_consumer_exclusive.php and amqp_publisher_exclusive.php: demoes fanout exchanges using exclusive queues.
  • amqp_consumer_fanout_{1,2}.php and amqp_publisher_fanout.php: demoes fanout exchanges with named queues.
  • basic_get.php: demoes obtaining messages from the queues by using the basic get AMQP call.

Debugging

If you want to know what's going on at a protocol level then call the enableDebug() method in the AMQPChannel object:

<?php
$conn = new AMQPConnection(HOST, PORT, USER, PASS, VHOST);
$ch = $conn->channel();

// Enable debug at the protocol level
$ch->enableDebug();

... more code

// Disable debug
$ch->disableDebug();


?>

Benchmarks

To run the publishing/consume benchmark type:

$ make benchmark

Tests

To successfully run the tests you need to first setup the test user and test virtual host.

You can do that by running the following commands after starting RabbitMQ:

$ rabbitmqctl add_vhost phpamqplib_testbed
$ rabbitmqctl add_user phpamqplib phpamqplib_password
$ rabbitmqctl set_permissions -p phpamqplib_testbed phpamqplib ".*" ".*" ".*"

Once your environment is set up you can run your tests like this:

$ make test

Using AMQP 0.8

If you still want to use the old version of the protcol then you can do it by settings the following constant in your configuration code:

define('AMQP_PROTOCOL', '0.8');

The default value is '0.9.1'.

Original README:

Below is the original README file content. Credits goes to the original authors.

PHP library implementing Advanced Message Queuing Protocol (AMQP).

The library is port of python code of py-amqplib http://barryp.org/software/py-amqplib/

It have been tested with RabbitMQ server.

Project home page: http://code.google.com/p/php-amqplib/

For discussion, please join the group:

http://groups.google.com/group/php-amqplib-devel

For bug reports, please use bug tracking system at the project page.

Patches are very welcome!

Author: Vadim Zaliva [email protected]