更新文档

imiphp · May 26, 2020 · 822ac2f · 822ac2f
1 parent 39a543c
commit 822ac2f
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 0 deletions.
diff --git a/doc/components/mqtt/client.md b/doc/components/mqtt/client.md
@@ -16,6 +16,120 @@
 
 ## 使用
 
+
+**事件监听类：**
+
+```php
+<?php
+namespace Imi\MQTT\Test;
+
+use Imi\MQTT\Client\Contract\IMQTTClientListener;
+
+class TestClientListener implements IMQTTClientListener
+{
+    /**
+     * 连接确认
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\ConnectResponsePacket $packet
+     * @return void
+     */
+    public function connectACK(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\ConnectResponsePacket $packet)
+    {
+    }
+
+    /**
+     * 发布
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PublishRequestPacket $packet
+     * @return void
+     */
+    public function publish(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PublishRequestPacket $packet)
+    {
+    }
+
+    /**
+     * 发布确认
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PublishAckPacket $packet
+     * @return void
+     */
+    public function publishAck(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PublishAckPacket $packet)
+    {
+    }
+
+    /**
+     * 发布已收到（保证交付部分1）
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PublishReceivedPacket $packet
+     * @return void
+     */
+    public function publishReceived(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PublishReceivedPacket $packet)
+    {
+    }
+
+    /**
+     * 发布释放（确保交付的第2部分）
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PublishReleasePacket $packet
+     * @return void
+     */
+    public function publishRelease(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PublishReleasePacket $packet)
+    {
+    }
+
+    /**
+     * 发布完成（保证交付的第3部分）
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PublishCompletePacket $packet
+     * @return void
+     */
+    public function publishComplete(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PublishCompletePacket $packet)
+    {
+    }
+
+    /**
+     * 订阅确认
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\SubscribeResponsePacket $packet
+     * @return void
+     */
+    public function subscribeACK(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\SubscribeResponsePacket $packet)
+    {
+    }
+
+    /**
+     * 取消订阅确认
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\UnsubscribeResponsePacket $packet
+     * @return void
+     */
+    public function unsubscribeACK(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\UnsubscribeResponsePacket $packet)
+    {
+    }
+
+    /**
+     * Ping 响应
+     *
+     * @param \Imi\MQTT\Client\MQTTClient $client
+     * @param \BinSoul\Net\Mqtt\Packet\PingResponsePacket $packet
+     * @return void
+     */
+    public function ping(\Imi\MQTT\Client\MQTTClient $client, \BinSoul\Net\Mqtt\Packet\PingResponsePacket $packet)
+    {
+    }
+}
+```
+
+**客户端调用：**
+
 ```php
 use Imi\MQTT\Client\MQTTClient;
 $client = new MQTTClient([

diff --git a/doc/components/mqtt/server.md b/doc/components/mqtt/server.md
@@ -49,6 +49,14 @@ MQTT是一个基于客户端-服务器的消息发布/订阅传输协议。MQTT
 ],
 ```
 
+### 通讯数据包类
+
+`imi-mqtt` 基于 `binsoul/net-mqtt` 开发，使用的都是这个包中的数据包结构类。
+
+类名一般是`BinSoul\Net\Mqtt\Packet\XXX`
+
+如：`\BinSoul\Net\Mqtt\Packet\SubscribeRequestPacket`
+
 ## 控制器
 
 ```php