Difference between revisions of "OpcLabs.Mqtt communication package"

From OPC Labs Knowledge Base
Jump to navigation Jump to search
Line 8: Line 8:
 
|ClientWaitTimeout
 
|ClientWaitTimeout
 
|System.Int32
 
|System.Int32
|
+
|Determines the maximum wait time for the client to open before publishing a message. In milliseconds.
 
|-
 
|-
 
|ErrorWaitDelay
 
|ErrorWaitDelay

Revision as of 09:55, 13 December 2019

OpcLabs.Mqtt

Configuration

The table below lists the available properties, their types, and descriptions. Many properties come from configurable options of the underlying library. Most properties can usually stay at their defaults, and those that cannot are usually overridden from the host software (as noted). We will emphasize specific properties if they are important.

ClientWaitTimeout System.Int32 Determines the maximum wait time for the client to open before publishing a message. In milliseconds.
ErrorWaitDelay System.Int32
MqttConfiguration System.Net.Mqtt.MqttConfiguration General configuration used across the protocol implementation.
MqttConfiguration.AllowWildcardsInTopicFilters System.Boolean Determines if multi level (#) and single level (+) wildcards are allowed on topic filters. Default value is true.
MqttConfiguration.BufferSize System.Int32 Size in bytes of the receive buffer of the underlying transport protocol. Only use it when the property applies to the undelrying protocol used.
MqttConfiguration.ConnectionTimeoutSecs System.Int32 Seconds to wait for a channel connection until the operation timeouts. This value is generally used to wait for the MQTT channel to open. Default value is 5 seconds.
MqttConfiguration.KeepAliveSecs System.UInt16 Seconds to wait for the MQTT Keep Alive mechanism until a Ping packet is sent to maintain the connection alive. Default value is 0 seconds, which means Keep Alive disabled.
MqttConfiguration.MaximumQualityOfService System.Net.Mqtt.MqttQualityOfService Maximum Quality of Service (QoS) to support. Default value is AtMostOnce, which means QoS 0.
MqttConfiguration.Port System.Int32 Port to connect a Client to a Server.
MqttConfiguration.WaitTimeoutSecs System.Int32 Seconds to wait for an incoming required message until the operation timeouts. This value is generally used to wait for Server or Client acknowledgements. Default value is 5 seconds.
OpenFailureWaitDelay System.Int32
RemoteDisconnectedWaitDelay System.Int32