Enum Class CapacityLimit

java.lang.Object

java.lang.Enum<CapacityLimit>

org.mqtt4j.hato.CapacityLimit

All Implemented Interfaces:

Serializable, Comparable<CapacityLimit>, Constable

public enum CapacityLimit
extends Enum<CapacityLimit>

A limit that refuses operations with MqttCapacityException when it is full. MqttCapacityException.limit() names it, and ClientStats.refusals() counts its refusals.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INFLIGHT_PUBLISHES	MqttClientBuilder.maxInflightPublishes(int).
OBSERVATIONS	The pending observations, such as MqttClient.whenConnected(), Subscription.established(), MqttClient.terminated(), and MqttClient.stats().
OPERATION_QUEUE	The operations waiting for the client to process them.
OPERATIONS	The operation capacity that publications share with concurrent MqttClient.connect() and MqttClient.disconnect() calls beyond the first of each; see ClientStats.Sending.operations().
PACKET_IDENTIFIERS	The packet identifiers that publications and subscription requests share.
PUBLICATION_BYTES	The bytes that unfinished publications keep.
REGISTRATION_QUEUE	The registrations waiting for the client to process them.
SEND_QUEUE	The send queue, or a backlog in it that waits for send capacity.
SUBSCRIPTIONS	MqttClientBuilder.maxSubscriptions(int), for registrations and delivery lanes.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPERATIONS

public static final CapacityLimit OPERATIONS

The operation capacity that publications share with concurrent MqttClient.connect() and MqttClient.disconnect() calls beyond the first of each; see ClientStats.Sending.operations().

OPERATION_QUEUE

public static final CapacityLimit OPERATION_QUEUE

The operations waiting for the client to process them.

INFLIGHT_PUBLISHES

public static final CapacityLimit INFLIGHT_PUBLISHES

MqttClientBuilder.maxInflightPublishes(int).

PUBLICATION_BYTES

public static final CapacityLimit PUBLICATION_BYTES

The bytes that unfinished publications keep.

PACKET_IDENTIFIERS

public static final CapacityLimit PACKET_IDENTIFIERS

The packet identifiers that publications and subscription requests share.

SEND_QUEUE

public static final CapacityLimit SEND_QUEUE

The send queue, or a backlog in it that waits for send capacity.

SUBSCRIPTIONS

public static final CapacityLimit SUBSCRIPTIONS

MqttClientBuilder.maxSubscriptions(int), for registrations and delivery lanes.

REGISTRATION_QUEUE

public static final CapacityLimit REGISTRATION_QUEUE

The registrations waiting for the client to process them.

OBSERVATIONS

public static final CapacityLimit OBSERVATIONS

The pending observations, such as MqttClient.whenConnected(), Subscription.established(), MqttClient.terminated(), and MqttClient.stats().

Method Details

values

public static CapacityLimit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CapacityLimit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null