Package com.hivemq.client.mqtt.mqtt3

Interface Mqtt3ClientBuilder

All Superinterfaces:

MqttClientBuilderBase<Mqtt3ClientBuilder>

@DoNotImplement
public interface Mqtt3ClientBuilder
extends MqttClientBuilderBase<Mqtt3ClientBuilder>

Builder for an Mqtt3Client.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt3Client	build()	Builds the Mqtt3Client.
@NotNull Mqtt3AsyncClient	buildAsync()	Builds the Mqtt3AsyncClient.
@NotNull Mqtt3BlockingClient	buildBlocking()	Builds the Mqtt3BlockingClient.
@NotNull Mqtt3RxClient	buildRx()	Builds the Mqtt3RxClient.
@NotNull Mqtt3SimpleAuthBuilder.Nested<? extends Mqtt3ClientBuilder>	simpleAuth()	Fluent counterpart of simpleAuth(Mqtt3SimpleAuth).
@NotNull Mqtt3ClientBuilder	simpleAuth(@Nullable Mqtt3SimpleAuth simpleAuth)	Sets the optional simple authentication and/or authorization related data.
@NotNull Mqtt3WillPublishBuilder.Nested<? extends Mqtt3ClientBuilder>	willPublish()	Fluent counterpart of willPublish(Mqtt3Publish).
@NotNull Mqtt3ClientBuilder	willPublish(@Nullable Mqtt3Publish willPublish)	Sets the optional Will Publish.

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

addConnectedListener, addDisconnectedListener, automaticReconnect, automaticReconnect, automaticReconnectWithDefaultConfig, executorConfig, executorConfig, identifier, identifier, serverAddress, serverHost, serverHost, serverPort, sslConfig, sslConfig, sslWithDefaultConfig, transportConfig, transportConfig, useSsl, useSsl, useSslWithDefaultConfig, useWebSocket, useWebSocket, useWebSocketWithDefaultConfig, webSocketConfig, webSocketConfig, webSocketWithDefaultConfig

Method Details

simpleAuth

@CheckReturnValue
@NotNull
@NotNull Mqtt3ClientBuilder simpleAuth(@Nullable
 @Nullable Mqtt3SimpleAuth simpleAuth)

Sets the optional simple authentication and/or authorization related data.

Parameters:

simpleAuth - the simple auth related data or null to remove any previously set simple auth related data.

Returns:

the builder.

Since:

1.1

simpleAuth

@CheckReturnValue
@NotNull Mqtt3SimpleAuthBuilder.Nested<? extends Mqtt3ClientBuilder> simpleAuth()

Fluent counterpart of simpleAuth(Mqtt3SimpleAuth).

Calling Mqtt3SimpleAuthBuilder.Nested.Complete.applySimpleAuth() on the returned builder has the same effect as calling simpleAuth(Mqtt3SimpleAuth) with the result of Mqtt3SimpleAuthBuilder.Complete.build().

Returns:

the fluent builder for the simple auth related data.

Since:

1.1

See Also:

• simpleAuth(Mqtt3SimpleAuth)

willPublish

@CheckReturnValue
@NotNull
@NotNull Mqtt3ClientBuilder willPublish(@Nullable
 @Nullable Mqtt3Publish willPublish)

Sets the optional Will Publish.

Parameters:

willPublish - the Will Publish or null to remove any previously set Will Publish.

Returns:

the builder.

Since:

1.1

willPublish

@CheckReturnValue
@NotNull Mqtt3WillPublishBuilder.Nested<? extends Mqtt3ClientBuilder> willPublish()

Fluent counterpart of willPublish(Mqtt3Publish).

Calling Mqtt3WillPublishBuilder.Nested.Complete.applyWillPublish() on the returned builder has the same effect as calling willPublish(Mqtt3Publish) with the result of Mqtt3WillPublishBuilder.Complete.build().

Returns:

the fluent builder for the Will Publish.

Since:

1.1

See Also:

• willPublish(Mqtt3Publish)

build

@CheckReturnValue
@NotNull
@NotNull Mqtt3Client build()

Builds the Mqtt3Client.

Returns:

the built Mqtt3Client.

buildRx

@CheckReturnValue
@NotNull
@NotNull Mqtt3RxClient buildRx()

Builds the Mqtt3RxClient.

Returns:

the built Mqtt3RxClient.

buildAsync

@CheckReturnValue
@NotNull
@NotNull Mqtt3AsyncClient buildAsync()

Builds the Mqtt3AsyncClient.

Returns:

the built Mqtt3AsyncClient.

buildBlocking

@CheckReturnValue
@NotNull
@NotNull Mqtt3BlockingClient buildBlocking()

Builds the Mqtt3BlockingClient.

Returns:

the built Mqtt3BlockingClient.