mqtt/M2Mqtt/MqttSettings.cs

/*
Copyright (c) 2013, 2014 Paolo Patierno

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
and Eclipse Distribution License v1.0 which accompany this distribution. 

The Eclipse Public License is available at 
   http://www.eclipse.org/legal/epl-v10.html
and the Eclipse Distribution License is available at 
   http://www.eclipse.org/org/documents/edl-v10.php.

Contributors:
   Paolo Patierno - initial API and implementation and/or initial documentation
*/

using System;

namespace uPLibrary.Networking.M2Mqtt {
  /// <summary>
  /// Settings class for the MQTT broker
  /// </summary>
  public class MqttSettings {
    // default port for MQTT protocol
    public const Int32 MQTT_BROKER_DEFAULT_PORT = 1883;
    public const Int32 MQTT_BROKER_DEFAULT_SSL_PORT = 8883;
    // default timeout on receiving from client
    public const Int32 MQTT_DEFAULT_TIMEOUT = 30000;
    // max publish, subscribe and unsubscribe retry for QoS Level 1 or 2
    public const Int32 MQTT_ATTEMPTS_RETRY = 3;
    // delay for retry publish, subscribe and unsubscribe for QoS Level 1 or 2
    public const Int32 MQTT_DELAY_RETRY = 10000;
    // broker need to receive the first message (CONNECT)
    // within a reasonable amount of time after TCP/IP connection 
    public const Int32 MQTT_CONNECT_TIMEOUT = 30000;
    // default inflight queue size
    public const Int32 MQTT_MAX_INFLIGHT_QUEUE_SIZE = Int32.MaxValue;

    /// <summary>
    /// Listening connection port
    /// </summary>
    public Int32 Port { get; internal set; }

    /// <summary>
    /// Listening connection SSL port
    /// </summary>
    public Int32 SslPort { get; internal set; }

    /// <summary>
    /// Timeout on client connection (before receiving CONNECT message)
    /// </summary>
    public Int32 TimeoutOnConnection { get; internal set; }

    /// <summary>
    /// Timeout on receiving
    /// </summary>
    public Int32 TimeoutOnReceiving { get; internal set; }

    /// <summary>
    /// Attempts on retry
    /// </summary>
    public Int32 AttemptsOnRetry { get; internal set; }

    /// <summary>
    /// Delay on retry
    /// </summary>
    public Int32 DelayOnRetry { get; internal set; }

    /// <summary>
    /// Inflight queue size
    /// </summary>
    public Int32 InflightQueueSize { get; set; }

    /// <summary>
    /// Singleton instance of settings
    /// </summary>
    public static MqttSettings Instance {
      get {
        if (instance == null) {
          instance = new MqttSettings();
        }

        return instance;
      }
    }

    // singleton instance
    private static MqttSettings instance;

    /// <summary>
    /// Constructor
    /// </summary>
    private MqttSettings() {
      this.Port = MQTT_BROKER_DEFAULT_PORT;
      this.SslPort = MQTT_BROKER_DEFAULT_SSL_PORT;
      this.TimeoutOnReceiving = MQTT_DEFAULT_TIMEOUT;
      this.AttemptsOnRetry = MQTT_ATTEMPTS_RETRY;
      this.DelayOnRetry = MQTT_DELAY_RETRY;
      this.TimeoutOnConnection = MQTT_CONNECT_TIMEOUT;
      this.InflightQueueSize = MQTT_MAX_INFLIGHT_QUEUE_SIZE;
    }
  }
}