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

Interface Mqtt5Subscription

@DoNotImplement
public interface Mqtt5Subscription

Subscription in an MQTT 5 Subscribe message.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_NO_LOCAL	The default for whether the client must not receive messages published by itself.
static final @NotNull MqttQos	DEFAULT_QOS	Default QoS level of a Subscription.
static final boolean	DEFAULT_RETAIN_AS_PUBLISHED	The default for whether the retain flag for incoming Publish messages must be set to its original value.
static final @NotNull Mqtt5RetainHandling	DEFAULT_RETAIN_HANDLING	The default handling of retained message.

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt5SubscriptionBuilder	builder()	Creates a builder for a Subscription.
@NotNull Mqtt5SubscriptionBuilder	extend()	Creates a builder for extending this Subscription.
@NotNull MqttQos	getQos()
@NotNull Mqtt5RetainHandling	getRetainHandling()
@NotNull MqttTopicFilter	getTopicFilter()
boolean	isNoLocal()
boolean	isRetainAsPublished()

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.

DEFAULT_NO_LOCAL

static final boolean DEFAULT_NO_LOCAL

The default for whether the client must not receive messages published by itself.

See Also:

• Constant Field Values

DEFAULT_RETAIN_HANDLING

@NotNull
static final @NotNull Mqtt5RetainHandling DEFAULT_RETAIN_HANDLING

The default handling of retained message.

DEFAULT_RETAIN_AS_PUBLISHED

static final boolean DEFAULT_RETAIN_AS_PUBLISHED

The default for whether the retain flag for incoming Publish messages must be set to its original value.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull Mqtt5SubscriptionBuilder 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.

isNoLocal

boolean isNoLocal()

Returns:

whether the client must not receive messages published by itself. The default is DEFAULT_NO_LOCAL.

getRetainHandling

@NotNull
@NotNull Mqtt5RetainHandling getRetainHandling()

Returns:

the handling of retained message for this Subscription. The default is DEFAULT_RETAIN_HANDLING.

isRetainAsPublished

boolean isRetainAsPublished()

Returns:

whether the retain flag for incoming Publish messages must be set to its original value.

extend

@NotNull
@NotNull Mqtt5SubscriptionBuilder extend()

Creates a builder for extending this Subscription.

Returns:

the created builder.

Since:

1.1