Package com.hivemq.client.mqtt.mqtt5

Interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Enclosing interface:

Mqtt5ClientConnectionConfig

@DoNotImplement
public static interface Mqtt5ClientConnectionConfig.RestrictionsForClient

Restrictions for messages a Mqtt5Client sends.

Method Summary

Modifier and Type	Method	Description
boolean	areSubscriptionIdentifiersAvailable()	Returns whether the server accepts subscription identifiers from the client.
@NotNull MqttQos	getMaximumQos()	Returns the maximum QoS the server accepts from the client.
int	getSendMaximum()	Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.
int	getSendMaximumPacketSize()	Returns the maximum packet size the client sends to the server.
int	getSendTopicAliasMaximum()	Returns the maximum amount of topic aliases the client sends to the server.
boolean	isRetainAvailable()	Returns whether the server accepts retained messages from the client.
boolean	isSharedSubscriptionAvailable()	Returns whether the server accepts shared subscriptions from the client.
boolean	isWildcardSubscriptionAvailable()	Returns whether the server accepts wildcard subscriptions from the client.

Method Details

getSendMaximum

int getSendMaximum()

Returns the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendMaximum() and MqttConnAckRestrictions#getReceiveMaximum().

Returns:

the maximum amount of not acknowledged publishes with QoS 1 or 2 the client sends to the server concurrently.

getSendMaximumPacketSize

int getSendMaximumPacketSize()

Returns the maximum packet size the client sends to the server.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendMaximumPacketSize() and MqttConnAckRestrictions#getMaximumPacketSize().

Returns:

the maximum packet size the client sends to the server.

getSendTopicAliasMaximum

int getSendTopicAliasMaximum()

Returns the maximum amount of topic aliases the client sends to the server.

The value is determined by the minimum of Mqtt5ConnectRestrictions#getSendTopicAliasMaximum() and MqttConnAckRestrictions#getTopicAliasMaximum().

Returns:

the maximum amount of topic aliases the client sends to the server.

getMaximumQos

@NotNull
@NotNull MqttQos getMaximumQos()

Returns the maximum QoS the server accepts from the client.

The value is determined by MqttConnAckRestrictions#getMaximumQos().

Returns:

the maximum QoS the server accepts from the client.

isRetainAvailable

boolean isRetainAvailable()

Returns whether the server accepts retained messages from the client.

The value is determined by MqttConnAckRestrictions#isRetainAvailable().

Returns:

whether the server accepts retained messages from the client.

isWildcardSubscriptionAvailable

boolean isWildcardSubscriptionAvailable()

Returns whether the server accepts wildcard subscriptions from the client.

The value is determined by MqttConnAckRestrictions#isWildcardSubscriptionAvailable().

Returns:

whether the server accepts wildcard subscriptions.

isSharedSubscriptionAvailable

boolean isSharedSubscriptionAvailable()

Returns whether the server accepts shared subscriptions from the client.

The value is determined by MqttConnAckRestrictions#isSharedSubscriptionAvailable().

Returns:

whether the server accepts shared subscriptions from the client.

areSubscriptionIdentifiersAvailable

boolean areSubscriptionIdentifiersAvailable()

Returns whether the server accepts subscription identifiers from the client.

The value is determined by MqttConnAckRestrictions#areSubscriptionIdentifiersAvailable().

Returns:

whether the server accepts subscription identifiers from the client.