• Home
• com.hivemq
• hivemq-extension-sdk
• 4.33.0
• source code
• UnsubackReasonCode.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.unsuback.UnsubackReasonCode 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.unsuback;

/**
 * Reason codes that can be set/contained in an {@link UnsubackPacket}. A reason code describes the outcome for an
 * UNSUBSCRIBE request from a topic.
 *
 * @author Robin Atherton
 * @since 4.3.0, CE 2020.1
 */
public enum UnsubackReasonCode {

    /**
     * The subscription is deleted.
     * 

     * This is a success code.
     *
     * @since 4.3.0, CE 2020.1
     */
    SUCCESS,

    /**
     * No matching Topic Filter is being used by the Client.
     * 

     * This is a success code.
     *
     * @since 4.3.0, CE 2020.1
     */
    NO_SUBSCRIPTIONS_EXISTED,

    /**
     * The unsubscribe could not be completed and the Server does not wish to reveal the reason or none of the other
     * Reason Codes apply.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.3.0, CE 2020.1
     */
    UNSPECIFIED_ERROR,

    /**
     * The UNSUBSCRIBE is valid but the Server does not accept it.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.3.0, CE 2020.1
     */
    IMPLEMENTATION_SPECIFIC_ERROR,

    /**
     * The Client is not authorized to unsubscribe.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.3.0, CE 2020.1
     */
    NOT_AUTHORIZED,

    /**
     * The Topic Filter is correctly formed but is not allowed for this Client.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.3.0, CE 2020.1
     */
    TOPIC_FILTER_INVALID,

    /**
     * The specified Packet Identifier is already in use.
     * 

     * This is an unsuccessful code.
     *
     * @since 4.3.0, CE 2020.1
     */
    PACKET_IDENTIFIER_IN_USE
}