Package com.hivemq.client.mqtt.mqtt3.message.connect

Interface Mqtt3ConnectBuilderBase<B extends Mqtt3ConnectBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt3ConnectBuilder, Mqtt3ConnectBuilder.Nested<P>, Mqtt3ConnectBuilder.Send<P>

@DoNotImplement
public interface Mqtt3ConnectBuilderBase<B extends Mqtt3ConnectBuilderBase<B>>

Builder base for a Mqtt3Connect.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
B	cleanSession(boolean cleanSession)	Sets whether the client connects with a clean session.
B	keepAlive(int keepAlive)	Sets the keep alive in seconds.
B	noKeepAlive()	Disables the keep alive by setting it to Mqtt3Connect.NO_KEEP_ALIVE.
@NotNull Mqtt3ConnectRestrictionsBuilder.Nested<? extends B>	restrictions()	Fluent counterpart of restrictions(Mqtt3ConnectRestrictions).
B	restrictions(@NotNull Mqtt3ConnectRestrictions restrictions)	Sets the restrictions from the client.
@NotNull Mqtt3SimpleAuthBuilder.Nested<? extends B>	simpleAuth()	Fluent counterpart of simpleAuth(Mqtt3SimpleAuth).
B	simpleAuth(@Nullable Mqtt3SimpleAuth simpleAuth)	Sets the optional simple authentication and/or authorization related data.
@NotNull Mqtt3WillPublishBuilder.Nested<? extends B>	willPublish()	Fluent counterpart of willPublish(Mqtt3Publish).
B	willPublish(@Nullable Mqtt3Publish willPublish)	Sets the optional Will Publish.

Method Details

keepAlive

@CheckReturnValue
@NotNull
B keepAlive(int keepAlive)

Sets the keep alive in seconds.

The value must be in the range of an unsigned short: [0, 65_535].

Parameters:

keepAlive - the keep alive in seconds.

Returns:

the builder.

noKeepAlive

@CheckReturnValue
@NotNull
B noKeepAlive()

Disables the keep alive by setting it to Mqtt3Connect.NO_KEEP_ALIVE.

Returns:

the builder.

cleanSession

@CheckReturnValue
@NotNull
B cleanSession(boolean cleanSession)

Sets whether the client connects with a clean session.

Parameters:

cleanSession - whether the client connects with a clean session.

Returns:

the builder.

restrictions

@CheckReturnValue
@NotNull
B restrictions(@NotNull
 @NotNull Mqtt3ConnectRestrictions restrictions)

Sets the restrictions from the client.

Parameters:

restrictions - the restrictions from the client.

Returns:

the builder.

Since:

1.3

restrictions

@CheckReturnValue
@NotNull Mqtt3ConnectRestrictionsBuilder.Nested<? extends B> restrictions()

Fluent counterpart of restrictions(Mqtt3ConnectRestrictions).

Calling Mqtt3ConnectRestrictionsBuilder.Nested.applyRestrictions() on the returned builder has the effect of extending the current restrictions.

Returns:

the fluent builder for the restrictions.

Since:

1.3

See Also:

• restrictions(Mqtt3ConnectRestrictions)

simpleAuth

@CheckReturnValue
@NotNull
B 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.

simpleAuth

@CheckReturnValue
@NotNull Mqtt3SimpleAuthBuilder.Nested<? extends B> 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.

See Also:

• simpleAuth(Mqtt3SimpleAuth)

willPublish

@CheckReturnValue
@NotNull
B 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.

willPublish

@CheckReturnValue
@NotNull Mqtt3WillPublishBuilder.Nested<? extends B> 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.

See Also:

• willPublish(Mqtt3Publish)