Index (hato-client 0.9.0-SNAPSHOT API)

A B C D E F G H I K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

ACCEPTED - Enum constant in enum class org.mqtt4j.hato.Transport.SendResult: The transport admitted the send and owns its array until it reports the write through Transport.Listener.onSent(long) or releases the array through Transport.Listener.onClosed(Throwable).
ack() - Method in interface org.mqtt4j.hato.MqttDelivery: Acknowledges this subscription's QoS 1 or QoS 2 delivery in AckMode.MANUAL mode.
ackMode() - Method in class org.mqtt4j.hato.Subscribe: Returns the acknowledgement mode: when this subscription permits acknowledgement of a QoS 1 or 2 delivery.
AckMode - Enum Class in org.mqtt4j.hato: When a subscription makes a QoS 1 or QoS 2 delivery eligible for acknowledgement.
ADMINISTRATIVE_ACTION - Enum constant in enum class org.mqtt4j.hato.ReasonCode: An administrative decision causes disconnection.
AFTER_HANDLER - Enum constant in enum class org.mqtt4j.hato.AckMode: After the handler returns normally.
AT_LEAST_ONCE - Enum constant in enum class org.mqtt4j.hato.Qos: QoS 1: delivered at least once, acknowledged with PUBACK.
AT_MOST_ONCE - Enum constant in enum class org.mqtt4j.hato.Qos: QoS 0: delivered at most once, with no acknowledgement.
attempt() - Method in class org.mqtt4j.hato.ClientStats.Connection: Returns the number of the latest connection attempt, as ConnAck.connectionAttempt() and Disconnection.connectionAttempt() number them, or 0 before the first attempt.
awaitingAck() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the number of deliveries that a handler, an acceptor, or a receiver has processed, and whose MqttDelivery.ack() has not been called yet.
awaitingAcknowledgementWrite() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the number of unfinished receptions whose PUBACK or PUBREC awaits its write.
awaitingCompletionWrite() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the number of QoS 2 receptions whose PUBCOMP awaits its write.
awaitingConditions() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the number of unfinished receptions whose acknowledgement awaits its conditions.
awaitingPubAck() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the number of QoS 1 publications that await PUBACK, including those that wait to be sent.
awaitingPubComp() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the number of QoS 2 exchanges that await PUBCOMP.
awaitingPubRec() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the number of QoS 2 publications that await PUBREC, including those that wait to be sent.
awaitingRelease() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the number of QoS 2 receptions that await the broker's PUBREL, which has no deadline.
awaitingTurn() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the number of unfinished receptions whose acknowledgement is due but awaits its turn.

B

BAD_AUTHENTICATION_METHOD - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The authentication method is unsupported or inconsistent with the exchange.
BAD_USER_NAME_OR_PASSWORD - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server rejects the supplied user name or password.
BANNED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server has banned the client.
bufferCapacity() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the subscription's buffer capacity.
bufferCapacity() - Method in class org.mqtt4j.hato.Subscribe: Returns the maximum number of local deliveries this subscription holds at once.
build() - Method in class org.mqtt4j.hato.MqttClientBuilder: Creates a disconnected client.
builder() - Static method in interface org.mqtt4j.hato.MqttClient: Starts configuration without opening a connection.

C

cancel() - Method in interface org.mqtt4j.hato.TimerScheduler.Cancellable: Cancels the task.
CapacityLimit - Enum Class in org.mqtt4j.hato: A limit that refuses operations with MqttCapacityException when it is full.
cause() - Method in class org.mqtt4j.hato.Disconnection: Returns the original failure, or empty when no failure is reported.
CLIENT_FULL - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: The client dropped a QoS 0 delivery to keep within its limits on deliveries and their bytes.
CLIENT_IDENTIFIER_NOT_VALID - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server rejects the client identifier.
clientId(String) - Method in class org.mqtt4j.hato.MqttClientBuilder: Uses this nonempty MQTT UTF-8 identifier of at most 65535 bytes, validated immediately.
ClientStats - Class in org.mqtt4j.hato: What a client holds and has counted, as only the client can know it, collected at one point after MqttClient.stats() was called.
ClientStats.Connection - Class in org.mqtt4j.hato: The connection's state and attempt numbers.
ClientStats.ConnectionState - Enum Class in org.mqtt4j.hato: The state of a client's connection.
ClientStats.DropReason - Enum Class in org.mqtt4j.hato: Why a delivery left its subscription unprocessed.
ClientStats.OverloadCause - Enum Class in org.mqtt4j.hato: Why the client ended a connection as overloaded.
ClientStats.Receiving - Class in org.mqtt4j.hato: Incoming publications, their deliveries, and their acknowledgement exchanges.
ClientStats.Sending - Class in org.mqtt4j.hato: Outgoing writes and publication exchanges.
ClientStats.Subscribing - Class in org.mqtt4j.hato: The subscription registrations and delivery lanes, in total.
ClientStats.SubscriptionStats - Class in org.mqtt4j.hato: The values of one subscription.
ClientStats.Usage - Record Class in org.mqtt4j.hato: How much of a limit is in use.
close() - Method in interface org.mqtt4j.hato.MqttClient: Requests immediate, permanent shutdown without sending DISCONNECT or waiting for I/O or application callbacks.
close() - Method in interface org.mqtt4j.hato.Subscription: Permanently stops local delivery, discards queued messages, including those an earlier Subscription.unsubscribe() accepted, releases their acknowledgement conditions, and wakes waiting receivers.
close() - Method in interface org.mqtt4j.hato.Transport: Requests shutdown.
CLOSED - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: The client is closed.
CLOSED - Enum constant in enum class org.mqtt4j.hato.Transport.SendResult: The transport is closing or closed and did not admit the send; the array remains the caller's.
ConnAck - Class in org.mqtt4j.hato: The broker's successful connection acknowledgement, with the limits that the broker announced for the connection.
connect() - Method in interface org.mqtt4j.hato.MqttClient: Requests a connection and completes with the successful CONNACK that establishes it.
CONNECTED - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: A connection is established.
CONNECTING - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: An attempt is establishing a connection.
connection() - Method in class org.mqtt4j.hato.ClientStats: Returns the connection's state and attempt numbers.
CONNECTION_ENDED - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: The end of the connection that delivered it discarded it while it waited.
CONNECTION_RATE_EXCEEDED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The rate of new connections exceeds the server's limit.
connectionAttempt() - Method in class org.mqtt4j.hato.ConnAck: Returns the number of the connection attempt that this acknowledgement established.
connectionAttempt() - Method in class org.mqtt4j.hato.Disconnection: Returns the number of the attempt that established the ended connection or that failed.
connectionAttempt() - Method in interface org.mqtt4j.hato.MqttDelivery: Returns the number of the connection attempt that established the connection delivering this message, as ConnAck.connectionAttempt() reports it.
connectionListener(ConnectionListener) - Method in class org.mqtt4j.hato.MqttClientBuilder: Registers the single listener for connection and subscription notifications; defaults to no action.
ConnectionListener - Interface in org.mqtt4j.hato: Receives connection and subscription notifications serially, independently of I/O and operation completion.
connectionTimeout(Duration) - Method in class org.mqtt4j.hato.MqttClientBuilder: Deadline for establishing each connection: credentials, which an attempt evaluates before its first connection, transport establishment (including any TLS handshake), and CONNACK.
contentType() - Method in class org.mqtt4j.hato.MqttMessage: Returns the content type that describes the payload, or empty when absent.
CONTINUE_AUTHENTICATION - Enum constant in enum class org.mqtt4j.hato.ReasonCode: Authentication requires another exchange.
correlationData() - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy of the Correlation Data, or empty when absent.
create(String) - Method in interface org.mqtt4j.hato.Transport.Factory: Returns a fresh transport promptly, without connecting it.
credentials(Supplier) - Method in class org.mqtt4j.hato.MqttClientBuilder: Supplies credentials once per connection attempt, on a thread of its own before opening the attempt's first transport.

D

deliveries() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns a lifetime count of the deliveries that subscriptions took: one for each copy of a received publication that a subscription's buffer took.
DELIVERIES - Enum constant in enum class org.mqtt4j.hato.ClientStats.OverloadCause: A QoS 1 or QoS 2 delivery did not fit a subscription's buffer or the client's limits on deliveries, their bytes, and their acknowledgement conditions.
delivery() - Method in record class org.mqtt4j.hato.ReceiveResult.Received: Returns the value of the delivery record component.
DeliveryOptions - Class in org.mqtt4j.hato: Where and how a push subscription runs its handler, for MqttSubscriber.subscribe(Subscribe, DeliveryOptions, java.util.function.Consumer).
disabled() - Static method in class org.mqtt4j.hato.ReconnectPolicy: Never reconnects automatically.
disconnect() - Method in interface org.mqtt4j.hato.MqttClient: Withdraws the connection request: the client stops reconnecting, and an established connection ends with DISCONNECT.
DISCONNECT_WITH_WILL_MESSAGE - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The client requests disconnection and publication of its Will.
DISCONNECTED - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: No connection is requested.
DISCONNECTING - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: A requested disconnection is in progress.
Disconnection - Class in org.mqtt4j.hato: The end of an established connection, or of a connection attempt that established none.
DO_NOT_SEND - Enum constant in enum class org.mqtt4j.hato.RetainHandling: Do not send them when the subscription is made.
dropped() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns lifetime counts of deliveries that left their subscription unprocessed, by reason, across all subscriptions, including those that have ended.
dropped() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns lifetime counts of the subscription's deliveries that left it unprocessed, by reason.
droppedMetricEvents() - Method in class org.mqtt4j.hato.ClientStats: Returns a lifetime count of MetricsListener events dropped because the listener fell behind.
droppedNotifications() - Method in class org.mqtt4j.hato.ClientStats.Connection: Returns a lifetime count of ConnectionListener notifications dropped because the listener fell behind.
dup() - Method in interface org.mqtt4j.hato.MqttDelivery: Returns whether the broker marked the publication as a duplicate.
duration() - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion: Returns the time from when the client admitted the publication to when its future completed.

E

Ended() - Constructor for record class org.mqtt4j.hato.ReceiveResult.Ended: Creates an instance of a Ended record class.
equals(Object) - Method in class org.mqtt4j.hato.ClientStats
equals(Object) - Method in class org.mqtt4j.hato.ConnAck
equals(Object) - Method in class org.mqtt4j.hato.Disconnection
equals(Object) - Method in class org.mqtt4j.hato.MetricsListener.DeliveryStart
equals(Object) - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion
equals(Object) - Method in class org.mqtt4j.hato.MqttCredentials
equals(Object) - Method in class org.mqtt4j.hato.MqttMessage
equals(Object) - Method in class org.mqtt4j.hato.PublishResult
equals(Object) - Method in class org.mqtt4j.hato.ReconnectPolicy
equals(Object) - Method in class org.mqtt4j.hato.Subscribe
equals(Object) - Method in class org.mqtt4j.hato.UserProperty
equals(Object) - Method in record class org.mqtt4j.hato.ClientStats.Usage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.mqtt4j.hato.ReceiveResult.Ended: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.mqtt4j.hato.ReceiveResult.Received: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.mqtt4j.hato.ReceiveResult.TimedOut: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.mqtt4j.hato.Topic: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.mqtt4j.hato.TopicFilter: Indicates whether some other object is "equal to" this one.
established() - Method in class org.mqtt4j.hato.ClientStats.Subscribing: Returns the number of registrations that the broker has granted.
established() - Method in interface org.mqtt4j.hato.Subscription: Observes establishment on the current or next connection without starting a connection.
establishedAttempt() - Method in class org.mqtt4j.hato.ClientStats.Connection: Returns the number of the attempt that established the latest connection, or 0 if none has.
EVENTS - Enum constant in enum class org.mqtt4j.hato.ClientStats.OverloadCause: The client fell behind on incoming packets, control events, or keep-alive events.
EXACTLY_ONCE - Enum constant in enum class org.mqtt4j.hato.Qos: QoS 2: delivered exactly once, through the PUBREC, PUBREL, and PUBCOMP handshake.
exponentialBackoff(Duration, Duration) - Static method in class org.mqtt4j.hato.ReconnectPolicy: Reconnects with exponential backoff and full jitter, doubling the bound of the random delay from initialDelay up to maxDelay.

F

FAILED - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: Its handler threw, the stripe of its striped handler could not be chosen, or its executor refused it.
failure() - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion: Returns the exception with which the publication's future failed, or empty if it succeeded.
failurePolicy() - Method in class org.mqtt4j.hato.Subscribe: Returns what this subscription does when its handler throws; see FailurePolicy.
FailurePolicy - Enum Class in org.mqtt4j.hato: What a push subscription does when its handler throws for a delivery, and a hand-off subscription when its acceptor throws.
filter() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the subscription's filter.
filter() - Method in interface org.mqtt4j.hato.MqttDelivery: Returns the original filter of the subscription that received this delivery, including any shared group name, as Subscription.filter() returns it.
filter() - Method in class org.mqtt4j.hato.Subscribe: Returns the filter sent to the broker.
filter() - Method in interface org.mqtt4j.hato.Subscription: Returns the original filter sent to the broker, including any shared group name.

G

GRANTED_QOS_1 - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The subscription is accepted with a maximum QoS of 1.
GRANTED_QOS_2 - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The subscription is accepted with a maximum QoS of 2.
grantedQos() - Method in interface org.mqtt4j.hato.Subscription: Returns the maximum QoS granted by the most recent successful SUBACK, which can be lower than requested, or empty until a successful SUBACK has granted one.

H

HAND_OFF - Enum constant in enum class org.mqtt4j.hato.ClientStats.OverloadCause: A hand-off acceptor refused a QoS 1 or QoS 2 delivery.
handOff(Subscribe, Predicate) - Method in interface org.mqtt4j.hato.MqttSubscriber: Registers a hand-off subscription, which hands each delivery to acceptor for the application to process elsewhere, such as in its own mailbox: mailbox::offer.
hashCode() - Method in class org.mqtt4j.hato.ClientStats
hashCode() - Method in record class org.mqtt4j.hato.ClientStats.Usage: Returns a hash code value for this object.
hashCode() - Method in class org.mqtt4j.hato.ConnAck
hashCode() - Method in class org.mqtt4j.hato.Disconnection
hashCode() - Method in class org.mqtt4j.hato.MetricsListener.DeliveryStart
hashCode() - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion
hashCode() - Method in class org.mqtt4j.hato.MqttCredentials
hashCode() - Method in class org.mqtt4j.hato.MqttMessage
hashCode() - Method in class org.mqtt4j.hato.PublishResult
hashCode() - Method in record class org.mqtt4j.hato.ReceiveResult.Ended: Returns a hash code value for this object.
hashCode() - Method in record class org.mqtt4j.hato.ReceiveResult.Received: Returns a hash code value for this object.
hashCode() - Method in record class org.mqtt4j.hato.ReceiveResult.TimedOut: Returns a hash code value for this object.
hashCode() - Method in class org.mqtt4j.hato.ReconnectPolicy
hashCode() - Method in class org.mqtt4j.hato.Subscribe
hashCode() - Method in record class org.mqtt4j.hato.Topic: Returns a hash code value for this object.
hashCode() - Method in record class org.mqtt4j.hato.TopicFilter: Returns a hash code value for this object.
hashCode() - Method in class org.mqtt4j.hato.UserProperty
heldBytes() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the bytes that the deliveries the client holds count against its limit for all subscriptions: the size of each received PUBLISH and an allowance for each of its properties, which take more memory than their encoding.
heldConditions() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the acknowledgement conditions that the client holds for unfinished QoS 1 and QoS 2 receptions, one for each subscription that took a copy, against its limit for all subscriptions.
heldDeliveries() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns the deliveries that the client holds, against its limit for all subscriptions.

I

IMPLEMENTATION_SPECIFIC_ERROR - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The implementation declines an otherwise valid packet.
INFLIGHT_PUBLISHES - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: MqttClientBuilder.maxInflightPublishes(int).
inline() - Static method in class org.mqtt4j.hato.DeliveryOptions: One delivery at a time, in receive order, as DeliveryOptions.serial(), for a handler that returns at once and never waits for this client.

K

KEEP_ALIVE_TIMEOUT - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server received no packet within the permitted keep-alive interval.
keepAlive(Duration) - Method in class org.mqtt4j.hato.MqttClientBuilder: Sets the keep-alive interval in whole seconds from 0 (disabled) to 65535; default 60.
keptBytes() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the bytes that unfinished publications keep, against their limit: a persistent session keeps a publication until PUBACK or PUBREC, and a nonpersistent one only while it waits to be sent.

L

lanes() - Method in class org.mqtt4j.hato.ClientStats.Subscribing: Returns the delivery lanes, one for each subscription, including the lanes of stopped subscriptions whose handlers have not returned, against MqttClientBuilder.maxSubscriptions(int).
lanes(Function) - Static method in class org.mqtt4j.hato.DeliveryOptions: Runs each delivery's handler on the executor that selector returns for its message: the delivery's lane.
level() - Method in enum class org.mqtt4j.hato.Qos: Returns the numeric level as it appears on the wire.
limit() - Method in record class org.mqtt4j.hato.ClientStats.Usage: Returns the value of the limit record component.
limit() - Method in exception class org.mqtt4j.hato.MqttCapacityException: Returns the limit that refused the operation, or empty when overload ended a connection.

M

MALFORMED_PACKET - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The packet cannot be parsed according to the protocol's format.
MANUAL - Enum constant in enum class org.mqtt4j.hato.AckMode: When the application calls MqttDelivery.ack().
matches(Topic) - Method in record class org.mqtt4j.hato.TopicFilter: Tests whether this filter selects topic.
MAXIMUM_CONNECT_TIME - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The connection has reached the server's permitted lifetime.
maximumPacketSize() - Method in class org.mqtt4j.hato.ConnAck: Returns the largest packet, in bytes including the fixed header, that the broker accepts on this connection.
maximumQos() - Method in class org.mqtt4j.hato.ConnAck: Returns the highest QoS at which the broker accepts publications on this connection.
maxInflightPublishes(int) - Method in class org.mqtt4j.hato.MqttClientBuilder: Limits the QoS 1 and QoS 2 publications whose exchanges are unfinished, from 1 to 65535; defaults to 64.
maxPacketSize(int) - Method in class org.mqtt4j.hato.MqttClientBuilder: Inclusive incoming packet size, including the fixed header.
maxSubscriptions(int) - Method in class org.mqtt4j.hato.MqttClientBuilder: Limits the subscriptions that the client holds, from 1 to 268,435,455, the number of MQTT 5.0 Subscription Identifiers; defaults to 4,096.
message() - Method in interface org.mqtt4j.hato.MqttDelivery: Returns the received message, whose payload accessor returns an independent copy.
MESSAGE_RATE_TOO_HIGH - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The publication rate exceeds the receiver's capacity or policy.
messageExpiry() - Method in class org.mqtt4j.hato.MqttMessage: Returns the lifetime of the message, or empty when it does not expire.
metricsListener(MetricsListener) - Method in class org.mqtt4j.hato.MqttClientBuilder: Registers the single listener for the timings of publications and deliveries; see MetricsListener.
MetricsListener - Interface in org.mqtt4j.hato: Receives timings that only the client can measure: how long each publication takes from its admission to the completion of its future, and how long each delivery waits from its reception until application code receives it.
MetricsListener.DeliveryStart - Class in org.mqtt4j.hato: When application code received one delivery.
MetricsListener.PublishCompletion - Class in org.mqtt4j.hato: How one admitted publication completed.
MqttBrokerDisconnectException - Exception Class in org.mqtt4j.hato: An MQTT 5.0 broker ended the connection with DISCONNECT.
MqttBrokerDisconnectException(ReasonCode, String, String) - Constructor for exception class org.mqtt4j.hato.MqttBrokerDisconnectException: A DISCONNECT from the broker, with the explanation and the server reference that it carried, if any.
MqttCapacityException - Exception Class in org.mqtt4j.hato: A bounded resource has no available capacity.
MqttCapacityException(String) - Constructor for exception class org.mqtt4j.hato.MqttCapacityException: Describes an overload that ended a connection.
MqttCapacityException(String, CapacityLimit) - Constructor for exception class org.mqtt4j.hato.MqttCapacityException: Describes an operation that limit refused.
MqttClient - Interface in org.mqtt4j.hato: Owns an MQTT connection.
MqttClientBuilder - Class in org.mqtt4j.hato: Configures a client without opening a connection.
MqttConnectException - Exception Class in org.mqtt4j.hato: A connection attempt failed.
MqttConnectException(String) - Constructor for exception class org.mqtt4j.hato.MqttConnectException: A failure with neither a reason code nor a cause.
MqttConnectException(String, Throwable) - Constructor for exception class org.mqtt4j.hato.MqttConnectException: A failure with a cause instead of a reason code, such as a transport failure or deadline expiry.
MqttConnectException(String, ReasonCode) - Constructor for exception class org.mqtt4j.hato.MqttConnectException: A broker refusal without an explanation or a server reference.
MqttConnectException(String, ReasonCode, String, String) - Constructor for exception class org.mqtt4j.hato.MqttConnectException: A broker refusal with the explanation and the server reference that the broker sent, if any.
MqttConnectionLostException - Exception Class in org.mqtt4j.hato: A connection ended before an operation's outcome could be confirmed.
MqttConnectionLostException() - Constructor for exception class org.mqtt4j.hato.MqttConnectionLostException: A loss without a cause.
MqttConnectionLostException(Throwable) - Constructor for exception class org.mqtt4j.hato.MqttConnectionLostException: A loss with the failure that caused it.
MqttCredentials - Class in org.mqtt4j.hato: Immutable MQTT credentials: a username and an optional binary password.
MqttDelivery - Interface in org.mqtt4j.hato: An application delivery for one subscription.
MqttException - Exception Class in org.mqtt4j.hato: Base class for failures of MQTT operations.
MqttException(String) - Constructor for exception class org.mqtt4j.hato.MqttException: A failure with a detail message.
MqttException(String, Throwable) - Constructor for exception class org.mqtt4j.hato.MqttException: A failure with a detail message and a cause.
MqttMessage - Class in org.mqtt4j.hato: An immutable application message: a topic, a payload, a QoS, a retain flag, and the MQTT 5.0 message properties.
MqttNotConnectedException - Exception Class in org.mqtt4j.hato: An operation requires an established connection.
MqttNotConnectedException() - Constructor for exception class org.mqtt4j.hato.MqttNotConnectedException: A failure of an operation attempted without an established connection.
MqttProtocolException - Exception Class in org.mqtt4j.hato: A locally detected failure to process an incoming MQTT packet.
MqttProtocolException(String, ReasonCode) - Constructor for exception class org.mqtt4j.hato.MqttProtocolException: A failure without an underlying cause.
MqttProtocolException(String, ReasonCode, Throwable) - Constructor for exception class org.mqtt4j.hato.MqttProtocolException: A failure with an underlying cause, which is retained for diagnostics.
MqttPublicationRefusedException - Exception Class in org.mqtt4j.hato: The broker refused a publication, or would refuse it.
MqttPublicationRefusedException(ReasonCode) - Constructor for exception class org.mqtt4j.hato.MqttPublicationRefusedException: A refusal without an explanation, such as the one that the client makes itself.
MqttPublicationRefusedException(ReasonCode, String) - Constructor for exception class org.mqtt4j.hato.MqttPublicationRefusedException: A refusal with the broker's explanation, if the broker sent one.
MqttPublisher - Interface in org.mqtt4j.hato: The publishing role of a client, without access to its connection lifecycle.
MqttSubscriber - Interface in org.mqtt4j.hato: The subscribing role of a client, without access to its connection lifecycle.
MqttSubscriptionRefusedException - Exception Class in org.mqtt4j.hato: The broker refused a subscription, or would refuse it.
MqttSubscriptionRefusedException(ReasonCode) - Constructor for exception class org.mqtt4j.hato.MqttSubscriptionRefusedException: A refusal without an explanation, such as the one that the client makes itself.
MqttSubscriptionRefusedException(ReasonCode, String) - Constructor for exception class org.mqtt4j.hato.MqttSubscriptionRefusedException: A refusal with the broker's explanation, if the broker sent one.
MqttVersion - Enum Class in org.mqtt4j.hato: The MQTT protocol versions supported by Hato.

N

name() - Method in record class org.mqtt4j.hato.Topic: Returns the value of the name record component.
name() - Method in class org.mqtt4j.hato.UserProperty: Returns the property name, possibly empty.
nanoTime() - Method in interface org.mqtt4j.hato.TimerScheduler: Returns a monotonic nanosecond counter, compared using differences, like System.nanoTime().
NO_MATCHING_SUBSCRIBERS - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The publication is accepted but has no matching subscribers.
NO_SUBSCRIPTION_EXISTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: Unsubscription completed without finding a matching subscription.
noLocal() - Method in class org.mqtt4j.hato.Subscribe: Returns whether the broker withholds this client's own publications from this subscription.
NOT_AUTHORIZED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The operation is not permitted for this client.

O

OBSERVATIONS - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The pending observations, such as MqttClient.whenConnected(), Subscription.established(), MqttClient.terminated(), and MqttClient.stats().
of() - Static method in class org.mqtt4j.hato.PublishResult: Describes a successfully completed publication with ReasonCode.SUCCESS.
of(boolean, long) - Static method in class org.mqtt4j.hato.ConnAck: Describes a successful acknowledgement of connection attempt number connectionAttempt, and whether the broker resumed a session, from a broker that announced no limits.
of(int) - Static method in enum class org.mqtt4j.hato.Qos: Returns the QoS for a wire-level value.
of(int) - Static method in enum class org.mqtt4j.hato.ReasonCode: Resolves an unsigned MQTT 5.0 wire value to its reason code.
of(Throwable, boolean, long) - Static method in class org.mqtt4j.hato.Disconnection: Describes an ending of connection attempt number connectionAttempt after which the client does not reconnect, with the original cause, or no reported failure when it is null.
of(Throwable, boolean, long, Duration) - Static method in class org.mqtt4j.hato.Disconnection: Like Disconnection.of(Throwable, boolean, long), but the client attempts to connect again after reconnectDelay.
of(String) - Static method in class org.mqtt4j.hato.MqttCredentials: Creates credentials containing only a username.
of(String, byte[]) - Static method in class org.mqtt4j.hato.MqttCredentials: Creates credentials with a copy of the binary password, which may be empty.
of(Qos, Throwable, Duration) - Static method in class org.mqtt4j.hato.MetricsListener.PublishCompletion: Returns the completion of a publication at qos whose future failed with failure, duration after its admission.
of(Qos, Duration) - Static method in class org.mqtt4j.hato.MetricsListener.PublishCompletion: Returns the completion of a publication at qos that succeeded duration after its admission.
of(ReasonCode) - Static method in class org.mqtt4j.hato.PublishResult: Describes a successfully completed publication with reasonCode.
of(Subscription, Duration) - Static method in class org.mqtt4j.hato.MetricsListener.DeliveryStart: Returns the start of a delivery of subscription that application code received waited after the client received its PUBLISH.
of(TopicFilter, Qos) - Static method in class org.mqtt4j.hato.Subscribe: Requests filter with qos as the maximum quality of service, the default acknowledgement mode, a buffer capacity of 1024, FailurePolicy.STOP, and the MQTT 5.0 defaults for the subscription options: No Local and Retain As Published off, and RetainHandling.SEND.
of(Topic, byte[], Qos, boolean) - Static method in class org.mqtt4j.hato.MqttMessage: Creates a message without properties, with a copy of the application bytes.
oldestAwaitingConditions() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns how long the oldest reception that awaits its conditions has done so, which also holds back the acknowledgements counted as awaiting their turn; empty if none does.
oldestAwaitingRelease() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns how long the oldest reception that awaits PUBREL has done so; empty if none does.
oldestResponseWait() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns how long the oldest response that the client awaits, a PUBACK, PUBREC, PUBCOMP, SUBACK, or UNSUBACK, has been awaited since the write that it answers completed; empty if none is awaited.
ON_RECEIVE - Enum constant in enum class org.mqtt4j.hato.AckMode: Immediately before invoking the handler, when a pull receive hands off the delivery, or when a hand-off subscription's acceptor accepts it.
onBytes(byte[]) - Method in interface org.mqtt4j.hato.Transport.Listener: Called with received bytes, in wire order and with arbitrary chunk boundaries.
onClosed(Throwable) - Method in interface org.mqtt4j.hato.Transport.Listener: Called once, last, when the connection ends.
onConnected() - Method in interface org.mqtt4j.hato.Transport.Listener: Called when the connection is established, before any bytes or send completions.
onConnected(ConnAck) - Method in interface org.mqtt4j.hato.ConnectionListener: Called for each established connection.
onConnectFailed(Disconnection) - Method in interface org.mqtt4j.hato.ConnectionListener: Called for each connection attempt that ends without an established connection, for example because the broker cannot be reached or refuses the connection.
onDeliveryStarted(MetricsListener.DeliveryStart) - Method in interface org.mqtt4j.hato.MetricsListener: Called once for each delivery when application code receives it: when its handler starts, when its hand-off acceptor is called with it, or when a pull receive returns it.
onDisconnected(Disconnection) - Method in interface org.mqtt4j.hato.ConnectionListener: Called for each established connection that ends, including local disconnect or close, peer closure, protocol errors, overload, and internal failure.
onPublishCompleted(MetricsListener.PublishCompletion) - Method in interface org.mqtt4j.hato.MetricsListener: Called once for each publication that the client admitted, when its future completes, whether it succeeded or failed.
onResubscribeFailed(Subscription, MqttSubscriptionRefusedException) - Method in interface org.mqtt4j.hato.ConnectionListener: Called when re-creation of an established subscription is refused, unless Subscription.close() or Subscription.unsubscribe() requested its removal first.
onSent(long) - Method in interface org.mqtt4j.hato.Transport.Listener: Called exactly once for each successfully written send, before Transport.Listener.onClosed(Throwable).
OPERATION_QUEUE - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The operations waiting for the client to process them.
operations() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the operation capacity in use, against its limit.
OPERATIONS - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The operation capacity that publications share with concurrent MqttClient.connect() and MqttClient.disconnect() calls beyond the first of each; see ClientStats.Sending.operations().
org.mqtt4j.hato - package org.mqtt4j.hato: The public API of the Hato client.
org.mqtt4j.hato.client - module org.mqtt4j.hato.client: The Hato client.
overloads() - Method in class org.mqtt4j.hato.ClientStats: Returns lifetime counts of connections that the client ended because it was overloaded, by cause.

P

PACKET_IDENTIFIER_IN_USE - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The packet identifier is already assigned to an unfinished exchange.
PACKET_IDENTIFIER_NOT_FOUND - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The receiver has no exchange for the packet identifier.
PACKET_IDENTIFIERS - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The packet identifiers that publications and subscription requests share.
PACKET_TOO_LARGE - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The packet exceeds the receiver's permitted size.
parallel(int) - Static method in class org.mqtt4j.hato.DeliveryOptions: Runs up to parallelism deliveries at the same time, in no particular order.
password() - Method in class org.mqtt4j.hato.MqttCredentials: Returns a copy of the password, or empty when no password was supplied.
pattern() - Method in record class org.mqtt4j.hato.TopicFilter: Returns the value of the pattern record component.
payload() - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy of the application bytes.
PAYLOAD_FORMAT_INVALID - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The payload does not conform to its declared format.
payloadSize() - Method in class org.mqtt4j.hato.MqttMessage: Returns the payload byte count without copying its contents.
payloadUtf8() - Method in class org.mqtt4j.hato.MqttMessage: Returns whether the payload is declared as UTF-8 encoded character data.
pending() - Method in class org.mqtt4j.hato.ClientStats.Subscribing: Returns the number of registrations that wait for a connection or for the broker's SUBACK.
PROTOCOL_ERROR - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The packet violates a protocol rule or the expected exchange sequence.
protocolLevel() - Method in enum class org.mqtt4j.hato.MqttVersion: Returns the protocol level sent in the CONNECT packet.
PUBLICATION_BYTES - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The bytes that unfinished publications keep.
publications() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns all unfinished QoS 1 and QoS 2 publications, against MqttClientBuilder.maxInflightPublishes(int).
publish(MqttMessage) - Method in interface org.mqtt4j.hato.MqttPublisher: Publishes a message and completes after its transport write for QoS 0, PUBACK for QoS 1, or PUBCOMP for QoS 2.
publishes(Qos) - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns a lifetime count of the PUBLISH packets received at qos, retransmissions included.
PublishResult - Class in org.mqtt4j.hato: Successful completion of a publication: the transport write for QoS 0, receipt of PUBACK for QoS 1, or receipt of PUBCOMP for QoS 2.
PullSubscription - Interface in org.mqtt4j.hato: A subscription whose deliveries the application takes by calling PullSubscription.receive(), as returned by MqttSubscriber.subscribe(Subscribe).

Q

qos() - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion: Returns the QoS that the publication was sent with.
qos() - Method in class org.mqtt4j.hato.MqttMessage: Returns the requested or received quality of service.
qos() - Method in class org.mqtt4j.hato.Subscribe: Returns the maximum quality of service requested.
Qos - Enum Class in org.mqtt4j.hato: MQTT quality of service levels.
QOS_NOT_SUPPORTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The requested QoS exceeds what the server supports.
queuedBytes() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the bytes of the writes counted by ClientStats.Sending.queuedWrites(), against the send queue's limit.
queuedWrites() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns the writes of any packet that the send queue accepted and has not written yet, against its limit.
quota() - Method in class org.mqtt4j.hato.ClientStats.Sending: Returns how many more QoS 1 and QoS 2 publications the established MQTT 5.0 connection lets the client have in progress, within the broker's Receive Maximum; empty without an established MQTT 5.0 connection.
QUOTA_EXCEEDED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: A resource or administrative quota has been exhausted.

R

RE_AUTHENTICATE - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The client starts authentication again on an existing connection.
reasonCode() - Method in exception class org.mqtt4j.hato.MqttBrokerDisconnectException: Returns the reason code of the broker's DISCONNECT.
reasonCode() - Method in exception class org.mqtt4j.hato.MqttConnectException: Returns the broker's refusal reason, or empty when the attempt failed locally.
reasonCode() - Method in exception class org.mqtt4j.hato.MqttProtocolException: Returns the local failure classification, including for MQTT 3.1.1 connections.
reasonCode() - Method in exception class org.mqtt4j.hato.MqttPublicationRefusedException: Returns the reason for the refusal, received in PUBACK or PUBREC, or the one that the broker would use for a publication that exceeds its announced limits.
reasonCode() - Method in exception class org.mqtt4j.hato.MqttSubscriptionRefusedException: Returns the reason for the refusal, received in SUBACK, or the one that the broker would use for a subscription that it announced it does not support.
reasonCode() - Method in class org.mqtt4j.hato.PublishResult: Returns the reason code of the MQTT 5.0 broker's acknowledgement: that of PUBACK for QoS 1, and that of PUBREC for QoS 2.
ReasonCode - Enum Class in org.mqtt4j.hato: MQTT 5.0 reason codes shared by acknowledgements, disconnection, and authentication.
reasonString() - Method in exception class org.mqtt4j.hato.MqttBrokerDisconnectException: Returns the broker's explanation for people diagnosing the end, or empty when it sent none.
reasonString() - Method in exception class org.mqtt4j.hato.MqttConnectException: Returns the broker's explanation of its refusal for people diagnosing it, or empty when it sent none, as MQTT 3.1.1 brokers never do.
reasonString() - Method in exception class org.mqtt4j.hato.MqttPublicationRefusedException: Returns the broker's explanation for people diagnosing the refusal, received in PUBACK or PUBREC, or empty when the broker sent none or the client refused without sending.
reasonString() - Method in exception class org.mqtt4j.hato.MqttSubscriptionRefusedException: Returns the broker's explanation for people diagnosing the refusal, received in SUBACK, or empty when the broker sent none or the client refused without sending.
receive() - Method in interface org.mqtt4j.hato.PullSubscription: Waits interruptibly for the next delivery.
receive(Duration) - Method in interface org.mqtt4j.hato.PullSubscription: Like PullSubscription.receive(), but returns ReceiveResult.TimedOut if the wait expires while the subscription remains active.
RECEIVE_MAXIMUM_EXCEEDED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: Too many QoS 1 or 2 publications are awaiting acknowledgement.
Received(MqttDelivery) - Constructor for record class org.mqtt4j.hato.ReceiveResult.Received: Creates the outcome that hands delivery to the caller.
ReceiveResult - Interface in org.mqtt4j.hato: The outcome of one pull receive.
ReceiveResult.Ended - Record Class in org.mqtt4j.hato: The subscription ended through its close, a successful unsubscribe once the deliveries it accepted have been received, or MqttClient.close().
ReceiveResult.Received - Record Class in org.mqtt4j.hato: One delivery handed to this caller.
ReceiveResult.TimedOut - Record Class in org.mqtt4j.hato: No delivery became available before the wait expired.
receiving() - Method in class org.mqtt4j.hato.ClientStats: Returns the values of incoming publications, their deliveries, and their acknowledgement exchanges.
receptions() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns all unfinished QoS 1 and QoS 2 receptions, against the client's limit, which includes receptions that a persistent session carries across connections.
RECEPTIONS - Enum constant in enum class org.mqtt4j.hato.ClientStats.OverloadCause: The unfinished QoS 1 and QoS 2 receptions filled the client's receive table.
reconnectDelay() - Method in class org.mqtt4j.hato.Disconnection: Returns the delay, counted from when the client handled this ending, until its next connection attempt, or empty when it will not attempt to connect again unless the application calls MqttClient.connect().
reconnectPolicy(ReconnectPolicy) - Method in class org.mqtt4j.hato.MqttClientBuilder: Decides whether the client reconnects after an established connection ends without a request to stop, and how long it waits between attempts.
ReconnectPolicy - Class in org.mqtt4j.hato: Decides whether and when a client connects again after an established connection ends without a request to stop.
refusals() - Method in class org.mqtt4j.hato.ClientStats: Returns lifetime counts of operations that the client refused for capacity, by the limit that refused them.
REFUSED - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: Its hand-off acceptor refused it.
REGISTRATION_QUEUE - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The registrations waiting for the client to process them.
registrations() - Method in class org.mqtt4j.hato.ClientStats.Subscribing: Returns the registrations that the client has processed, against MqttClientBuilder.maxSubscriptions(int): the sum of ClientStats.Subscribing.established(), ClientStats.Subscribing.pending(), and ClientStats.Subscribing.removing().
removing() - Method in class org.mqtt4j.hato.ClientStats.Subscribing: Returns the number of registrations whose removal waits for the broker's UNSUBACK or for a connection that discards the session.
RESERVED_SENDS - Enum constant in enum class org.mqtt4j.hato.ClientStats.OverloadCause: CONNECT, PINGREQ, or DISCONNECT found no room in the send capacity reserved for them.
responseTimeout(Duration) - Method in class org.mqtt4j.hato.MqttClientBuilder: How long the broker may take to answer SUBSCRIBE, UNSUBSCRIBE, and each stage of a QoS 1 or QoS 2 publication, measured from the completed write of the packet that needs the answer.
responseTopic() - Method in class org.mqtt4j.hato.MqttMessage: Returns the topic for a reply, or empty when absent.
retain() - Method in class org.mqtt4j.hato.MqttMessage: Returns whether publication requests retention, or reception is a retained delivery: one that the broker sent from its retained messages as it made the subscription.
RETAIN_NOT_SUPPORTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server does not support retained publications.
retainAsPublished() - Method in class org.mqtt4j.hato.Subscribe: Returns whether the broker keeps the publisher's retain flag on the messages that it delivers to this subscription.
retainAvailable() - Method in class org.mqtt4j.hato.ConnAck: Returns whether the broker accepts publications with the retain flag on this connection.
retainHandling() - Method in class org.mqtt4j.hato.Subscribe: Returns the Retain Handling option: when the broker sends the matching retained messages as it makes this subscription.
RetainHandling - Enum Class in org.mqtt4j.hato: When the broker sends the retained messages that match a subscription as it makes the subscription (the MQTT 5.0 Retain Handling option).
running() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the number of deliveries that a handler or a hand-off acceptor is processing.

S

schedule(Duration, Runnable) - Method in interface org.mqtt4j.hato.TimerScheduler: Runs a task once after a nonnegative delay.
send(long, byte[]) - Method in interface org.mqtt4j.hato.Transport: Starts one write without waiting.
SEND - Enum constant in enum class org.mqtt4j.hato.RetainHandling: Send them whenever the subscription is made, as MQTT 3.1.1 does.
SEND_IF_NEW_SUBSCRIPTION - Enum constant in enum class org.mqtt4j.hato.RetainHandling: Send them only when the subscription did not exist in the session.
SEND_QUEUE - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: The send queue, or a backlog in it that waits for send capacity.
sending() - Method in class org.mqtt4j.hato.ClientStats: Returns the values of outgoing writes and publication exchanges.
serial() - Static method in class org.mqtt4j.hato.DeliveryOptions: One delivery at a time, in receive order, on an internal thread: the behavior of MqttSubscriber.subscribe(Subscribe, java.util.function.Consumer).
server(URI) - Method in class org.mqtt4j.hato.MqttClientBuilder: A required broker URI using mqtt for TCP, mqtts for TLS over TCP, ws for WebSocket, or wss for WebSocket over TLS.
SERVER_BUSY - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server cannot currently accept work because it is busy.
SERVER_MOVED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server has moved to a different address.
SERVER_SHUTTING_DOWN - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server is closing the connection as part of its shutdown.
SERVER_UNAVAILABLE - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server cannot currently accept a connection.
serverReference() - Method in exception class org.mqtt4j.hato.MqttBrokerDisconnectException: Returns the server that the broker named for the client to use instead, or empty when it named none.
serverReference() - Method in exception class org.mqtt4j.hato.MqttConnectException: Returns the server that the broker named for the client to use instead, or empty when it named none.
SESSION_TAKEN_OVER - Enum constant in enum class org.mqtt4j.hato.ReasonCode: Another connection using the same client identifier has replaced this connection.
sessionExpiry(Duration) - Method in class org.mqtt4j.hato.MqttClientBuilder: Configures how long the session outlasts a connection; default zero, which starts a new session for each connection.
sessionPresent() - Method in class org.mqtt4j.hato.ConnAck: Returns whether the broker resumed an existing session.
SHARED_SUBSCRIPTIONS_NOT_SUPPORTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server does not support shared subscriptions.
sharedSubscriptionAvailable() - Method in class org.mqtt4j.hato.ConnAck: Returns whether the broker accepts shared subscriptions.
SKIP - Enum constant in enum class org.mqtt4j.hato.FailurePolicy: Skips every failed delivery: a QoS 1 or 2 delivery is acknowledged without processing, and a QoS 0 delivery is dropped.
sslContext(SSLContext) - Method in class org.mqtt4j.hato.MqttClientBuilder: Supplies the TLS context for an mqtts or wss connection, including trust and client keys.
sslParameters(Consumer) - Method in class org.mqtt4j.hato.MqttClientBuilder: Customizes TLS parameters once per MqttClientBuilder.build(), starting with the selected context's defaults and endpoint identification set to "HTTPS" for hostname verification.
start(URI, Duration, Transport.Listener) - Method in interface org.mqtt4j.hato.Transport: Starts this transport's only connection.
state() - Method in class org.mqtt4j.hato.ClientStats.Connection: Returns the connection's state.
stats() - Method in interface org.mqtt4j.hato.MqttClient: Takes a snapshot of what this client holds and has counted, which only the client can know; see ClientStats.
STOP - Enum constant in enum class org.mqtt4j.hato.FailurePolicy: Stops the client when the failed delivery still holds back its acknowledgement: a QoS 1 or 2 delivery with AckMode.AFTER_HANDLER, or with AckMode.MANUAL before MqttDelivery.ack().
striped(int) - Static method in class org.mqtt4j.hato.DeliveryOptions: Runs deliveries with equal topics one at a time in receive order, and deliveries with different topics possibly at the same time, at most stripes at once.
striped(int, Function) - Static method in class org.mqtt4j.hato.DeliveryOptions: Like DeliveryOptions.striped(int), with the key that key returns for each message in place of its topic; keys are compared with equals and hashCode.
subscribe(Subscribe) - Method in interface org.mqtt4j.hato.MqttSubscriber: Registers a pull subscription, whose deliveries the application's threads take with PullSubscription.receive().
subscribe(Subscribe, Consumer) - Method in interface org.mqtt4j.hato.MqttSubscriber: Registers one subscription and returns its handle immediately, including while the client is disconnected or connecting.
subscribe(Subscribe, DeliveryOptions, Consumer) - Method in interface org.mqtt4j.hato.MqttSubscriber: Registers a push subscription like MqttSubscriber.subscribe(Subscribe, Consumer), except that options decides where and how its handler runs; see DeliveryOptions.
Subscribe - Class in org.mqtt4j.hato: A request for one subscription.
subscribing() - Method in class org.mqtt4j.hato.ClientStats: Returns the values of the subscription registrations and delivery lanes, in total.
subscription() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the subscription's handle.
subscription() - Method in class org.mqtt4j.hato.MetricsListener.DeliveryStart: Returns the subscription whose delivery this is.
Subscription - Interface in org.mqtt4j.hato: One subscription registration, which can await its first connection or SUBACK.
SUBSCRIPTION_FULL - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: The client dropped a QoS 0 delivery to keep its subscription within its buffer capacity.
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server does not support subscription identifiers.
SUBSCRIPTION_STOPPED - Enum constant in enum class org.mqtt4j.hato.ClientStats.DropReason: Its subscription stopped while it waited.
subscriptions() - Method in class org.mqtt4j.hato.ClientStats: Returns the values of each subscription that the client holds, in no particular order.
SUBSCRIPTIONS - Enum constant in enum class org.mqtt4j.hato.CapacityLimit: MqttClientBuilder.maxSubscriptions(int), for registrations and delivery lanes.
SUCCESS - Enum constant in enum class org.mqtt4j.hato.ReasonCode: Success, normal disconnection, or granted QoS 0, depending on the packet.

T

tcp(String) - Static method in interface org.mqtt4j.hato.Transport: Creates a plain TCP transport accepting only mqtt URIs (default port 1883).
terminated() - Method in interface org.mqtt4j.hato.MqttClient: Observes the end of this client's work without requesting it; it completes only after the client is closed.
terminated() - Method in interface org.mqtt4j.hato.Subscription: Observes the end of this subscription's local work without requesting it.
TimedOut() - Constructor for record class org.mqtt4j.hato.ReceiveResult.TimedOut: Creates an instance of a TimedOut record class.
timerScheduler(TimerScheduler) - Method in class org.mqtt4j.hato.MqttClientBuilder: Supplies monotonic time and delayed callbacks.
TimerScheduler - Interface in org.mqtt4j.hato: Monotonic time and delayed execution.
TimerScheduler.Cancellable - Interface in org.mqtt4j.hato: A handle to a task scheduled with TimerScheduler.schedule(Duration, Runnable).
topic() - Method in class org.mqtt4j.hato.MqttMessage: Returns the published topic name.
Topic - Record Class in org.mqtt4j.hato: A validated MQTT topic name used when publishing a message.
Topic(String) - Constructor for record class org.mqtt4j.hato.Topic: Creates a topic after validating its name.
TOPIC_ALIAS_INVALID - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The topic alias is zero or exceeds the negotiated maximum.
TOPIC_FILTER_INVALID - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The receiver does not accept the topic filter.
TOPIC_NAME_INVALID - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The receiver does not accept the topic name.
TopicFilter - Record Class in org.mqtt4j.hato: A validated MQTT topic filter using the common topic and wildcard rules.
TopicFilter(String) - Constructor for record class org.mqtt4j.hato.TopicFilter: Creates a filter after validating its pattern.
toString() - Method in class org.mqtt4j.hato.ClientStats
toString() - Method in record class org.mqtt4j.hato.ClientStats.Usage: Returns a string representation of this record class.
toString() - Method in class org.mqtt4j.hato.ConnAck
toString() - Method in class org.mqtt4j.hato.Disconnection
toString() - Method in class org.mqtt4j.hato.MetricsListener.DeliveryStart
toString() - Method in class org.mqtt4j.hato.MetricsListener.PublishCompletion
toString() - Method in class org.mqtt4j.hato.MqttCredentials
toString() - Method in class org.mqtt4j.hato.MqttMessage
toString() - Method in class org.mqtt4j.hato.PublishResult
toString() - Method in record class org.mqtt4j.hato.ReceiveResult.Ended: Returns a string representation of this record class.
toString() - Method in record class org.mqtt4j.hato.ReceiveResult.Received: Returns a string representation of this record class.
toString() - Method in record class org.mqtt4j.hato.ReceiveResult.TimedOut: Returns a string representation of this record class.
toString() - Method in class org.mqtt4j.hato.ReconnectPolicy
toString() - Method in class org.mqtt4j.hato.Subscribe
toString() - Method in record class org.mqtt4j.hato.Topic: Returns the topic name unchanged.
toString() - Method in record class org.mqtt4j.hato.TopicFilter: Returns the pattern unchanged.
toString() - Method in class org.mqtt4j.hato.UserProperty
Transport - Interface in org.mqtt4j.hato: A single-use, ordered byte connection.
Transport.Factory - Interface in org.mqtt4j.hato: Creates a client's transports, one for each connection; see MqttClientBuilder.transportFactory(Transport.Factory).
Transport.Listener - Interface in org.mqtt4j.hato: Receives the serialized callbacks of one transport, as Transport describes.
Transport.SendResult - Enum Class in org.mqtt4j.hato: The immediate admission result; only Transport.SendResult.ACCEPTED transfers buffer ownership.
transportFactory(Transport.Factory) - Method in class org.mqtt4j.hato.MqttClientBuilder: Supplies a fresh transport for each connection; an MQTT 3.1.1 attempt that replaces a broker session, as MqttClient.connect() describes, opens several.

U

unmatched() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns a lifetime count of received publications that matched no subscription.
unrouted() - Method in class org.mqtt4j.hato.ClientStats.Receiving: Returns a lifetime count of received QoS 0 publications that the client dropped before routing them, because they arrived faster than it could route them.
UNSPECIFIED_ERROR - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The operation failed without a more specific reason.
unsubscribe() - Method in interface org.mqtt4j.hato.Subscription: Stops new local delivery when called and observes confirmed removal.
UNSUPPORTED_PROTOCOL_VERSION - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server does not support the requested MQTT version.
Usage(long, long) - Constructor for record class org.mqtt4j.hato.ClientStats.Usage: Creates an instance of a Usage record class.
USE_ANOTHER_SERVER - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The client should try a different server.
used() - Method in record class org.mqtt4j.hato.ClientStats.Usage: Returns the value of the used record component.
username() - Method in class org.mqtt4j.hato.MqttCredentials: Returns the username, which may be empty.
userProperties() - Method in class org.mqtt4j.hato.MqttMessage: Returns the User Properties in order, possibly repeating a name.
UserProperty - Class in org.mqtt4j.hato: An MQTT 5.0 User Property of a message: a name and a value that the application chooses.
UserProperty(String, String) - Constructor for class org.mqtt4j.hato.UserProperty: Validates both strings.
userRequested() - Method in class org.mqtt4j.hato.Disconnection: Returns whether disconnect or close was requested by the application.

V

V3_1_1 - Enum constant in enum class org.mqtt4j.hato.MqttVersion: MQTT 3.1.1.
V5 - Enum constant in enum class org.mqtt4j.hato.MqttVersion: MQTT 5.0.
value() - Method in enum class org.mqtt4j.hato.ReasonCode: Returns the unsigned byte value used by MQTT 5.0 on the wire.
value() - Method in class org.mqtt4j.hato.UserProperty: Returns the property value, possibly empty.
valueOf(String) - Static method in enum class org.mqtt4j.hato.AckMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.CapacityLimit: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.ClientStats.ConnectionState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.ClientStats.DropReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.ClientStats.OverloadCause: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.FailurePolicy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.MqttVersion: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.Qos: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.ReasonCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.RetainHandling: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.mqtt4j.hato.Transport.SendResult: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.mqtt4j.hato.AckMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.CapacityLimit: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.ClientStats.ConnectionState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.ClientStats.DropReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.ClientStats.OverloadCause: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.FailurePolicy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.MqttVersion: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.Qos: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.ReasonCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.RetainHandling: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.mqtt4j.hato.Transport.SendResult: Returns an array containing the constants of this enum class, in the order they are declared.
version(MqttVersion) - Method in class org.mqtt4j.hato.MqttClientBuilder: Selects the wire protocol; default MqttVersion.V5.

W

waited() - Method in class org.mqtt4j.hato.MetricsListener.DeliveryStart: Returns the time from when the client received the PUBLISH from its transport to when application code received the delivery.
waiting() - Method in class org.mqtt4j.hato.ClientStats.SubscriptionStats: Returns the number of deliveries that wait for a handler, an acceptor, or a receiver.
WAITING_TO_RECONNECT - Enum constant in enum class org.mqtt4j.hato.ClientStats.ConnectionState: A connection ended, and the client waits to try again.
whenConnected() - Method in interface org.mqtt4j.hato.MqttClient: Observes the current or next established connection without requesting one.
WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED - Enum constant in enum class org.mqtt4j.hato.ReasonCode: The server does not support wildcard subscriptions.
wildcardSubscriptionAvailable() - Method in class org.mqtt4j.hato.ConnAck: Returns whether the broker accepts subscriptions whose filters contain wildcards.
will(MqttMessage) - Method in class org.mqtt4j.hato.MqttClientBuilder: Configures the message the broker publishes if the connection ends without receiving MQTT DISCONNECT, including MqttClient.close() alone.
willDelay(Duration) - Method in class org.mqtt4j.hato.MqttClientBuilder: Delays the Will (the MQTT 5.0 Will Delay Interval); default zero.
withAckMode(AckMode) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy that uses ackMode instead of the default.
withAdministrativeActionRetry() - Method in class org.mqtt4j.hato.ReconnectPolicy: Returns a policy that also reconnects after an MQTT 5.0 broker ends the connection with DISCONNECT 0x98 (Administrative action), with the same backoff as after other failures.
withBufferCapacity(int) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy with a different buffer capacity.
withContentType(String) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a content type (the MQTT 5.0 Content Type) that describes the payload, such as a MIME type.
withCorrelationData(byte[]) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a copy of correlationData (the MQTT 5.0 Correlation Data), at most 65535 bytes and possibly empty, which a reply can return to identify its request.
withExecutor(Executor) - Method in class org.mqtt4j.hato.DeliveryOptions: Keeps the order, stripes, or parallelism of these options, with each handler running on executor instead of an internal thread.
withFailurePolicy(FailurePolicy) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy that handles handler failures with failurePolicy instead of FailurePolicy.STOP.
withInitialRetry() - Method in class org.mqtt4j.hato.ReconnectPolicy: Returns a policy that also retries a connection request's failures before its first successful connection, so its MqttClient.connect() future waits, possibly without limit, until a connection is established or the client gives the request up.
withMaximumPacketSize(int) - Method in class org.mqtt4j.hato.ConnAck: Returns a copy with a different largest packet that the broker accepts.
withMaximumQos(Qos) - Method in class org.mqtt4j.hato.ConnAck: Returns a copy with a different highest QoS at which the broker accepts publications.
withMessageExpiry(Duration) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a lifetime (the MQTT 5.0 Message Expiry Interval) from zero to 4294967295 seconds; a fraction of a second is rounded up when sent.
withNoLocal(boolean) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy that asks the broker not to deliver this client's own publications to this subscription (the MQTT 5.0 No Local option), or to deliver them as usual.
withoutUnspecifiedErrorRetry() - Method in class org.mqtt4j.hato.ReconnectPolicy: Returns a policy that stops reconnecting when an MQTT 5.0 broker refuses a connection or ends one with reason code 0x80 (Unspecified error), in CONNACK or DISCONNECT.
withPayload(byte[]) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a different payload, copying the supplied bytes.
withPayloadUtf8(boolean) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy that declares the payload as UTF-8 encoded character data (true, the MQTT 5.0 Payload Format Indicator) or as unspecified bytes (false).
withQos(Qos) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a different requested or received quality of service.
withResponseTopic(Topic) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy that names the topic for a reply (the MQTT 5.0 Response Topic).
withRetain(boolean) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a different retention request or retained-delivery flag.
withRetainAsPublished(boolean) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy that asks the broker to keep the retain flag that each publisher set on the messages that it delivers to this subscription (the MQTT 5.0 Retain As Published option), or to clear it as usual; see MqttMessage.retain().
withRetainAvailable(boolean) - Method in class org.mqtt4j.hato.ConnAck: Returns a copy with a different answer to whether the broker accepts retained publications.
withRetainHandling(RetainHandling) - Method in class org.mqtt4j.hato.Subscribe: Returns a copy that decides when the broker sends the matching retained messages as it makes this subscription (the MQTT 5.0 Retain Handling option).
withSharedSubscriptionAvailable(boolean) - Method in class org.mqtt4j.hato.ConnAck: Returns a copy with a different answer to whether the broker accepts shared subscriptions.
withTopic(Topic) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy with a different published topic.
withUserProperties(List) - Method in class org.mqtt4j.hato.MqttMessage: Returns a copy whose User Properties are a copy of userProperties, in the same order.
withWildcardSubscriptionAvailable(boolean) - Method in class org.mqtt4j.hato.ConnAck: Returns a copy with a different answer to whether the broker accepts wildcard subscriptions.

A B C D E F G H I K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form