Merge branch 'master' into MQTT5

simps · Dec 15, 2020 · dc0faa1 · dc0faa1
2 parents d01c7f0 + 8c61d28
commit dc0faa1
Show file tree

Hide file tree

Showing 9 changed files with 399 additions and 4 deletions.
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+mqtt.simps.io
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,3 @@
+- Translations
+    - [:cn: 中文](/zh-cn/)
+    - [:uk: English](/en/)
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -0,0 +1,171 @@
+# MQTT Coroutine Client
+
+MQTT Protocol Analysis and Coroutine Client for PHP.
+
+[![Latest Stable Version](https://poser.pugx.org/simps/mqtt/v)](//packagist.org/packages/simps/mqtt)
+[![Total Downloads](https://poser.pugx.org/simps/mqtt/downloads)](//packagist.org/packages/simps/mqtt)
+[![Latest Unstable Version](https://poser.pugx.org/simps/mqtt/v/unstable)](//packagist.org/packages/simps/mqtt)
+[![License](https://poser.pugx.org/simps/mqtt/license)](https://github.com/simps/mqtt/blob/master/LICENSE)
+
+## Install
+
+```bash
+composer require simps/mqtt
+```
+
+## Examples
+
+see [examples](https://github.com/simps/mqtt/tree/master/examples)
+
+## Client API
+
+### __construct()
+
+Create a MQTT client instance
+
+```php
+Simps\MQTT\Client::__construct(array $config, array $swConfig = [], int $type = SWOOLE_SOCK_TCP)
+```
+
+* `array $config`
+
+An array of client options, you can set the following options:
+
+```php
+$config = [
+    'host' => '127.0.0.1',
+    'port' => 1883,
+    'time_out' => 5,
+    'user_name' => '',
+    'password' => '',
+    'client_id' => '',
+    'keep_alive' => 10,
+    'protocol_name' => 'MQTT', // or MQIsdp
+    'protocol_level' => 4, // or 3
+];
+```
+
+* `array $swConfig`
+
+To set the configuration of `Swoole\Coroutine\Client`, please see Swoole document: [set()](https://www.swoole.co.uk/docs/modules/swoole-coroutine-client-set)
+
+### connect()
+
+Connect Broker
+
+```php
+Simps\MQTT\Client->connect(bool $clean = true, array $will = [])
+```
+
+* `bool $clean`
+
+Clean session. default is `true`. see [Clean Session](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180843)
+
+* `array $will`
+
+When a client is disconnected, Broker will automatically send a will message to other clients
+
+```php
+$will = [
+    'topic' => '',
+    'qos' => 1,
+    'retain' => 0,
+    'content' => '',
+];
+```
+
+### publish()
+
+push a message to a topic
+
+```php
+Simps\MQTT\Client->publish($topic, $content, $qos = 0, $dup = 0, $retain = 0)
+```
+
+### subscribe()
+
+Subscribe to one topic or multiple topics
+
+```php
+Simps\MQTT\Client->subscribe(array $topics)
+```
+
+* `array $topics`
+
+```php
+$topics = [
+    // topic => Qos
+    'topic1' => 0, 
+    'topic2' => 1,
+];
+```
+
+### unSubscribe()
+
+Unsubscribe from a topic or multiple topics
+
+```php
+Simps\MQTT\Client->unSubscribe(array $topics)
+```
+
+* `array $topics`
+
+```php
+$topics = ['topic1', 'topic2'];
+```
+
+### close()
+
+Disconnect from Broker connect. The `DISCONNECT(14)` message is send to Broker
+
+```php
+Simps\MQTT\Client->close()
+```
+
+### recv()
+
+Receive messages
+
+```php
+Simps\MQTT\Client->recv(): bool|arary|string
+```
+
+### send()
+
+Send messages
+
+```php
+Simps\MQTT\Client->send(array $data, $response = true)
+```
+
+* `array $data`
+
+`$data` is the data to be sent and must contain information such as `type`
+
+* `bool $response`
+
+Are acknowledgements required. If `true`, `recv()` is called once
+
+### ping()
+
+Send a heartbeat
+
+```php
+Simps\MQTT\Client->ping()
+```
+
+### buildMessageId()
+
+Generate MessageId
+
+```php
+Simps\MQTT\Client->buildMessageId()
+```
+
+### genClientId()
+
+Generate ClientId
+
+```php
+Simps\MQTT\Client->genClientID()
+```
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Simps MQTT 文档</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="由 Simps 提供的适用于 PHP 的 MQTT 协议解析和协程客户端
+">
+  <meta name="keywords" content="php,协程,swoole,swoole4,mqtt,mqtt3.1,mqtt5.0,mqtt客户端,mqtt协程客户端">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+  <style>
+    .app-name-link img {
+      width: 50%;
+    }
+  </style>
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'MQTT',
+      repo: 'simps/mqtt',
+      homepage: 'zh-cn/README.md',
+      logo: 'https://cdn.jsdelivr.net/gh/sy-records/staticfile@master/images/simps.png',
+      themeColor: '#5C9DFF',
+      loadNavbar: true,
+      auto2top: true,
+      alias: {
+        '/.*/_navbar.md': '/_navbar.md',
+      },
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/gh/sy-records/staticfile/js/docsify/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
+</body>
+</html>