com.hivemq.client.mqtt.mqtt5.message.connect

Interface Mqtt5ConnectRestrictionsBuilderBase<B extends Mqtt5ConnectRestrictionsBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt5ConnectRestrictionsBuilder, Mqtt5ConnectRestrictionsBuilder.Nested<P>

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

Builder base for Mqtt5ConnectRestrictions.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
B	maximumPacketSize(int maximumPacketSize) Sets the maximum packet size.
B	receiveMaximum(int receiveMaximum) Sets the receive maximum.
B	requestProblemInformation(boolean requestProblemInformation) Sets whether problem information is requested.
B	requestResponseInformation(boolean requestResponseInformation) Sets whether response information is requested.
B	sendMaximum(int receiveMaximum) Sets the send maximum.
B	sendMaximumPacketSize(int maximumPacketSize) Sets the maximum packet size for sending.
B	sendTopicAliasMaximum(int topicAliasMaximum) Sets the topic alias maximum for sending.
B	topicAliasMaximum(int topicAliasMaximum) Sets the topic alias maximum.

Method Detail

receiveMaximum

@CheckReturnValue
 @NotNull
B receiveMaximum(int receiveMaximum)

Sets the receive maximum.

The value must not be zero and must be in the range of an unsigned short: [1, 65_535].

Parameters:

receiveMaximum - the receive maximum.

Returns:

the builder.

sendMaximum

@CheckReturnValue
 @NotNull
B sendMaximum(int receiveMaximum)

Sets the send maximum.

The value must not be zero and must be in the range of an unsigned short: [1, 65_535].

WARNING: Do not confuse this with receiveMaximum(int).

Parameters:

receiveMaximum - the send maximum.

Returns:

the builder.

maximumPacketSize

@CheckReturnValue
 @NotNull
B maximumPacketSize(int maximumPacketSize)

Sets the maximum packet size.

The value must not be zero and in the range: [1, 268_435_460].

Parameters:

maximumPacketSize - the maximum packet size.

Returns:

the builder.

sendMaximumPacketSize

@CheckReturnValue
 @NotNull
B sendMaximumPacketSize(int maximumPacketSize)

Sets the maximum packet size for sending.

The value must not be zero and in the range: [1, 268_435_460].

WARNING: Do not confuse this with maximumPacketSize(int).

Parameters:

maximumPacketSize - the maximum packet size for sending.

Returns:

the builder.

topicAliasMaximum

@CheckReturnValue
 @NotNull
B topicAliasMaximum(int topicAliasMaximum)

Sets the topic alias maximum.

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

Parameters:

topicAliasMaximum - the topic alias maximum.

Returns:

the builder.

sendTopicAliasMaximum

@CheckReturnValue
 @NotNull
B sendTopicAliasMaximum(int topicAliasMaximum)

Sets the topic alias maximum for sending.

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

WARNING: Do not confuse this with topicAliasMaximum(int).

Parameters:

topicAliasMaximum - the topic alias maximum for sending.

Returns:

the builder.

requestProblemInformation

@CheckReturnValue
 @NotNull
B requestProblemInformation(boolean requestProblemInformation)

Sets whether problem information is requested.

Parameters:

requestProblemInformation - whether problem information is requested.

Returns:

the builder.

requestResponseInformation

@CheckReturnValue
 @NotNull
B requestResponseInformation(boolean requestResponseInformation)

Sets whether response information is requested.

Parameters:

requestResponseInformation - whether response information is requested.

Returns:

the builder.