• Home
• com.hivemq
• hivemq-extension-sdk
• 4.33.0
• source code
• DisconnectReasonCode.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode Maven / Gradle / Ivy

/*
 * Copyright 2018-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.extension.sdk.api.packets.disconnect;

/**
 * MQTT 5 disconnect reason codes are listed here.
 * 

 * MQTT 3 does not support sending a DISCONNECT packet from server to client.
 *
 * @author Christoph Schäbel
 * @since 4.0.0, CE 2019.1
 */
public enum DisconnectReasonCode {

    /**
     * This is a success code.
     *
     * @since 4.0.0, CE 2019.1
     */
    NORMAL_DISCONNECTION,
    /**
     * Can only be used for the {@link ModifiableInboundDisconnectPacket}.
     * 

     * This is a success code.
     *
     * @since 4.0.0, CE 2019.1
     */
    DISCONNECT_WITH_WILL_MESSAGE,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    UNSPECIFIED_ERROR,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    MALFORMED_PACKET,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    PROTOCOL_ERROR,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    IMPLEMENTATION_SPECIFIC_ERROR,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    NOT_AUTHORIZED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SERVER_BUSY,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SERVER_SHUTTING_DOWN,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    BAD_AUTHENTICATION_METHOD,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    KEEP_ALIVE_TIMEOUT,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SESSION_TAKEN_OVER,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     * @deprecated Must not be used for disconnect packets.
     */
    @Deprecated CLIENT_IDENTIFIER_NOT_VALID,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    TOPIC_FILTER_INVALID,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    TOPIC_NAME_INVALID,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    RECEIVE_MAXIMUM_EXCEEDED,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    TOPIC_ALIAS_INVALID,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    PACKET_TOO_LARGE,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    MESSAGE_RATE_TOO_HIGH,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    QUOTA_EXCEEDED,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    ADMINISTRATIVE_ACTION,
    /**
     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    PAYLOAD_FORMAT_INVALID,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    RETAIN_NOT_SUPPORTED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    QOS_NOT_SUPPORTED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    USE_ANOTHER_SERVER,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SERVER_MOVED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SHARED_SUBSCRIPTION_NOT_SUPPORTED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    CONNECTION_RATE_EXCEEDED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    MAXIMUM_CONNECT_TIME,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED,
    /**
     * Can only be used for the {@link ModifiableOutboundDisconnectPacket}.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.0.0, CE 2019.1
     */
    WILDCARD_SUBSCRIPTION_NOT_SUPPORTED
}