stomp-php / stomp-php
stomp support for PHP
Installs: 3 300 480
Dependents: 22
Suggesters: 4
Security: 0
Stars: 123
Watchers: 8
Forks: 57
Open Issues: 24
Requires
- php: ^7.3|^8.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- dev-master
- 5.1.0
- 5.0.0
- 4.6.1
- 4.6.0
- 4.5.2
- 4.5.1
- 4.5.0
- 4.5.0-RC1
- 4.4.3
- 4.4.2
- 4.4.1
- 4.4.0
- 4.3.1
- 4.3.0
- 4.2.2
- 4.2.1
- 4.2.0
- 4.1.5
- 4.1.4
- 4.1.3
- 4.1.2
- 4.1.1
- 4.1.0
- 4.0.1
- 4.0.0
- 3.0.7
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.2.3
- 2.2.2
- 2.1.1
- 2.1.0
- 2.0.1
- 2.0.0
- dev-bugfix/135-handle-draining-messages
- dev-staabm-patch-1
- dev-support/version-3
- dev-support/version-2
This package is auto-updated.
Last update: 2024-11-22 05:22:51 UTC
README
This project is a PHP Stomp Client that besides it implements the Stomp protocol fully, brings some ActiveMQ and Apollo specific utils that could make your messaging from PHP easier.
Credits
This library was initially developed by Dejan Bosanac. We would like to thank you for your work and we're happy to continue it.
Version choice
- For new projects you should use version
4.*
which requiresphp-5.6
. Support forphp-5.6
ends with version5.*
. - For projects running older php versions you can use version
4.2.*
forphp-5.5
and3.*
forphp-5.3
, please consider to update php. - For running projects with
fusesource/stomp-php@2.x
clients you can use version2.2.2
. - All version newer that
2.x
won't be compatible withfusesource/stomp-php
. (https://github.com/dejanb/stomp-php.)
Installing
composer require stomp-php/stomp-php
Examples
You find different usage tutorials in our example project https://github.com/stomp-php/stomp-php-examples.
Connection Probing
It's hard to find out if a socket connection is still working or not, Stomp allows us to use heartbeats to test if client and server are ready to serve messages.
You should use \Stomp\Network\Observer\ServerAliveObserver
or \Stomp\Network\Observer\HeartbeatEmitter
to receive or
send heartbeats. Doing so will ensure that your client will detect a broken connection in time. Please have a look at
https://github.com/stomp-php/stomp-php-examples for some example code with additonal comments.
Replace fusesource/stomp-php
If you used fusesource/stomp-php
before, you can use our 2.x
versions.
"require": { "stomp-php/stomp-php": "2.*" }
Contributing
We code in PSR2
, please use our predefined pre_commit.sh
hook.
Tests
To run the tests you first need to fetch the dependencies for the test suite via composer:
$ php composer.phar install
The functional testsuite is divided into three broker versions.
Currently it's running on ActiveMq
(Port 61010), Apollo
(61020), RabbitMq
(61030), Artemis
(61040).
Apollo should be configured to use admin:password and RabbitMq to guest:guest.
While ActiveMq must be configured to use no login at all.
You can setup all brokers by running travisci/bin/start.sh
. Stop them by travisci/bin/stop.sh
. (Docker is required.)
If you only like to run the functional generic tests, ensure Apollo is configured.
A basic setup can be achieved by running ./travisci/bin/apollo-mq.sh 1.7.1
.
(If you want to create a local running broker, you find the config / setup at travisci/docker/apollo-mq/
)