Package org.mqtt4j.hato
@NullMarked
package org.mqtt4j.hato
The public API of the Hato client.
Applications use values and client interfaces, and supply listeners. Transport and
TimerScheduler let tests and integrations replace the client's connections and clock.
Everything is non-null unless marked @Nullable.
-
ClassDescriptionWhen a subscription makes a QoS 1 or QoS 2 delivery eligible for acknowledgement.A limit that refuses operations with
MqttCapacityExceptionwhen it is full.What a client holds and has counted, as only the client can know it, collected at one point afterMqttClient.stats()was called.The connection's state and attempt numbers.The state of a client's connection.Why a delivery left its subscription unprocessed.Why the client ended a connection as overloaded.Incoming publications, their deliveries, and their acknowledgement exchanges.Outgoing writes and publication exchanges.The subscription registrations and delivery lanes, in total.The values of one subscription.How much of a limit is in use.The broker's successful connection acknowledgement, with the limits that the broker announced for the connection.Receives connection and subscription notifications serially, independently of I/O and operation completion.Where and how a push subscription runs its handler, forMqttSubscriber.subscribe(Subscribe, DeliveryOptions, java.util.function.Consumer).The end of an established connection, or of a connection attempt that established none.What a push subscription does when its handler throws for a delivery, and a hand-off subscription when its acceptor throws.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.When application code received one delivery.How one admitted publication completed.An MQTT 5.0 broker ended the connection with DISCONNECT.A bounded resource has no available capacity.Owns an MQTT connection.Configures a client without opening a connection.A connection attempt failed.A connection ended before an operation's outcome could be confirmed.Immutable MQTT credentials: a username and an optional binary password.An application delivery for one subscription.Base class for failures of MQTT operations.An immutable application message: a topic, a payload, a QoS, a retain flag, and the MQTT 5.0 message properties.An operation requires an established connection.A locally detected failure to process an incoming MQTT packet.The broker refused a publication, or would refuse it.The publishing role of a client, without access to its connection lifecycle.The subscribing role of a client, without access to its connection lifecycle.The broker refused a subscription, or would refuse it.The MQTT protocol versions supported by 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.A subscription whose deliveries the application takes by callingPullSubscription.receive(), as returned byMqttSubscriber.subscribe(Subscribe).MQTT quality of service levels.MQTT 5.0 reason codes shared by acknowledgements, disconnection, and authentication.The outcome of one pull receive.The subscription ended through its close, a successful unsubscribe once the deliveries it accepted have been received, orMqttClient.close().One delivery handed to this caller.No delivery became available before the wait expired.Decides whether and when a client connects again after an established connection ends without a request to stop.When the broker sends the retained messages that match a subscription as it makes the subscription (the MQTT 5.0 Retain Handling option).A request for one subscription.One subscription registration, which can await its first connection or SUBACK.Monotonic time and delayed execution.A handle to a task scheduled withTimerScheduler.schedule(Duration, Runnable).A validated MQTT topic name used when publishing a message.A validated MQTT topic filter using the common topic and wildcard rules.A single-use, ordered byte connection.Creates a client's transports, one for each connection; seeMqttClientBuilder.transportFactory(Transport.Factory).Receives the serialized callbacks of one transport, asTransportdescribes.The immediate admission result; onlyTransport.SendResult.ACCEPTEDtransfers buffer ownership.An MQTT 5.0 User Property of a message: a name and a value that the application chooses.