unreal4u / mqtt
Complete MQTT v3.1.1 implementation for PHP >=7.1.x
Installs: 1 385
Dependents: 2
Suggesters: 0
Security: 0
Stars: 15
Watchers: 5
Forks: 4
Open Issues: 4
Requires
- php: >=7.0.0
- ext-mbstring: *
- unreal4u/dummy-logger: ~1.0
Requires (Dev)
- monolog/monolog: ~1.17
- phpdocumentor/phpdocumentor: 2.*
- phpmd/phpmd: @stable
- phpstan/phpstan: ^0.8
- phpunit/phpunit: ^6.0
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-10-23 07:24:52 UTC
README
Complete PHP7.1+ MQTT client with full support for the MQTT version 3.1.1 protocol. This package is an entire rewrite of McFizh/libMQTT.
This project in badges
What is MQTT?
Please read the following wiki page for that :)
Don't forget to read the other articles which may contain more useful information:
What is QoS?
Difference between QoS and Retainability
What is ClientId?
Capabilities of this package:
This package is able to:
- Connect to the broker. You can connect with virtually all optional parameters the protocol supports, including Will Message. The only exception to the rule is the clean session flag. This is not tested and may or may not work as intended.
- Publish QoS level 0, 1 and 2 messages. All protocol supported parameters are also supported, such as retained messages and other options.
- Subscribe on QoS level 0, 1 and 2 topics. Connection handling will be done automatically, no need to fiddle with PingRequests and alike.
- Filters of topics are those used on the protocol itself, which eliminates the likeliness of bugs that may occur from incorrectly parsing such filters.
This package uses sockets to communicate (a)synchronously with the broker. If you don't want this, you are free to create your own client, for which you'll just have to implement an interface.
Examples
This package has many examples detailing the many things you can do with it. Please check the examples directory for more information. In case of questions or doubt, open up an Issue or submit a Pull Request if you feel the need to clarify, correct or add more examples.
References
[mqtt-v3.1.1-plus-errata01]
MQTT Version 3.1.1 Plus Errata 01. Edited by Andrew Banks and Rahul Gupta. 10 December 2015. OASIS Standard Incorporating Approved Errata 01. http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html. Latest version: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html.
Original library that served as inspiration for this one McFizh/libMQTT