com.hivemq.client.mqtt.mqtt5.message.disconnect

Interface Mqtt5DisconnectBuilderBase<B extends Mqtt5DisconnectBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt5DisconnectBuilder, Mqtt5DisconnectBuilder.Nested<P>, Mqtt5DisconnectBuilder.Send<P>, Mqtt5DisconnectBuilder.SendVoid

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

Builder base for a Mqtt5Disconnect.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
B	noSessionExpiry() Disables the session expiry by setting it to Mqtt5Connect.NO_SESSION_EXPIRY.
B	reasonCode(@NotNull Mqtt5DisconnectReasonCode reasonCode) Sets the Reason Code.
B	reasonString(@Nullable MqttUtf8String reasonString) Sets the optional Reason String.
B	reasonString(@Nullable String reasonString) Sets the optional Reason String.
B	serverReference(@Nullable MqttUtf8String serverReference) Sets the optional server reference.
B	serverReference(@Nullable String serverReference) Sets the optional server reference.
B	sessionExpiryInterval(long sessionExpiryInterval) Sets the session expiry interval in seconds.
Mqtt5UserPropertiesBuilder.Nested<? extends B>	userProperties() Fluent counterpart of userProperties(Mqtt5UserProperties).
B	userProperties(@NotNull Mqtt5UserProperties userProperties) Sets the User Properties.

Method Detail

reasonCode

@CheckReturnValue
 @NotNull
B reasonCode(@NotNull
                                         @NotNull Mqtt5DisconnectReasonCode reasonCode)

Sets the Reason Code.

Parameters:

reasonCode - the Reason Code.

Returns:

the builder.

sessionExpiryInterval

@CheckReturnValue
 @NotNull
B sessionExpiryInterval(long sessionExpiryInterval)

Sets the session expiry interval in seconds.

The value must be in the range of an unsigned int: [0, 4_294_967_295].

Parameters:

sessionExpiryInterval - the session expiry interval in seconds.

Returns:

the builder.

noSessionExpiry

@CheckReturnValue
 @NotNull
B noSessionExpiry()

Disables the session expiry by setting it to Mqtt5Connect.NO_SESSION_EXPIRY.

Returns:

the builder.

serverReference

@CheckReturnValue
 @NotNull
B serverReference(@Nullable
                                              @Nullable String serverReference)

Sets the optional server reference.

Parameters:

serverReference - the server reference.

Returns:

the builder.

serverReference

@CheckReturnValue
 @NotNull
B serverReference(@Nullable
                                              @Nullable MqttUtf8String serverReference)

Sets the optional server reference.

Parameters:

serverReference - the server reference.

Returns:

the builder.

reasonString

@CheckReturnValue
 @NotNull
B reasonString(@Nullable
                                           @Nullable String reasonString)

Sets the optional Reason String.

Parameters:

reasonString - the Reason String.

Returns:

the builder.

reasonString

@CheckReturnValue
 @NotNull
B reasonString(@Nullable
                                           @Nullable MqttUtf8String reasonString)

Sets the optional Reason String.

Parameters:

reasonString - the Reason String.

Returns:

the builder.

userProperties

@CheckReturnValue
 @NotNull
B userProperties(@NotNull
                                             @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
Mqtt5UserPropertiesBuilder.Nested<? extends B> userProperties()

Fluent counterpart of userProperties(Mqtt5UserProperties).

Calling Mqtt5UserPropertiesBuilder.Nested#applyUserProperties() on the returned builder has the effect of extending the current User Properties.

Returns:

the fluent builder for the User Properties.

See Also:

userProperties(Mqtt5UserProperties)