Thu, 30 Dec 2021 11:47:53 +0100
Updated version info to indicate relation to eric7.
108
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</title> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
115
357257ad48d2
Updated version info to indicate relation to eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
108
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
108
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</h1> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <p> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | Module implementing the translated MQTT v5 reason codes. |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | </p> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | <h3>Global Attributes</h3> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | <table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | <tr><td>MqttReasonCodeNames</td></tr> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Classes</h3> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <tr><td>None</td></tr> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | </table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <h3>Functions</h3> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <tr> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <td><a href="#mqttReasonCode">mqttReasonCode</a></td> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <td>Function to get the readable reason code string given the result code and the packet type.</td> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | </tr> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | </table> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <hr /> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <hr /> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <a NAME="mqttReasonCode" ID="mqttReasonCode"></a> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <h2>mqttReasonCode</h2> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <b>mqttReasonCode</b>(<i>rc, packetType</i>) |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <p> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | Function to get the readable reason code string given the result code and |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | the packet type. |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | </p> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | <dt><i>rc</i> (int)</dt> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | result code |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | </dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <dt><i>packetType</i> (PacketTypes (= int))</dt> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | packet type |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | </dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | </dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | <dt>Return:</dt> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | <dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | message associated with the reason code and packet type |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | </dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | </dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <dt>Return Type:</dt> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | str |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | </dd> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </dl> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <div align="right"><a href="#top">Up</a></div> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <hr /> |
d7808a71b234
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | </body></html> |