B
- the type of the builder.@DoNotImplement public interface Mqtt3ConnectBuilderBase<B extends Mqtt3ConnectBuilderBase<B>>
Mqtt3Connect
.Modifier and Type | Method and 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 . |
Mqtt3ConnectRestrictionsBuilder.Nested<? extends B> |
restrictions()
Fluent counterpart of
restrictions(Mqtt3ConnectRestrictions) . |
B |
restrictions(@NotNull Mqtt3ConnectRestrictions restrictions)
Sets the
restrictions from the client. |
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 . |
Mqtt3WillPublishBuilder.Nested<? extends B> |
willPublish()
Fluent counterpart of
willPublish(Mqtt3Publish) . |
B |
willPublish(@Nullable Mqtt3Publish willPublish)
Sets the optional
Will Publish . |
@CheckReturnValue @NotNull B keepAlive(int keepAlive)
keep alive
in seconds.
The value must be in the range of an unsigned short: [0, 65_535].
keepAlive
- the keep alive in seconds.@CheckReturnValue @NotNull B noKeepAlive()
keep alive
by setting it to Mqtt3Connect.NO_KEEP_ALIVE
.@CheckReturnValue @NotNull B cleanSession(boolean cleanSession)
clean session
.cleanSession
- whether the client connects with a clean session.@CheckReturnValue @NotNull B restrictions(@NotNull @NotNull Mqtt3ConnectRestrictions restrictions)
restrictions
from the client.restrictions
- the restrictions from the client.@CheckReturnValue Mqtt3ConnectRestrictionsBuilder.Nested<? extends B> restrictions()
restrictions(Mqtt3ConnectRestrictions)
.
Calling Mqtt3ConnectRestrictionsBuilder.Nested.applyRestrictions()
on the returned builder has the effect
of extending
the current restrictions.
restrictions(Mqtt3ConnectRestrictions)
@CheckReturnValue @NotNull B simpleAuth(@Nullable @Nullable Mqtt3SimpleAuth simpleAuth)
simple authentication and/or authorization related data
.simpleAuth
- the simple auth related data or null
to remove any previously set simple auth
related data.@CheckReturnValue Mqtt3SimpleAuthBuilder.Nested<? extends B> simpleAuth()
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()
.
simpleAuth(Mqtt3SimpleAuth)
@CheckReturnValue @NotNull B willPublish(@Nullable @Nullable Mqtt3Publish willPublish)
Will Publish
.willPublish
- the Will Publish or null
to remove any previously set Will Publish.@CheckReturnValue Mqtt3WillPublishBuilder.Nested<? extends B> willPublish()
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()
.
willPublish(Mqtt3Publish)