Package com.hivemq.client.mqtt.mqtt3.message.subscribe

Interface Mqtt3Subscription

@DoNotImplement
public interface Mqtt3Subscription

Subscription in an MQTT 3 Subscribe message.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull MqttQos	DEFAULT_QOS	Default QoS level of a Subscription.

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt3SubscriptionBuilder	builder()	Creates a builder for a Subscription.
@NotNull Mqtt3SubscriptionBuilder	extend()	Creates a builder for extending this Subscription.
@NotNull MqttQos	getQos()
@NotNull MqttTopicFilter	getTopicFilter()

Field Details

DEFAULT_QOS

@NotNull
static final @NotNull MqttQos DEFAULT_QOS

Default QoS level of a Subscription. It is chosen as MqttQos.EXACTLY_ONCE as this leeds to subscribed Publish messages being delivered with its initial QoS level.

Method Details

builder

@NotNull
static @NotNull Mqtt3SubscriptionBuilder builder()

Creates a builder for a Subscription.

Returns:

the created builder.

getTopicFilter

@NotNull
@NotNull MqttTopicFilter getTopicFilter()

Returns:

the Topic Filter of this Subscription.

getQos

@NotNull
@NotNull MqttQos getQos()

Returns:

the QoS of this Subscription.

extend

@NotNull
@NotNull Mqtt3SubscriptionBuilder extend()

Creates a builder for extending this Subscription.

Returns:

the created builder.

Since:

1.1