Package com.hivemq.client.mqtt.mqtt3.lifecycle

Interface Mqtt3ClientReconnector

All Superinterfaces:

MqttClientReconnector

@DoNotImplement
public interface Mqtt3ClientReconnector
extends MqttClientReconnector

A MqttClientReconnector with methods specific to an Mqtt3Client.

Since:

1.1

Field Summary

Fields inherited from interface com.hivemq.client.mqtt.lifecycle.MqttClientReconnector

DEFAULT_DELAY_MS, DEFAULT_RECONNECT, DEFAULT_REPUBLISH_IF_SESSION_EXPIRED, DEFAULT_RESUBSCRIBE_IF_SESSION_EXPIRED, DEFAULT_RESUBSCRIBE_IF_SESSION_PRESENT

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt3ClientReconnector	connect(@NotNull Mqtt3Connect connect)	Sets a different Connect message the client will try to reconnect with.
@NotNull Mqtt3ConnectBuilder.Nested<? extends Mqtt3ClientReconnector>	connectWith()	Fluent counterpart of connect(Mqtt3Connect).
@NotNull Mqtt3ClientReconnector	delay(long delay, @NotNull TimeUnit timeUnit)	Sets a delay the client will wait for before trying to reconnect.
@NotNull Mqtt3Connect	getConnect()	Returns the currently set Connect message the client will try to reconnect with.
@NotNull Mqtt3ClientReconnector	reconnect(boolean reconnect)	Instructs the client to reconnect or not.
<T> @NotNull Mqtt3ClientReconnector	reconnectWhen(@NotNull CompletableFuture<T> future, @Nullable BiConsumer<? super T,? super Throwable> callback)	Instructs the client to reconnect after a future completes.
@NotNull Mqtt3ClientReconnector	republishIfSessionExpired(boolean republish)	Instructs the client to queue pending Publish messages and automatically publish them even if the session expired before reconnected successfully.
@NotNull Mqtt3ClientReconnector	resubscribeIfSessionExpired(boolean resubscribe)	Instructs the client to automatically restore its subscriptions when the session expired before it reconnected successfully.
@NotNull Mqtt3ClientReconnector	resubscribeIfSessionPresent(boolean resubscribeIfSessionPresent)	Instructs the client to automatically restore its subscriptions when reconnected successfully and the session is still present.
@NotNull MqttClientTransportConfigBuilder.Nested<? extends Mqtt3ClientReconnector>	transportConfig()	Fluent counterpart of MqttClientReconnector.transportConfig(MqttClientTransportConfig).
@NotNull Mqtt3ClientReconnector	transportConfig(@NotNull MqttClientTransportConfig transportConfig)	Sets a different transport configuration the client will try to reconnect with.

Methods inherited from interface com.hivemq.client.mqtt.lifecycle.MqttClientReconnector

getAttempts, getDelay, getTransportConfig, isReconnect, isRepublishIfSessionExpired, isResubscribeIfSessionExpired, isResubscribeIfSessionPresent

Method Details

reconnect

@NotNull
@NotNull Mqtt3ClientReconnector reconnect(boolean reconnect)

Description copied from interface: MqttClientReconnector

Instructs the client to reconnect or not.

Specified by:

reconnect in interface MqttClientReconnector

Parameters:

reconnect - whether to reconnect.

Returns:

this reconnector.

reconnectWhen

@NotNull
<T> @NotNull Mqtt3ClientReconnector reconnectWhen(@NotNull
 @NotNull CompletableFuture<T> future,
 @Nullable
 @Nullable BiConsumer<? super T,? super Throwable> callback)

Description copied from interface: MqttClientReconnector

Instructs the client to reconnect after a future completes.

If additionally a delay is supplied, the client will reconnect after both are complete.

This method must only be called in MqttClientDisconnectedListener.onDisconnected(MqttClientDisconnectedContext) and not in the supplied callback.

Specified by:

reconnectWhen in interface MqttClientReconnector

Type Parameters:

T - the result type of the future.

Parameters:

future - the client will reconnect only after the future completes.

callback - the callback that will be called after the future completes and before the client will reconnect. It can be used to set new connect properties (e.g. credentials).

Returns:

this reconnector.

resubscribeIfSessionPresent

@NotNull
@NotNull Mqtt3ClientReconnector resubscribeIfSessionPresent(boolean resubscribeIfSessionPresent)

Description copied from interface: MqttClientReconnector

Instructs the client to automatically restore its subscriptions when reconnected successfully and the session is still present.

When the client reconnected successfully and its session is still present, the server still knows its subscriptions, so resubscribing is optional.

This setting only has effect if the client will reconnect (at least one of the methods MqttClientReconnector.reconnect(boolean) or MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer) is called).

This method must only be called in MqttClientDisconnectedListener.onDisconnected(MqttClientDisconnectedContext) and not in the callback supplied to MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer).

Specified by:

resubscribeIfSessionPresent in interface MqttClientReconnector

Parameters:

resubscribeIfSessionPresent - whether to resubscribe if the session is present when the client reconnected successfully.

Returns:

this reconnector.

resubscribeIfSessionExpired

@NotNull
@NotNull Mqtt3ClientReconnector resubscribeIfSessionExpired(boolean resubscribe)

Description copied from interface: MqttClientReconnector

Instructs the client to automatically restore its subscriptions when the session expired before it reconnected successfully.

When the client reconnected successfully and its session is still present, the server still knows its subscriptions and they do not need to be restored.

This setting only has effect if the client will reconnect (at least one of the methods MqttClientReconnector.reconnect(boolean) or MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer) is called).

This method must only be called in MqttClientDisconnectedListener.onDisconnected(MqttClientDisconnectedContext) and not in the callback supplied to MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer).

Specified by:

resubscribeIfSessionExpired in interface MqttClientReconnector

Parameters:

resubscribe - whether to resubscribe when the session expired before the client reconnected successfully.

Returns:

this reconnector.

republishIfSessionExpired

@NotNull
@NotNull Mqtt3ClientReconnector republishIfSessionExpired(boolean republish)

Description copied from interface: MqttClientReconnector

Instructs the client to queue pending Publish messages and automatically publish them even if the session expired before reconnected successfully.

When the client reconnected successfully and its session is still present, the client will always queue pending Publish messages and automatically publish them to ensure the QoS guarantees.

This setting only has effect if the client will reconnect (at least one of the methods MqttClientReconnector.reconnect(boolean) or MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer) is called).

This method must only be called in MqttClientDisconnectedListener.onDisconnected(MqttClientDisconnectedContext) and not in the callback supplied to MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer).

Specified by:

republishIfSessionExpired in interface MqttClientReconnector

Parameters:

republish - whether to republish when the session expired before the client reconnected successfully.

Returns:

this reconnector.

delay

@NotNull
@NotNull Mqtt3ClientReconnector delay(long delay,
 @NotNull
 @NotNull TimeUnit timeUnit)

Description copied from interface: MqttClientReconnector

Sets a delay the client will wait for before trying to reconnect.

This setting only has effect if the client will reconnect (at least one of the methods MqttClientReconnector.reconnect(boolean) or MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer) is called).

If additionally a future is supplied, the client will reconnect after both are complete.

This method must only be called in MqttClientDisconnectedListener.onDisconnected(MqttClientDisconnectedContext) and not in the callback supplied to MqttClientReconnector.reconnectWhen(CompletableFuture, BiConsumer).

Specified by:

delay in interface MqttClientReconnector

Parameters:

delay - delay which the client will wait before trying to reconnect.

timeUnit - the time unit of the delay.

Returns:

this reconnector.

transportConfig

@NotNull
@NotNull Mqtt3ClientReconnector transportConfig(@NotNull
 @NotNull MqttClientTransportConfig transportConfig)

Description copied from interface: MqttClientReconnector

Sets a different transport configuration the client will try to reconnect with.

Specified by:

transportConfig in interface MqttClientReconnector

Parameters:

transportConfig - the transport configuration the client will try to reconnect with.

Returns:

this reconnector.

transportConfig

@CheckReturnValue
@NotNull MqttClientTransportConfigBuilder.Nested<? extends Mqtt3ClientReconnector> transportConfig()

Description copied from interface: MqttClientReconnector

Fluent counterpart of MqttClientReconnector.transportConfig(MqttClientTransportConfig).

Calling MqttClientTransportConfigBuilder.Nested.applyTransportConfig() on the returned builder has the effect of extending the current transport configuration.

Specified by:

transportConfig in interface MqttClientReconnector

Returns:

the fluent builder for the transport configuration.

See Also:

• MqttClientReconnector.transportConfig(MqttClientTransportConfig)

connect

@NotNull
@NotNull Mqtt3ClientReconnector connect(@NotNull
 @NotNull Mqtt3Connect connect)

Sets a different Connect message the client will try to reconnect with.

Parameters:

connect - the Connect message.

Returns:

this reconnector.

connectWith

@CheckReturnValue
@NotNull Mqtt3ConnectBuilder.Nested<? extends Mqtt3ClientReconnector> connectWith()

Fluent counterpart of connect(Mqtt3Connect).

Calling Mqtt3ConnectBuilder.Nested.applyConnect() on the returned builder has the same effect as calling connect(Mqtt3Connect) with the result of Mqtt3ConnectBuilder.build().

Returns:

the fluent builder for the Connect message.

See Also:

• connect(Mqtt3Connect)

getConnect

@NotNull
@NotNull Mqtt3Connect getConnect()

Returns the currently set Connect message the client will try to reconnect with.

If the connect(Mqtt3Connect) method has not been called before (including previous MqttClientDisconnectedListeners) it will be the Connect message that is reconstructed from the Mqtt3ClientConnectionConfig or the Connect message of the previous connect try if it has not been successfully connected.

Returns:

the Connect message.