com.hivemq.client.mqtt.lifecycle

Enum MqttDisconnectSource

java.lang.Object

java.lang.Enum<MqttDisconnectSource>

com.hivemq.client.mqtt.lifecycle.MqttDisconnectSource

All Implemented Interfaces:

Serializable, Comparable<MqttDisconnectSource>

public enum MqttDisconnectSource
extends Enum<MqttDisconnectSource>

Source which triggers disconnection.

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT The client itself (without interaction of the user) sent a Disconnect message or closed the connection without a Disconnect message.
SERVER The server sent a Disconnect message or closed the connection without a Disconnect message.
USER The user explicitly called disconnect.

Method Summary

Modifier and Type	Method and Description
static MqttDisconnectSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static MqttDisconnectSource[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USER

public static final MqttDisconnectSource USER

The user explicitly called disconnect.

CLIENT

public static final MqttDisconnectSource CLIENT

The client itself (without interaction of the user) sent a Disconnect message or closed the connection without a Disconnect message.

This can happen if

• an initialization error occurs (e.g. unknown host)
• an operation times out (e.g. connect, ping)
• a network error occurs
• the server does not conform to the MQTT specification (e.g. malformed packet, protocol error)

SERVER

public static final MqttDisconnectSource SERVER

The server sent a Disconnect message or closed the connection without a Disconnect message.

Method Detail

values

public static MqttDisconnectSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MqttDisconnectSource c : MqttDisconnectSource.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MqttDisconnectSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null