com.hivemq.client.internal.mqtt.mqtt3

Class Mqtt3AsyncClientView

java.lang.Object

com.hivemq.client.internal.mqtt.mqtt3.Mqtt3AsyncClientView

All Implemented Interfaces:

Mqtt3AsyncClient, Mqtt3Client, MqttClient

public class Mqtt3AsyncClientView
extends java.lang.Object
implements Mqtt3AsyncClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mqtt3AsyncClientView.Mqtt3SubscribeViewAndCallbackBuilder

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt3.Mqtt3AsyncClient

Mqtt3AsyncClient.Mqtt3SubscribeAndCallbackBuilder

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<Mqtt3ConnAck>	connect(@Nullable Mqtt3Connect connect) Connects this client with the given Connect message.
@NotNull java.util.concurrent.CompletableFuture<java.lang.Void>	disconnect() Disconnects this client.
@NotNull Mqtt3ClientConfig	getConfig()
@NotNull java.util.concurrent.CompletableFuture<Mqtt3Publish>	publish(@Nullable Mqtt3Publish publish) Publishes the given Publish message.
void	publishes(@Nullable MqttGlobalPublishFilter filter, @Nullable java.util.function.Consumer<Mqtt3Publish> callback) Globally consumes all incoming Publish messages matching the given filter.
void	publishes(@Nullable MqttGlobalPublishFilter filter, @Nullable java.util.function.Consumer<Mqtt3Publish> callback, @Nullable java.util.concurrent.Executor executor) Globally consumes all incoming Publish messages matching the given filter.
@NotNull java.util.concurrent.CompletableFuture<Mqtt3SubAck>	subscribe(@Nullable Mqtt3Subscribe subscribe) Subscribes this client with the given Subscribe message.
@NotNull java.util.concurrent.CompletableFuture<Mqtt3SubAck>	subscribe(@Nullable Mqtt3Subscribe subscribe, @Nullable java.util.function.Consumer<Mqtt3Publish> 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<Mqtt3SubAck>	subscribe(@Nullable Mqtt3Subscribe subscribe, @Nullable java.util.function.Consumer<Mqtt3Publish> 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 Mqtt3BlockingClient	toBlocking() Turns the API of this client into a blocking API.
@NotNull Mqtt3RxClient	toRx() Turns the API of this client into a reactive API.
@NotNull java.util.concurrent.CompletableFuture<java.lang.Void>	unsubscribe(@Nullable Mqtt3Unsubscribe 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.mqtt3.Mqtt3AsyncClient

connect, connectWith, publishWith, subscribeWith, toAsync, unsubscribeWith

Methods inherited from interface com.hivemq.client.mqtt.mqtt3.Mqtt3Client

builder

Method Detail

connect

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt3ConnAck> connect(@Nullable
                                                                                      @Nullable Mqtt3Connect connect)

Description copied from interface: Mqtt3AsyncClient

Connects this client with the given Connect message.

Specified by:

connect in interface Mqtt3AsyncClient

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 Mqtt3ConnAckException 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<Mqtt3SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt3Subscribe subscribe)

Description copied from interface: Mqtt3AsyncClient

Subscribes this client with the given Subscribe message.

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

Specified by:

subscribe in interface Mqtt3AsyncClient

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 Mqtt3SubAckException 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<Mqtt3SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt3Subscribe subscribe,
                                                                                       @Nullable
                                                                                       @Nullable java.util.function.Consumer<Mqtt3Publish> callback)

Description copied from interface: Mqtt3AsyncClient

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 Mqtt3AsyncClient

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 Mqtt3AsyncClient.subscribe(Mqtt3Subscribe).

See Also:

Mqtt3AsyncClient.subscribe(Mqtt3Subscribe, Consumer, Executor)

subscribe

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Mqtt3SubAck> subscribe(@Nullable
                                                                                       @Nullable Mqtt3Subscribe subscribe,
                                                                                       @Nullable
                                                                                       @Nullable java.util.function.Consumer<Mqtt3Publish> callback,
                                                                                       @Nullable
                                                                                       @Nullable java.util.concurrent.Executor executor)

Description copied from interface: Mqtt3AsyncClient

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 Mqtt3AsyncClient

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 Mqtt3AsyncClient.subscribe(Mqtt3Subscribe).

See Also:

Mqtt3AsyncClient.subscribe(Mqtt3Subscribe, Consumer)

publishes

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

Description copied from interface: Mqtt3AsyncClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt3AsyncClient

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:

Mqtt3AsyncClient.publishes(MqttGlobalPublishFilter, Consumer, Executor)

publishes

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

Description copied from interface: Mqtt3AsyncClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt3AsyncClient

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:

Mqtt3AsyncClient.publishes(MqttGlobalPublishFilter, Consumer)

unsubscribe

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribe(@Nullable
                                                                                            @Nullable Mqtt3Unsubscribe unsubscribe)

Description copied from interface: Mqtt3AsyncClient

Unsubscribes this client with the given Unsubscribe message.

Specified by:

unsubscribe in interface Mqtt3AsyncClient

Parameters:

unsubscribe - the Unsubscribe message sent to the broker.

Returns:

a CompletableFuture which

• completes normally when the corresponding UnsubAck message was received or
• completes exceptionally 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<Mqtt3Publish> publish(@Nullable
                                                                                      @Nullable Mqtt3Publish publish)

Description copied from interface: Mqtt3AsyncClient

Publishes the given Publish message.

Specified by:

publish in interface Mqtt3AsyncClient

Parameters:

publish - the Publish message sent to the broker.

Returns:

a CompletableFuture which

• completes normally with the same Publish message (for context) if the Publish message was successfully published or
• completes exceptionally if an error occurred before the Publish message was sent or before an acknowledgement message was received.

disconnect

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

Description copied from interface: Mqtt3AsyncClient

Disconnects this client.

Specified by:

disconnect in interface Mqtt3AsyncClient

Returns:

the CompletableFuture which

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

getConfig

@NotNull
public @NotNull Mqtt3ClientConfig getConfig()

Specified by:

getConfig in interface Mqtt3Client

Specified by:

getConfig in interface MqttClient

Returns:

the configuration of this client.

toRx

@NotNull
public @NotNull Mqtt3RxClient toRx()

Description copied from interface: Mqtt3Client

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 Mqtt3Client

Returns:

a reactive API for this client.

toBlocking

@NotNull
public @NotNull Mqtt3BlockingClient toBlocking()

Description copied from interface: Mqtt3Client

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 Mqtt3Client

Returns:

a blocking API for this client.