MqttListener¶
Description¶
The MqttListener object represents a listener of an MQTT broker. A listener provides access to a broker via the configured port.
This object was introduced in InCore 2.6.
| › Inherits: | Object |
|---|
Properties¶
aclFile¶
This property holds the path to an external Mosquitto ACL file.See the mosquitto.conf man page for details.
This property was introduced in InCore 2.3.
| › Type: | String |
|---|---|
| › Signal: | aclFileChanged() |
| › Attributes: | Writable |
allowAnonymous¶
This property holds whether clients that connect without providing a username are allowed to connect.
This property was introduced in InCore 2.3.
| › Type: | Boolean |
|---|---|
| › Default: | true |
| › Signal: | allowAnonymousChanged() |
| › Attributes: | Writable |
internal¶
This property holds whether the broker should listen for incoming connections on the local loopback interface only. If set to true the broker will not be reachable by other hosts on the network but internal clients such as docker containers (DockerContainer) only.
| › Type: | Boolean |
|---|---|
| › Default: | true |
| › Signal: | internalChanged() |
| › Attributes: | Writable |
passwordFile¶
This property holds the path to Mosquitto password file managed externally via mosquitto_passwd. See the mosquitto_passwd man page for details.
This property was introduced in InCore 2.3.
| › Type: | String |
|---|---|
| › Signal: | passwordFileChanged() |
| › Attributes: | Writable |
port¶
This property holds the TCP port number which the broker should listen at for incoming connections.
| › Type: | SignedInteger |
|---|---|
| › Default: | -1 |
| › Signal: | portChanged() |
| › Attributes: | Writable |
protocol¶
This property holds the protocol which to use for communication with clients.
| › Type: | Protocol |
|---|---|
| › Default: | MqttListener.Mqtt |
| › Signal: | protocolChanged() |
| › Attributes: | Writable |