com.hivemq.client.mqtt.MqttClientState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-mqtt-client Show documentation

HiveMQ MQTT Client is an MQTT 5.0 and MQTT 3.1.1 compatible and feature-rich high-performance Java client library with different API flavours and backpressure support

The newest version!

/*
 * Copyright 2018-present HiveMQ and the HiveMQ Community
 *
 * 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.client.mqtt;

import org.jetbrains.annotations.NotNull;

import java.util.EnumSet;

/**
 * State of an {@link MqttClient}.
 *  * +--------------+             +------------------------+
 * | DISCONNECTED <-+         +-> DISCONNECTED_RECONNECT |
 * +-------+------+  \       /  +-----------+------------+
 *         |          \     /               |
 *         |           \   /                |
 * +-------v------+     \ /     +-----------v------------+
 * |  CONNECTING  +------x------+  CONNECTING_RECONNECT  |
 * +-------+------+      |      +-----------+------------+
 *         |             |                  |
 *         |             |                  |
 *         |      +------+------+           |
 *         +------>  CONNECTED  <-----------+
 *                +-------------+
 * 
 *
 * @author Silvio Giebl
 * @since 1.0
 */
public enum MqttClientState {

    /**
     * The client is disconnected.
     */
    DISCONNECTED,
    /**
     * The client is connecting.
     * 
     * This means the client was {@link #DISCONNECTED}, a Connect message is sent, but the ConnAck message is not
     * received yet.
     */
    CONNECTING,
    /**
     * The client is connected.
     */
    CONNECTED,
    /**
     * The client is disconnected but will reconnect.
     */
    DISCONNECTED_RECONNECT,
    /**
     * The client is reconnecting.
     * 
     * This means the client was {@link #DISCONNECTED_RECONNECT}, a Connect message is sent, but the ConnAck message is
     * not received yet.
     */
    CONNECTING_RECONNECT;

    private static final @NotNull EnumSet CONNECTED_OR_RECONNECT =
            EnumSet.of(CONNECTED, DISCONNECTED_RECONNECT, CONNECTING_RECONNECT);

    /**
     * @return whether the client is connected.
     */
    public boolean isConnected() {
        return this == CONNECTED;
    }

    /**
     * @return whether the client is connected or will reconnect.
     */
    public boolean isConnectedOrReconnect() {
        return CONNECTED_OR_RECONNECT.contains(this);
    }
}