Generic MonoBehavior wrapping a MQTT client, using a double buffer to postpone message processing in the main thread. More...
Public Member Functions | |
| virtual void | Connect () |
| Connect to the broker using current settings. More... | |
| virtual void | Disconnect () |
| Disconnect from the broker, if connected. More... | |
Public Attributes | |
| string | brokerAddress = "localhost" |
| int | brokerPort = 1883 |
| bool | isEncrypted = false |
| int | connectionDelay = 500 |
| int | timeoutOnConnection = MqttSettings.MQTT_CONNECT_TIMEOUT |
| bool | autoConnect = false |
Protected Member Functions | |
| virtual void | OnConnecting () |
| Ovverride this method to take some actions before connection (e.g. More... | |
| virtual void | OnConnected () |
| Override this method to take some actions if the connection succeeded. More... | |
| virtual void | OnConnectionFailed (string errorMessage) |
| Override this method to take some actions if the connection failed. More... | |
| virtual void | SubscribeTopics () |
| Ovverride this method to subscribe to MQTT topics. More... | |
| virtual void | UnsubscribeTopics () |
| Ovverride this method to unsubscribe to MQTT topics (they should be the same you subscribed to with SubscribeTopics() ). More... | |
| virtual void | OnApplicationQuit () |
| Disconnect before the application quits. More... | |
| virtual void | Awake () |
| Initialize MQTT message queue Remember to call base.Awake() if you override this method. More... | |
| virtual void | Start () |
| Connect on startup if autoConnect is set to true. More... | |
| virtual void | DecodeMessage (string topic, byte[] message) |
| Override this method for each received message you need to process. More... | |
| virtual void | OnDisconnected () |
| Override this method to take some actions when disconnected. More... | |
| virtual void | OnConnectionLost () |
| Override this method to take some actions when the connection is closed. More... | |
| virtual void | Update () |
| Processing of income messages and events is postponed here in the main thread. More... | |
| virtual void | ProcessMqttEvents () |
Protected Attributes | |
| MqttClient | client |
| Wrapped MQTT client More... | |
Events | |
| Action | ConnectionSucceeded |
| Event fired when a connection is successfully estabilished More... | |
| Action | ConnectionFailed |
| Event fired when failing to connect More... | |
Detailed Description
Generic MonoBehavior wrapping a MQTT client, using a double buffer to postpone message processing in the main thread.
Member Function Documentation
◆ Awake()
|
protectedvirtual |
Initialize MQTT message queue Remember to call base.Awake() if you override this method.
◆ Connect()
|
virtual |
Connect to the broker using current settings.
◆ DecodeMessage()
|
protectedvirtual |
Override this method for each received message you need to process.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ Disconnect()
|
virtual |
Disconnect from the broker, if connected.
◆ OnApplicationQuit()
|
protectedvirtual |
Disconnect before the application quits.
◆ OnConnected()
|
protectedvirtual |
Override this method to take some actions if the connection succeeded.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ OnConnecting()
|
protectedvirtual |
Ovverride this method to take some actions before connection (e.g.
display a message)
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ OnConnectionFailed()
|
protectedvirtual |
Override this method to take some actions if the connection failed.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ OnConnectionLost()
|
protectedvirtual |
Override this method to take some actions when the connection is closed.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ OnDisconnected()
|
protectedvirtual |
Override this method to take some actions when disconnected.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ ProcessMqttEvents()
|
protectedvirtual |
◆ Start()
|
protectedvirtual |
Connect on startup if autoConnect is set to true.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ SubscribeTopics()
|
protectedvirtual |
Ovverride this method to subscribe to MQTT topics.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ UnsubscribeTopics()
|
protectedvirtual |
Ovverride this method to unsubscribe to MQTT topics (they should be the same you subscribed to with SubscribeTopics() ).
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
◆ Update()
|
protectedvirtual |
Processing of income messages and events is postponed here in the main thread.
Remember to call ProcessMqttEvents() in Update() method if you override it.
Reimplemented in M2MqttUnity.Examples.M2MqttUnityTest.
Member Data Documentation
◆ autoConnect
| bool M2MqttUnity.M2MqttUnityClient.autoConnect = false |
◆ brokerAddress
| string M2MqttUnity.M2MqttUnityClient.brokerAddress = "localhost" |
◆ brokerPort
| int M2MqttUnity.M2MqttUnityClient.brokerPort = 1883 |
◆ client
|
protected |
Wrapped MQTT client
◆ connectionDelay
| int M2MqttUnity.M2MqttUnityClient.connectionDelay = 500 |
◆ isEncrypted
| bool M2MqttUnity.M2MqttUnityClient.isEncrypted = false |
◆ timeoutOnConnection
| int M2MqttUnity.M2MqttUnityClient.timeoutOnConnection = MqttSettings.MQTT_CONNECT_TIMEOUT |
Event Documentation
◆ ConnectionFailed
| Action M2MqttUnity.M2MqttUnityClient.ConnectionFailed |
Event fired when failing to connect
◆ ConnectionSucceeded
| Action M2MqttUnity.M2MqttUnityClient.ConnectionSucceeded |
Event fired when a connection is successfully estabilished
The documentation for this class was generated from the following file:
- D:/Unity3D/Projects/IoT/M2MqttUnity/Assets/M2MqttUnity/Scripts/M2MqttUnityClient.cs
