Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markkimsal/amphp-mqtt
MQTT client for Amp
https://github.com/markkimsal/amphp-mqtt
amphp async message-queue mqtt php
Last synced: 27 days ago
JSON representation
MQTT client for Amp
- Host: GitHub
- URL: https://github.com/markkimsal/amphp-mqtt
- Owner: markkimsal
- Created: 2018-05-11T19:26:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-23T21:12:21.000Z (over 6 years ago)
- Last Synced: 2024-09-29T20:59:38.046Z (about 1 month ago)
- Topics: amphp, async, message-queue, mqtt, php
- Language: PHP
- Size: 56.6 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MQTT
`markkimsal/amphp-mqtt` is an asynchronous MQTT client for PHP based on Amp.
## Installation
```
composer require markkimsal/amphp-mqtt
```
This project does not require any PHP extensions.
## Usage
Every publish or subscribe returns an `Amp\Promise` that you can react to when it's resolved. Messages are received from `->on('message')` and that takes a callback with only 1 argument: the `Packet\Publish` class. `Packet\Publish` is used for both sending and receiving messages.
You can start sending and subscribing before the connection ack packet is received and the system will queue up your packets but still return a `Amp\Promise` immediately.
QoS 0 packets will resolve as soon as they are sent as they will not get any acknowledgement from the server.
QoS 1 packets will resolve when the client gets a Puback packet.
QoS 2 packets will resolve when the client gets a Pubcomp packet. The client will automatically respond to Pubrec with a Pubrel as per the spec.
Supports TLSv1.2 by using "tls://" prefix to the URI of the server. Peer verification is not done.
Supports username and password authentication as parameters of the connection URL.
```php
connect();
$p2 = $client->subscribe('test/', function($err, $resp) {
echo "***** SUBSCRIBE Resolved *******\n";
var_dump($err);
var_dump($resp);
});
$p->onResolve(function($err, $resp) use($p, $client){
echo "****** CONNECT Resolved ********\n";
});
$p2->onResolve(function($err, $res) {
echo "***** SUBSCRIBE Resolved in a different way *******\n";
var_dump($err);
var_dump($res);
});
$client->on('message', function($publishPacket) {
echo "****** got a message on topic: [".$publishPacket->getTopic()."] ***** \n";
echo $publishPacket->getMessage()."\n";
});
Loop::repeat(1000, function() use($client){
$client->publish('Current time is: '.date('H:i:s'), 'time', 0, function($err, $result) {
if (!$err) {
echo "***** Socket fired off Publish Packet with qos 0 *****\n";
}
});
});
});
```
Blocking mode (integration with sync code)
===
You can use this library in a synchronous backend to wait for sending packets with QoS 0,1, or 2.
```php
connect();
$p0 = $client->publishRetain('QoS0 Current time is: '.date('H:i:s'), 'time', 0, function($err, $result) {
if (!$err) {
echo "***** Socket fired off Publish Packet with qos 0 *****\n";
}
});
$p1 = $client->publish('QoS1 Current time is: '.date('H:i:s'), 'time', 1, function($err, $result) {
if (!$err) {
echo "***** Got Publish Ack with qos 1 *****\n";
}
});
$p2 = $client->publish('QoS2 Current time is: '.date('H:i:s'), 'time', 2, function($err, $result) {
if (!$err) {
echo "***** Got Publish Ack with qos 2 *****\n";
}
});
Amp\Promise\wait($p0);
Amp\Promise\wait($p1);
Amp\Promise\wait($p2);
return;
```
Manual Publish Acking
===
You can control when you acknowlege publish messages of QoS 1 and 2 by disabling the auto-ack feature.
Otherwise, the appropriate acknowledgement packets will be sent after the `on('message')` handler is run.
```php
disableAutoAck();
$p2 = $client->subscribe('test/#', function($err, $resp) {
echo "***** SUBSCRIBE Resolved *******\n";
});
$p = $client->connect();
$client->on('message', function($publishPacket) use($client) {
if ($publishPacket->isDup()) {
echo "****** got a DUP on topic: [".$publishPacket->getTopic()."] ***** \n";
echo $publishPacket->getMessage()."\n";
} else {
echo "****** got a message on topic: [".$publishPacket->getTopic()."] ***** \n";
echo $publishPacket->getMessage()."\n";
}
//save message with durability here
$client->acknowledge($publishPacket);
});
```
Clean Session
===
You can connect with a clean session by adding `cleanSession` as a URL parameter.
You MUST either use a clean session or supply a client ID.
If you do not supply a clientId a clean session is automatically created for you.
```php
include('vendor/autoload.php');
$client = new MarkKimsal\Mqtt\Client('tcp://172.17.0.1:1883?cleanSession');
```