com.hivemq.client.mqtt

Enum MqttProxyProtocol

java.lang.Object

java.lang.Enum<MqttProxyProtocol>

com.hivemq.client.mqtt.MqttProxyProtocol

All Implemented Interfaces:

Serializable, Comparable<MqttProxyProtocol>

public enum MqttProxyProtocol
extends Enum<MqttProxyProtocol>

Available proxy protocols for a MqttProxyConfig.

Since:

1.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTTP HTTP CONNECT proxy protocol.
SOCKS_4 SOCKS4 proxy protocol.
SOCKS_5 SOCKS5 proxy protocol.

Method Summary

Modifier and Type	Method and Description
static MqttProxyProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static MqttProxyProtocol[]	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

SOCKS_4

public static final MqttProxyProtocol SOCKS_4

SOCKS4 proxy protocol.

SOCKS_5

public static final MqttProxyProtocol SOCKS_5

SOCKS5 proxy protocol.

HTTP

public static final MqttProxyProtocol HTTP

HTTP CONNECT proxy protocol.

Method Detail

values

public static MqttProxyProtocol[] 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 (MqttProxyProtocol c : MqttProxyProtocol.values())
    System.out.println(c);

Returns:

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

valueOf

public static MqttProxyProtocol 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