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

Interface Mqtt5Subscribe

All Superinterfaces:

Mqtt5Message

@DoNotImplement
public interface Mqtt5Subscribe
extends Mqtt5Message

MQTT 5 Subscribe message. This message is translated from and to an MQTT 5 SUBSCRIBE packet.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt5SubscribeBuilder.Start	builder()	Creates a builder for a Subscribe message.
@NotNull Mqtt5SubscribeBuilder.Complete	extend()	Creates a builder for extending this Subscribe message.
@Immutable @NotNull List<@NotNull ? extends Mqtt5Subscription>	getSubscriptions()
default @NotNull Mqtt5MessageType	getType()
@NotNull Mqtt5UserProperties	getUserProperties()

Method Details

builder

static @NotNull Mqtt5SubscribeBuilder.Start builder()

Creates a builder for a Subscribe message.

Returns:

the created builder.

getSubscriptions

@NotNull
@Immutable @NotNull List<@NotNull ? extends Mqtt5Subscription> getSubscriptions()

Returns:

the Subscriptions of this Subscribe message. The list contains at least one Subscription.

getUserProperties

@NotNull
@NotNull Mqtt5UserProperties getUserProperties()

Returns:

the optional user properties of this Subscribe message.

getType

@NotNull
default @NotNull Mqtt5MessageType getType()

Specified by:

getType in interface Mqtt5Message

Returns:

the type of this MQTT message.

extend

@NotNull Mqtt5SubscribeBuilder.Complete extend()

Creates a builder for extending this Subscribe message.

Returns:

the created builder.