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

Interface Mqtt3Subscribe

All Superinterfaces:

Mqtt3Message

@DoNotImplement
public interface Mqtt3Subscribe
extends Mqtt3Message

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

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt3SubscribeBuilder.Start	builder()	Creates a builder for a Subscribe message.
@NotNull Mqtt3SubscribeBuilder.Complete	extend()	Creates a builder for extending this Subscribe message.
@Immutable @NotNull List<@NotNull ? extends Mqtt3Subscription>	getSubscriptions()
default @NotNull Mqtt3MessageType	getType()

Method Details

builder

static @NotNull Mqtt3SubscribeBuilder.Start builder()

Creates a builder for a Subscribe message.

Returns:

the created builder.

getSubscriptions

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

Returns:

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

getType

@NotNull
default @NotNull Mqtt3MessageType getType()

Specified by:

getType in interface Mqtt3Message

Returns:

the type of this MQTT message.

extend

@NotNull Mqtt3SubscribeBuilder.Complete extend()

Creates a builder for extending this Subscribe message.

Returns:

the created builder.