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

Interface Mqtt5WillPublish

All Superinterfaces:

Mqtt5Message, Mqtt5Publish

@DoNotImplement
public interface Mqtt5WillPublish
extends Mqtt5Publish

MQTT 5 Will Publish which can be a part of an MQTT 5 Connect message.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_DELAY_INTERVAL	The default delay of Will Publishes.

Fields inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

DEFAULT_QOS

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt5WillPublishBuilder	builder()	Creates a builder for a Will Publish.
@NotNull Mqtt5WillPublishBuilder.Complete	extendAsWill()	Creates a builder for extending this Will Publish.
long	getDelayInterval()

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

acknowledge, asWill, extend, getContentType, getCorrelationData, getMessageExpiryInterval, getPayload, getPayloadAsBytes, getPayloadFormatIndicator, getQos, getResponseTopic, getTopic, getType, getUserProperties, isRetain

Field Details

DEFAULT_DELAY_INTERVAL

static final long DEFAULT_DELAY_INTERVAL

The default delay of Will Publishes.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull Mqtt5WillPublishBuilder builder()

Creates a builder for a Will Publish.

Returns:

the created builder.

getDelayInterval

long getDelayInterval()

Returns:

the delay of this Will Publish. The default is DEFAULT_DELAY_INTERVAL.

extendAsWill

@NotNull Mqtt5WillPublishBuilder.Complete extendAsWill()

Creates a builder for extending this Will Publish.

Returns:

the created builder.