Move MaxReconnectInterval to MQTT backend level.

This way it applies to all backends and not only to the generic
authentication. Note that auto-reconnect (by the library) was disabled
and was handled by the onConnectionLost handler.

Author: brocaar

cmd/lora-gateway-bridge/cmd/configfile.go

@@ -130,6 +130,10 @@ marshaler="{{ .Integration.Marshaler }}"
   # Command topic template.
   command_topic_template="{{ .Integration.MQTT.CommandTopicTemplate }}"
 
+  # Maximum interval that will be waited between reconnection attempts when connection is lost.
+  # Valid units are 'ms', 's', 'm', 'h'. Note that these values can be combined, e.g. '24h30m15s'.
+  max_reconnect_interval="{{ .Integration.MQTT.MaxReconnectInterval }}"
+
 
   # MQTT authentication.
   [integration.mqtt.auth]
@@ -186,10 +190,6 @@ marshaler="{{ .Integration.Marshaler }}"
     # mqtt TLS key file (optional)
     tls_key="{{ .Integration.MQTT.Auth.Generic.TLSKey }}"
 
-    # Maximum interval that will be waited between reconnection attempts when connection is lost.
-    # Valid units are 'ms', 's', 'm', 'h'. Note that these values can be combined, e.g. '24h30m15s'.
-    max_reconnect_interval="{{ .Integration.MQTT.Auth.Generic.MaxReconnectInterval }}"
-
 
     # Google Cloud Platform Cloud IoT Core authentication.
     #

cmd/lora-gateway-bridge/cmd/root.go

@@ -54,10 +54,10 @@ func init() {
 
 	viper.SetDefault("integration.mqtt.event_topic_template", "gateway/{{ .GatewayID }}/event/{{ .EventType }}")
 	viper.SetDefault("integration.mqtt.command_topic_template", "gateway/{{ .GatewayID }}/command/#")
+	viper.SetDefault("integration.mqtt.max_reconnect_interval", 10*time.Minute)
 
 	viper.SetDefault("integration.mqtt.auth.generic.server", "tcp://127.0.0.1:1883")
 	viper.SetDefault("integration.mqtt.auth.generic.clean_session", true)
-	viper.SetDefault("integration.mqtt.auth.generic.max_reconnect_interval", 10*time.Minute)
 
 	viper.SetDefault("integration.mqtt.auth.gcp_cloud_iot_core.server", "ssl://mqtt.googleapis.com:8883")
 	viper.SetDefault("integration.mqtt.auth.gcp_cloud_iot_core.jwt_expiration", time.Hour*24)

docs/content/install/config.md

@@ -176,6 +176,10 @@ marshaler="protobuf"
   # Command topic template.
   command_topic_template="gateway/{{ .GatewayID }}/command/#"
 
+  # Maximum interval that will be waited between reconnection attempts when connection is lost.
+  # Valid units are 'ms', 's', 'm', 'h'. Note that these values can be combined, e.g. '24h30m15s'.
+  max_reconnect_interval="10m0s"
+
 
   # MQTT authentication.
   [integration.mqtt.auth]
@@ -232,10 +236,6 @@ marshaler="protobuf"
     # mqtt TLS key file (optional)
     tls_key=""
 
-    # Maximum interval that will be waited between reconnection attempts when connection is lost.
-    # Valid units are 'ms', 's', 'm', 'h'. Note that these values can be combined, e.g. '24h30m15s'.
-    max_reconnect_interval="10m0s"
-
 
     # Google Cloud Platform Cloud IoT Core authentication.
     #

internal/config/config.go

@@ -47,23 +47,23 @@ type Config struct {
 		Marshaler string `mapstructure:"marshaler"`
 
 		MQTT struct {
-			EventTopicTemplate   string `mapstructure:"event_topic_template"`
-			CommandTopicTemplate string `mapstructure:"command_topic_template"`
+			EventTopicTemplate   string        `mapstructure:"event_topic_template"`
+			CommandTopicTemplate string        `mapstructure:"command_topic_template"`
+			MaxReconnectInterval time.Duration `mapstructure:"max_reconnect_interval"`
 
 			Auth struct {
 				Type string `mapstructure:"type"`
 
 				Generic struct {
-					Server               string        `mapstructure:"server"`
-					Username             string        `mapstructure:"username"`
-					Password             string        `mapstrucure:"password"`
-					CACert               string        `mapstructure:"ca_cert"`
-					TLSCert              string        `mapstructure:"tls_cert"`
-					TLSKey               string        `mapstructure:"tls_key"`
-					QOS                  uint8         `mapstructure:"qos"`
-					CleanSession         bool          `mapstructure:"clean_session"`
-					ClientID             string        `mapstructure:"client_id"`
-					MaxReconnectInterval time.Duration `mapstructure:"max_reconnect_interval"`
+					Server       string `mapstructure:"server"`
+					Username     string `mapstructure:"username"`
+					Password     string `mapstrucure:"password"`
+					CACert       string `mapstructure:"ca_cert"`
+					TLSCert      string `mapstructure:"tls_cert"`
+					TLSKey       string `mapstructure:"tls_key"`
+					QOS          uint8  `mapstructure:"qos"`
+					CleanSession bool   `mapstructure:"clean_session"`
+					ClientID     string `mapstructure:"client_id"`
 				} `mapstructure:"generic"`
 
 				GCPCloudIoTCore struct {

internal/integration/mqtt/auth/generic.go

@@ -12,12 +12,11 @@ import (
 
 // GenericAuthentication implements a generic MQTT authentication.
 type GenericAuthentication struct {
-	server               string
-	username             string
-	password             string
-	cleanSession         bool
-	clientID             string
-	maxReconnectInterval time.Duration
+	server       string
+	username     string
+	password     string
+	cleanSession bool
+	clientID     string
 
 	tlsConfig *tls.Config
 }
@@ -36,12 +35,11 @@ func NewGenericAuthentication(conf config.Config) (Authentication, error) {
 	return &GenericAuthentication{
 		tlsConfig: tlsConfig,
 
-		server:               conf.Integration.MQTT.Auth.Generic.Server,
-		username:             conf.Integration.MQTT.Auth.Generic.Username,
-		password:             conf.Integration.MQTT.Auth.Generic.Password,
-		cleanSession:         conf.Integration.MQTT.Auth.Generic.CleanSession,
-		clientID:             conf.Integration.MQTT.Auth.Generic.ClientID,
-		maxReconnectInterval: conf.Integration.MQTT.Auth.Generic.MaxReconnectInterval,
+		server:       conf.Integration.MQTT.Auth.Generic.Server,
+		username:     conf.Integration.MQTT.Auth.Generic.Username,
+		password:     conf.Integration.MQTT.Auth.Generic.Password,
+		cleanSession: conf.Integration.MQTT.Auth.Generic.CleanSession,
+		clientID:     conf.Integration.MQTT.Auth.Generic.ClientID,
 	}, nil
 }
 
@@ -52,7 +50,6 @@ func (a *GenericAuthentication) Init(opts *mqtt.ClientOptions) error {
 	opts.SetPassword(a.password)
 	opts.SetCleanSession(a.cleanSession)
 	opts.SetClientID(a.clientID)
-	opts.SetMaxReconnectInterval(a.maxReconnectInterval)
 
 	if a.tlsConfig != nil {
 		opts.SetTLSConfig(a.tlsConfig)

internal/integration/mqtt/backend.go

@@ -121,6 +121,7 @@ func NewBackend(conf config.Config) (*Backend, error) {
 	b.clientOpts.SetAutoReconnect(true) // this is required for buffering messages in case offline!
 	b.clientOpts.SetOnConnectHandler(b.onConnected)
 	b.clientOpts.SetConnectionLostHandler(b.onConnectionLost)
+	b.clientOpts.SetMaxReconnectInterval(conf.Integration.MQTT.MaxReconnectInterval)
 
 	if err = b.auth.Init(b.clientOpts); err != nil {
 		return nil, errors.Wrap(err, "mqtt: init authentication error")