Package com.hivemq.client.mqtt.mqtt5

Interface Mqtt5AsyncClient

All Superinterfaces:

Mqtt5Client, MqttClient

@DoNotImplement
public interface Mqtt5AsyncClient
extends Mqtt5Client

Asynchronous API of an Mqtt5Client based on futures and callbacks.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder	Builder for a Mqtt5Subscribe and additional arguments that are applied to a subscribe(Mqtt5Subscribe), subscribe(Mqtt5Subscribe, Consumer, boolean) or subscribe(Mqtt5Subscribe, Consumer, Executor, boolean) call.

Field Summary

Fields inherited from interface com.hivemq.client.mqtt.MqttClient

DEFAULT_SERVER_HOST, DEFAULT_SERVER_PORT, DEFAULT_SERVER_PORT_SSL, DEFAULT_SERVER_PORT_WEBSOCKET, DEFAULT_SERVER_PORT_WEBSOCKET_SSL

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<@NotNull Mqtt5ConnAck>	connect()	Connects this client with the default Connect message.
@NotNull CompletableFuture<@NotNull Mqtt5ConnAck>	connect(@NotNull Mqtt5Connect connect)	Connects this client with the given Connect message.
@NotNull Mqtt5ConnectBuilder.Send<CompletableFuture<Mqtt5ConnAck>>	connectWith()	Fluent counterpart of connect(Mqtt5Connect).
@NotNull CompletableFuture<Void>	disconnect()	Disconnects this client with the default Disconnect message.
@NotNull CompletableFuture<Void>	disconnect(@NotNull Mqtt5Disconnect disconnect)	Disconnects this client with the given Disconnect message.
@NotNull Mqtt5DisconnectBuilder.Send<CompletableFuture<Void>>	disconnectWith()	Fluent counterpart of disconnect(Mqtt5Disconnect).
@NotNull CompletableFuture<@NotNull Mqtt5PublishResult>	publish(@NotNull Mqtt5Publish publish)	Publishes the given Publish message.
void	publishes(@NotNull MqttGlobalPublishFilter filter, @NotNull Consumer<@NotNull Mqtt5Publish> callback)	Globally consumes all incoming Publish messages matching the given filter.
void	publishes(@NotNull MqttGlobalPublishFilter filter, @NotNull Consumer<@NotNull Mqtt5Publish> callback, boolean manualAcknowledgement)	Globally consumes all incoming Publish messages matching the given filter.
void	publishes(@NotNull MqttGlobalPublishFilter filter, @NotNull Consumer<@NotNull Mqtt5Publish> callback, @NotNull Executor executor)	Globally consumes all incoming Publish messages matching the given filter.
void	publishes(@NotNull MqttGlobalPublishFilter filter, @NotNull Consumer<@NotNull Mqtt5Publish> callback, @NotNull Executor executor, boolean manualAcknowledgement)	Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt5PublishBuilder.Send<CompletableFuture<Mqtt5PublishResult>>	publishWith()	Fluent counterpart of publish(Mqtt5Publish).
@NotNull CompletableFuture<Void>	reauth()	Re-authenticates this client.
@NotNull CompletableFuture<@NotNull Mqtt5SubAck>	subscribe(@NotNull Mqtt5Subscribe subscribe)	Subscribes this client with the given Subscribe message.
@NotNull CompletableFuture<@NotNull Mqtt5SubAck>	subscribe(@NotNull Mqtt5Subscribe subscribe, @NotNull Consumer<@NotNull Mqtt5Publish> callback)	Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull CompletableFuture<@NotNull Mqtt5SubAck>	subscribe(@NotNull Mqtt5Subscribe subscribe, @NotNull Consumer<@NotNull Mqtt5Publish> callback, boolean manualAcknowledgement)	Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull CompletableFuture<@NotNull Mqtt5SubAck>	subscribe(@NotNull Mqtt5Subscribe subscribe, @NotNull Consumer<@NotNull Mqtt5Publish> callback, @NotNull Executor executor)	Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull CompletableFuture<@NotNull Mqtt5SubAck>	subscribe(@NotNull Mqtt5Subscribe subscribe, @NotNull Consumer<@NotNull Mqtt5Publish> callback, @NotNull Executor executor, boolean manualAcknowledgement)	Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Start	subscribeWith()	Fluent counterpart of subscribe(Mqtt5Subscribe), subscribe(Mqtt5Subscribe, Consumer, boolean) and subscribe(Mqtt5Subscribe, Consumer, Executor, boolean).
default @NotNull Mqtt5AsyncClient	toAsync()	Turns the API of this client into a asynchronous API based on futures and callbacks.
@NotNull CompletableFuture<@NotNull Mqtt5UnsubAck>	unsubscribe(@NotNull Mqtt5Unsubscribe unsubscribe)	Unsubscribes this client with the given Unsubscribe message.
@NotNull Mqtt5UnsubscribeBuilder.Send.Start<CompletableFuture<Mqtt5UnsubAck>>	unsubscribeWith()	Fluent counterpart of unsubscribe(Mqtt5Unsubscribe).

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.Mqtt5Client

getConfig, toBlocking, toRx

Methods inherited from interface com.hivemq.client.mqtt.MqttClient

getState

Method Details

connect

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5ConnAck> connect()

Connects this client with the default Connect message.

Returns:

see connect(Mqtt5Connect).

See Also:

• connect(Mqtt5Connect)

connect

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5ConnAck> connect(@NotNull
 @NotNull Mqtt5Connect connect)

Connects this client with the given Connect message.

Parameters:

connect - the Connect message sent to the broker.

Returns:

a CompletableFuture which

• completes normally with the ConnAck message if it does not contain an Error Code (connected successfully),
• completes exceptionally with a Mqtt5ConnAckException wrapping the ConnAck message if it contains an Error Code or
• completes exceptionally with a different exception if an error occurred before the Connect message was sent or before the ConnAck message was received.

connectWith

@CheckReturnValue
@NotNull Mqtt5ConnectBuilder.Send<CompletableFuture<Mqtt5ConnAck>> connectWith()

Fluent counterpart of connect(Mqtt5Connect).

Calling Mqtt5ConnectBuilder.Send.send() on the returned builder has the same effect as calling connect(Mqtt5Connect) with the result of Mqtt5ConnectBuilder.build().

Returns:

the fluent builder for the Connect message.

See Also:

• connect(Mqtt5Connect)

subscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe)

Subscribes this client with the given Subscribe message.

See publishes(MqttGlobalPublishFilter, Consumer) or publishes(MqttGlobalPublishFilter, Consumer, Executor) to consume the incoming Publish messages. Alternatively, call subscribe(Mqtt5Subscribe, Consumer) or subscribe(Mqtt5Subscribe, Consumer, Executor) to consume the incoming Publish messages matching the subscriptions of the Subscribe message directly.

Parameters:

subscribe - the Subscribe messages sent to the broker.

Returns:

a CompletableFuture which

• completes normally with the SubAck message if all subscriptions of the Subscribe message were successful (the SubAck message contains no Error Codes),
• completes exceptionally with a Mqtt5SubAckException wrapping the SubAck message if it contains at least one Error Code or
• completes exceptionally with a different exception if an error occurred before the Subscribe message was sent or before a SubAck message was received.

subscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback)

Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.

Parameters:

subscribe - the Subscribe messages sent to the broker.

callback - the callback for consuming the incoming Publish messages matching the subscriptions of the Subscribe message.

Returns:

see subscribe(Mqtt5Subscribe).

See Also:

• subscribe(Mqtt5Subscribe, Consumer, Executor)
• subscribe(Mqtt5Subscribe, Consumer, boolean)
• subscribe(Mqtt5Subscribe, Consumer, Executor, boolean)

subscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 @NotNull
 @NotNull Executor executor)

Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.

The future is completed and the callback is executed on the given executor.

Parameters:

subscribe - the Subscribe messages sent to the broker.

callback - the callback for consuming the incoming Publish messages matching the subscriptions of the Subscribe message.

executor - the executor where the future is completed and the callback is executed on.

Returns:

see subscribe(Mqtt5Subscribe).

See Also:

• subscribe(Mqtt5Subscribe, Consumer)
• subscribe(Mqtt5Subscribe, Consumer, boolean)
• subscribe(Mqtt5Subscribe, Consumer, Executor, boolean)

subscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 boolean manualAcknowledgement)

Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.

Parameters:

subscribe - the Subscribe messages sent to the broker.

callback - the callback for consuming the incoming Publish messages matching the subscriptions of the Subscribe message.

manualAcknowledgement - whether the Publish messages are acknowledged manually.

Returns:

see subscribe(Mqtt5Subscribe).

Since:

1.2

See Also:

• subscribe(Mqtt5Subscribe, Consumer)
• subscribe(Mqtt5Subscribe, Consumer, Executor)
• subscribe(Mqtt5Subscribe, Consumer, Executor, boolean)

subscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 @NotNull
 @NotNull Executor executor,
 boolean manualAcknowledgement)

Subscribes this client with the given Subscribe message and consumes the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.

The future is completed and the callback is executed on the given executor.

Parameters:

subscribe - the Subscribe messages sent to the broker.

callback - the callback for consuming the incoming Publish messages matching the subscriptions of the Subscribe message.

executor - the executor where the future is completed and the callback is executed on.

manualAcknowledgement - whether the Publish messages are acknowledged manually.

Returns:

see subscribe(Mqtt5Subscribe).

Since:

1.2

See Also:

• subscribe(Mqtt5Subscribe, Consumer)
• subscribe(Mqtt5Subscribe, Consumer, Executor)
• subscribe(Mqtt5Subscribe, Consumer, boolean)

subscribeWith

@CheckReturnValue
@NotNull Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Start subscribeWith()

Fluent counterpart of subscribe(Mqtt5Subscribe), subscribe(Mqtt5Subscribe, Consumer, boolean) and subscribe(Mqtt5Subscribe, Consumer, Executor, boolean).

Calling Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Call.send() on the returned builder has the same effect as calling one of the following methods:

• subscribe(Mqtt5Subscribe) if no callback has been supplied to the builder
• subscribe(Mqtt5Subscribe, Consumer) if only a callback has been supplied to the builder
• subscribe(Mqtt5Subscribe, Consumer, Executor) if a callback and an executor has been supplied to the builder

Returns:

the fluent builder for the Subscribe message.

See Also:

• subscribe(Mqtt5Subscribe)
• subscribe(Mqtt5Subscribe, Consumer, boolean)
• subscribe(Mqtt5Subscribe, Consumer, Executor, boolean)

publishes

void publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

callback - the callback for all incoming Publish messages matching the given filter.

See Also:

• publishes(MqttGlobalPublishFilter, Consumer, Executor)
• publishes(MqttGlobalPublishFilter, Consumer, boolean)
• publishes(MqttGlobalPublishFilter, Consumer, Executor, boolean)

publishes

void publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 @NotNull
 @NotNull Executor executor)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

callback - the callback for all incoming Publish messages matching the given filter.

executor - the executor where the callback is executed on.

See Also:

• publishes(MqttGlobalPublishFilter, Consumer)
• publishes(MqttGlobalPublishFilter, Consumer, boolean)
• publishes(MqttGlobalPublishFilter, Consumer, Executor, boolean)

publishes

void publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 boolean manualAcknowledgement)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

callback - the callback for all incoming Publish messages matching the given filter.

manualAcknowledgement - whether the Publish messages are acknowledged manually.

Since:

1.2

See Also:

• publishes(MqttGlobalPublishFilter, Consumer)
• publishes(MqttGlobalPublishFilter, Consumer, Executor)
• publishes(MqttGlobalPublishFilter, Consumer, Executor, boolean)

publishes

void publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 @NotNull
 @NotNull Consumer<@NotNull Mqtt5Publish> callback,
 @NotNull
 @NotNull Executor executor,
 boolean manualAcknowledgement)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

callback - the callback for all incoming Publish messages matching the given filter.

executor - the executor where the callback is executed on.

manualAcknowledgement - whether the Publish messages are acknowledged manually.

Since:

1.2

See Also:

• publishes(MqttGlobalPublishFilter, Consumer)
• publishes(MqttGlobalPublishFilter, Consumer, Executor)
• publishes(MqttGlobalPublishFilter, Consumer, boolean)

unsubscribe

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5UnsubAck> unsubscribe(@NotNull
 @NotNull Mqtt5Unsubscribe unsubscribe)

Unsubscribes this client with the given Unsubscribe message.

Parameters:

unsubscribe - the Unsubscribe message sent to the broker.

Returns:

a CompletableFuture which

• completes normally with the UnsubAck message if all Topic Filters of the Unsubscribe message were successfully unsubscribed (the UnsubAck message contains no Error Codes),
• completes exceptionally with a Mqtt5UnsubAckException wrapping the UnsubAck message if it contains at least one Error Code or
• completes exceptionally with a different exception if an error occurred before the Unsubscribe message was sent or before a UnsubAck message was received.

unsubscribeWith

@CheckReturnValue
@NotNull Mqtt5UnsubscribeBuilder.Send.Start<CompletableFuture<Mqtt5UnsubAck>> unsubscribeWith()

Fluent counterpart of unsubscribe(Mqtt5Unsubscribe).

Calling Mqtt5UnsubscribeBuilder.Send.Complete.send() on the returned builder has the same effect as calling unsubscribe(Mqtt5Unsubscribe) with the result of Mqtt5UnsubscribeBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• unsubscribe(Mqtt5Unsubscribe)

publish

@NotNull
@NotNull CompletableFuture<@NotNull Mqtt5PublishResult> publish(@NotNull
 @NotNull Mqtt5Publish publish)

Publishes the given Publish message.

Parameters:

publish - the Publish message sent to the broker.

Returns:

a CompletableFuture which

• completes normally with the Mqtt5PublishResult if the Publish message was successfully published (no acknowledgement message contains an Error Code, Mqtt5PublishResult.getError() will always be absent),
• completes exceptionally with a Mqtt5PubAckException or Mqtt5PubRecException wrapping the acknowledgement message if it contains an Error Code or
• completes exceptionally with a different exception if an error occurred before the Publish message was sent or before an acknowledgement message was received.

publishWith

@CheckReturnValue
@NotNull Mqtt5PublishBuilder.Send<CompletableFuture<Mqtt5PublishResult>> publishWith()

Fluent counterpart of publish(Mqtt5Publish).

Calling Mqtt5PublishBuilder.Send.Complete.send() on the returned builder has the same effect as calling publish(Mqtt5Publish) with the result of Mqtt5PublishBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• publish(Mqtt5Publish)

reauth

@NotNull
@NotNull CompletableFuture<Void> reauth()

Re-authenticates this client.

Returns:

a CompletableFuture which

• completes normally when the client was successfully re-authenticated,
• errors with a Mqtt5AuthException wrapping the Auth message with the Error Code if not re-authenticated successfully or
• errors with a different exception if an error occurred before the first Auth message was sent or before the last Auth message was received.

disconnect

@NotNull
@NotNull CompletableFuture<Void> disconnect()

Disconnects this client with the default Disconnect message.

Returns:

see disconnect(Mqtt5Disconnect).

See Also:

• disconnect(Mqtt5Disconnect)

disconnect

@NotNull
@NotNull CompletableFuture<Void> disconnect(@NotNull
 @NotNull Mqtt5Disconnect disconnect)

Disconnects this client with the given Disconnect message.

Parameters:

disconnect - the Disconnect message sent to the broker.

Returns:

the CompletableFuture which

• completes when the client was successfully disconnected or
• errors if not disconnected gracefully.

disconnectWith

@CheckReturnValue
@NotNull Mqtt5DisconnectBuilder.Send<CompletableFuture<Void>> disconnectWith()

Fluent counterpart of disconnect(Mqtt5Disconnect).

Calling Mqtt5DisconnectBuilder.Send.send() on the returned builder has the same effect as calling disconnect(Mqtt5Disconnect) with the result of Mqtt5DisconnectBuilder.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• disconnect(Mqtt5Disconnect)

toAsync

@CheckReturnValue
@NotNull
default @NotNull Mqtt5AsyncClient toAsync()

Description copied from interface: Mqtt5Client

Turns the API of this client into a asynchronous API based on futures and callbacks.

The asynchronous API can be used simultaneously with the other APIs.

Specified by:

toAsync in interface Mqtt5Client

Returns:

a asynchronous API for this client.