kaliop/queueingbundle-stomp

Kaliop Queueing Bundle - Stomp plugin

v0.3.1 2019-10-28 22:33 UTC

Requires

• fusesource/stomp-php: ^2.1
• kaliop/queueingbundle: ~0.8
• symfony/config: ^2.4 || ^3.0 || ^4.0
• symfony/dependency-injection: ^2.4 || ^3.0 || ^4.0
• symfony/http-kernel: ^2.4 || ^3.0 || ^4.0

Requires (Dev)

• phpunit/phpunit: ^5.7 || ^7.5
• symfony/symfony: ^2.4 || ^3.0 || ^4.0

GPL-2.0

README

Adds support for the STOMP protocol to the Kaliop Queueing Bundle

STOMP is a protocol used by multiple messaging brokers, such as ActiveMQ, Apache Apollo and RabbitMQ (but we suggest you use AMQP to communicate with RabbitMQ, which is supported natively by the Queueing Bundle)

Currently the bundle is tested using Apache Apollo and Apache ActiveMQ.

See: https://stomp.github.io and https://github.com/kaliop-uk/kueueingbundle respectively for more details.

Installation

1. Install the bundle via Composer.

2. Enable the KaliopQueueingPluginsStompBundle bundle in your kernel class registerBundles().

3. Clear all caches if not on a dev environment

Usage

1. Start the messaging broker of your choice

2. Create a queue, using the appropriate management console:

   • Apollo: : no need, queues and topics are created based on need

   • ActiveMQ: no need, queues and topics are created based on need

   • RabbitMQ:

3. Set up configuration according to your broker

   • copy queueingbundle_stomp_sample.yml in this bundle to your app/config folder, make sure you require it, and edit it

4. check that you can list the queue:

    php app/console kaliop_queueing:managequeue list-configured -istomp
   

   not yet supported: ask the broker for queue info

    php app/console kaliop_queueing:managequeue info -istomp <queue>
   

5. push a message to the queue

    php app/console kaliop_queueing:queuemessage -istomp <queue> <jsonpayload>
   

6. receive messages from the queue

    php app/console kaliop_queueing:consumer -istomp <queue>
   

Notes

• Stomp does not natively support routing-keys the way that RabbitMQ does. Also, the implementation of Topic and Queue messaging patterns is left to the single brokers.

  This bundle does add back support for routing-keys. It also strives to replicate the same messaging pattern regardless of the broker in use. The way to achieve that differs with each broker.

  In particular:

  • for Apollo, topics with persistent subscriptions are used
  • for ActiveMQ, 'Virtual Topics' are used ( http://activemq.apache.org/virtual-destinations.html )
  • NB: ActiveMQ 5.5 seems to have a bug with wildcard support when using '#' as key. If this is a problem for you, please upgrade to a later version

  In the bundle configuration, the same wildcard characters are to be used regardless of teh broker in use: # and *