mqtt/M2Mqtt/Exceptions/MqttClientException.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.Exceptions {
  /// <summary>
  /// MQTT client exception
  /// </summary>
  public class MqttClientException : Exception {
    /// <summary>
    /// Constructor
    /// </summary>
    /// <param name="code">Error code</param>
    public MqttClientException(MqttClientErrorCode errorCode) => this.ErrorCode = errorCode;

    /// <summary>
    /// Error code
    /// </summary>
    public MqttClientErrorCode ErrorCode { get; set; }
  }

  /// <summary>
  /// MQTT client erroro code
  /// </summary>
  public enum MqttClientErrorCode {
    /// <summary>
    /// Will error (topic, message or QoS level)
    /// </summary>
    WillWrong = 1,

    /// <summary>
    /// Keep alive period too large
    /// </summary>
    KeepAliveWrong,

    /// <summary>
    /// Topic contains wildcards
    /// </summary>
    TopicWildcard,

    /// <summary>
    /// Topic length wrong
    /// </summary>
    TopicLength,

    /// <summary>
    /// QoS level not allowed
    /// </summary>
    QosNotAllowed,

    /// <summary>
    /// Topics list empty for subscribe
    /// </summary>
    TopicsEmpty,

    /// <summary>
    /// Qos levels list empty for subscribe
    /// </summary>
    QosLevelsEmpty,

    /// <summary>
    /// Topics / Qos Levels not match in subscribe
    /// </summary>
    TopicsQosLevelsNotMatch,

    /// <summary>
    /// Wrong message from broker
    /// </summary>
    WrongBrokerMessage,

    /// <summary>
    /// Wrong Message Id
    /// </summary>
    WrongMessageId,

    /// <summary>
    /// Inflight queue is full
    /// </summary>
    InflightQueueFull,

    // [v3.1.1]
    /// <summary>
    /// Invalid flag bits received 
    /// </summary>
    InvalidFlagBits,

    // [v3.1.1]
    /// <summary>
    /// Invalid connect flags received
    /// </summary>
    InvalidConnectFlags,

    // [v3.1.1]
    /// <summary>
    /// Invalid client id
    /// </summary>
    InvalidClientId,

    // [v3.1.1]
    /// <summary>
    /// Invalid protocol name
    /// </summary>
    InvalidProtocolName
  }
}