com.hivemq.client.internal.mqtt

Class MqttAsyncClient

java.lang.Object

com.hivemq.client.internal.mqtt.MqttAsyncClient

All Implemented Interfaces:

Mqtt5AsyncClient, Mqtt5Client, MqttClient

public class MqttAsyncClient
extends java.lang.Object
implements Mqtt5AsyncClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MqttAsyncClient.MqttSubscribeAndCallbackBuilder

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient

Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder

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 and Description
@NotNull java.util.concurrent.CompletableFuture<Mqtt5ConnAck>	connect(@Nullable Mqtt5Connect connect) Connects this client with the given Connect message.
@NotNull java.util.concurrent.CompletableFuture<java.lang.Void>	disconnect(@Nullable Mqtt5Disconnect disconnect) Disconnects this client with the given Disconnect message.
@NotNull MqttClientConfig	getConfig()
@NotNull java.util.concurrent.CompletableFuture<Mqtt5PublishResult>	publish(@Nullable Mqtt5Publish publish) Publishes the given Publish message.
void	publishes(@Nullable MqttGlobalPublishFilter filter, @Nullable java.util.function.Consumer<Mqtt5Publish> callback) Globally consumes all incoming Publish messages matching the given filter.
void	publishes(@Nullable MqttGlobalPublishFilter filter, @Nullable java.util.function.Consumer<Mqtt5Publish> callback, @Nullable java.util.concurrent.Executor executor) Globally consumes all incoming Publish messages matching the given filter.
@NotNull java.util.concurrent.CompletableFuture<java.lang.Void>	reauth() Re-authenticates this client.
@NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck>	subscribe(@Nullable Mqtt5Subscribe subscribe) Subscribes this client with the given Subscribe message.
@NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck>	subscribe(@Nullable Mqtt5Subscribe subscribe, @Nullable java.util.function.Consumer<Mqtt5Publish> callback) Subscribes this client with the given Subscribe message and consumes the the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck>	subscribe(@Nullable Mqtt5Subscribe subscribe, @Nullable java.util.function.Consumer<Mqtt5Publish> callback, @Nullable java.util.concurrent.Executor executor) Subscribes this client with the given Subscribe message and consumes the the incoming Publish messages matching the subscriptions of the Subscribe message with a callback.
@NotNull MqttBlockingClient	toBlocking() Turns the API of this client into a blocking API.
@NotNull MqttRxClient	toRx() Turns the API of this client into a reactive API.
@NotNull java.util.concurrent.CompletableFuture<Mqtt5UnsubAck>	unsubscribe(@Nullable Mqtt5Unsubscribe unsubscribe) Unsubscribes this client with the given Unsubscribe message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

connect, connectWith, disconnect, disconnectWith, publishWith, subscribeWith, toAsync, unsubscribeWith

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

builder

Method Detail

connect

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5ConnAck> connect(@Nullable
                                                                                      @Nullable Mqtt5Connect connect)

Description copied from interface: Mqtt5AsyncClient

Connects this client with the given Connect message.

Specified by:

connect in interface Mqtt5AsyncClient

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.

subscribe

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt5Subscribe subscribe)

Description copied from interface: Mqtt5AsyncClient

Subscribes this client with the given Subscribe message.

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

Specified by:

subscribe in interface Mqtt5AsyncClient

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
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt5Subscribe subscribe,
                                                                                       @Nullable
                                                                                       @Nullable java.util.function.Consumer<Mqtt5Publish> callback)

Description copied from interface: Mqtt5AsyncClient

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

Specified by:

subscribe in interface Mqtt5AsyncClient

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 Mqtt5AsyncClient.subscribe(Mqtt5Subscribe).

See Also:

Mqtt5AsyncClient.subscribe(Mqtt5Subscribe, Consumer, Executor)

subscribe

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt5Subscribe subscribe,
                                                                                       @Nullable
                                                                                       @Nullable java.util.function.Consumer<Mqtt5Publish> callback,
                                                                                       @Nullable
                                                                                       @Nullable java.util.concurrent.Executor executor)

Description copied from interface: Mqtt5AsyncClient

Subscribes this client with the given Subscribe message and consumes the 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.

Specified by:

subscribe in interface Mqtt5AsyncClient

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 Mqtt5AsyncClient.subscribe(Mqtt5Subscribe).

See Also:

Mqtt5AsyncClient.subscribe(Mqtt5Subscribe, Consumer)

publishes

public void publishes(@Nullable
                      @Nullable MqttGlobalPublishFilter filter,
                      @Nullable
                      @Nullable java.util.function.Consumer<Mqtt5Publish> callback)

Description copied from interface: Mqtt5AsyncClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt5AsyncClient

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:

Mqtt5AsyncClient.publishes(MqttGlobalPublishFilter, Consumer, Executor)

publishes

public void publishes(@Nullable
                      @Nullable MqttGlobalPublishFilter filter,
                      @Nullable
                      @Nullable java.util.function.Consumer<Mqtt5Publish> callback,
                      @Nullable
                      @Nullable java.util.concurrent.Executor executor)

Description copied from interface: Mqtt5AsyncClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt5AsyncClient

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:

Mqtt5AsyncClient.publishes(MqttGlobalPublishFilter, Consumer)

unsubscribe

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5UnsubAck> unsubscribe(@Nullable
                                                                                           @Nullable Mqtt5Unsubscribe unsubscribe)

Description copied from interface: Mqtt5AsyncClient

Unsubscribes this client with the given Unsubscribe message.

Specified by:

unsubscribe in interface Mqtt5AsyncClient

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.

publish

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt5PublishResult> publish(@Nullable
                                                                                            @Nullable Mqtt5Publish publish)

Description copied from interface: Mqtt5AsyncClient

Publishes the given Publish message.

Specified by:

publish in interface Mqtt5AsyncClient

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.

reauth

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<java.lang.Void> reauth()

Description copied from interface: Mqtt5AsyncClient

Re-authenticates this client.

Specified by:

reauth in interface Mqtt5AsyncClient

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
public @NotNull java.util.concurrent.CompletableFuture<java.lang.Void> disconnect(@Nullable
                                                                                           @Nullable Mqtt5Disconnect disconnect)

Description copied from interface: Mqtt5AsyncClient

Disconnects this client with the given Disconnect message.

Specified by:

disconnect in interface Mqtt5AsyncClient

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.

getConfig

@NotNull
public @NotNull MqttClientConfig getConfig()

Specified by:

getConfig in interface Mqtt5Client

Specified by:

getConfig in interface MqttClient

Returns:

the configuration of this client.

toRx

@NotNull
public @NotNull MqttRxClient toRx()

Description copied from interface: Mqtt5Client

Turns the API of this client into a reactive API.

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

Specified by:

toRx in interface Mqtt5Client

Returns:

a reactive API for this client.

toBlocking

@NotNull
public @NotNull MqttBlockingClient toBlocking()

Description copied from interface: Mqtt5Client

Turns the API of this client into a blocking API.

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

Specified by:

toBlocking in interface Mqtt5Client

Returns:

a blocking API for this client.