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

Interface Mqtt5ConnAckRestrictions

@DoNotImplement public interface Mqtt5ConnAckRestrictions
Restrictions for the client set by the server in an MQTT 5 ConnAck message.

These restrictions are used in conjunction with the Mqtt5ConnectRestrictions to form the Mqtt5ClientConnectionConfig.RestrictionsForClient.

Since:
1.0

  • Field Details

    • DEFAULT_RECEIVE_MAXIMUM

      static final int DEFAULT_RECEIVE_MAXIMUM
      The default maximum amount of not acknowledged publishes with QoS 1 or 2 the server accepts concurrently.
      See Also:

    • DEFAULT_MAXIMUM_PACKET_SIZE_NO_LIMIT

      static final int DEFAULT_MAXIMUM_PACKET_SIZE_NO_LIMIT
      The default maximum packet size the server accepts from the client which indicates that the packet size is not limited beyond the restrictions of the encoding.
      See Also:

    • DEFAULT_TOPIC_ALIAS_MAXIMUM

      static final int DEFAULT_TOPIC_ALIAS_MAXIMUM
      The default maximum amount of topic aliases the server accepts from the client.
      See Also:

    • DEFAULT_MAXIMUM_QOS

      @NotNull static final @NotNull MqttQos DEFAULT_MAXIMUM_QOS
      The default maximum QoS the server accepts from the client.

    • DEFAULT_RETAIN_AVAILABLE

      static final boolean DEFAULT_RETAIN_AVAILABLE
      The default for whether the server accepts retained messages.
      See Also:

    • DEFAULT_WILDCARD_SUBSCRIPTION_AVAILABLE

      static final boolean DEFAULT_WILDCARD_SUBSCRIPTION_AVAILABLE
      The default for whether the server accepts wildcard subscriptions.
      See Also:

    • DEFAULT_SHARED_SUBSCRIPTION_AVAILABLE

      static final boolean DEFAULT_SHARED_SUBSCRIPTION_AVAILABLE
      The default for whether the server accepts shared subscriptions.
      See Also:

    • DEFAULT_SUBSCRIPTION_IDENTIFIERS_AVAILABLE

      static final boolean DEFAULT_SUBSCRIPTION_IDENTIFIERS_AVAILABLE
      The default for whether the server accepts subscription identifiers.
      See Also:

  • Method Details

    • getReceiveMaximum

      int getReceiveMaximum()
      Returns:
      the maximum amount of not acknowledged publishes with QoS 1 or 2 the server accepts concurrently. The default is DEFAULT_RECEIVE_MAXIMUM.

    • getMaximumPacketSize

      int getMaximumPacketSize()
      Returns:
      the maximum packet size the server accepts from the client. The default is DEFAULT_MAXIMUM_PACKET_SIZE_NO_LIMIT.

    • getTopicAliasMaximum

      int getTopicAliasMaximum()
      Returns:
      the maximum amount of topic aliases the server accepts from the client. The default is DEFAULT_TOPIC_ALIAS_MAXIMUM.

    • getMaximumQos

      @NotNull @NotNull MqttQos getMaximumQos()
      Returns:
      the maximum QoS the server accepts from the client. The default is DEFAULT_MAXIMUM_QOS.

    • isRetainAvailable

      boolean isRetainAvailable()
      Returns:
      whether the server accepts retained messages. The default is DEFAULT_RETAIN_AVAILABLE.

    • isWildcardSubscriptionAvailable

      boolean isWildcardSubscriptionAvailable()
      Returns:
      whether the server accepts wildcard subscriptions. The default is DEFAULT_WILDCARD_SUBSCRIPTION_AVAILABLE.

    • isSharedSubscriptionAvailable

      boolean isSharedSubscriptionAvailable()
      Returns:
      whether the server accepts shared subscriptions. The default is DEFAULT_SHARED_SUBSCRIPTION_AVAILABLE.

    • areSubscriptionIdentifiersAvailable

      boolean areSubscriptionIdentifiersAvailable()
      Returns:
      whether the server accepts subscription identifiers. The default is DEFAULT_SUBSCRIPTION_IDENTIFIERS_AVAILABLE.