Package software.amazon.awssdk.crt.mqtt5.packets

Class SubscribePacket

java.lang.Object

software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket

public class SubscribePacket
extends Object

Data model of an MQTT5 SUBSCRIBE packet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubscribePacket.RetainHandlingType	Configures how retained messages should be handled when subscribing with a subscription that matches topics with associated retained messages.
static final class	SubscribePacket.SubscribePacketBuilder	A class to that allows for the creation of a SubscribePacket.
static final class	SubscribePacket.Subscription	Configures a single subscription within a Subscribe operation See MQTT5 Subscription Options

Method Summary

Modifier and Type	Method	Description
Long	getSubscriptionIdentifier()	Returns the positive long to associate with all subscriptions in this request.
List<SubscribePacket.Subscription>	getSubscriptions()	Returns the list of subscriptions that the client wishes to listen to See MQTT5 Subscribe Payload
List<UserProperty>	getUserProperties()	Returns the list of MQTT5 user properties included with the packet.
static SubscribePacket	of(String topicFilter, QOS qos)	Creates a SubscribePacket containing only a single subscription topic and qos: topicFilter, QoS.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static SubscribePacket of(String topicFilter,
 QOS qos)

Creates a SubscribePacket containing only a single subscription topic and qos: topicFilter, QoS.

Internally this is just syntactic sugar around SubscribePacketBuilder(String, QOS) followed by SubscribePacket.SubscribePacketBuilder.build().

Parameters:

topicFilter - The topic filter to subscribe to.

qos - The maximum QoS on which the subscriber will accept publish messages.

Returns:

an immutable SubscribePacket ready for use

Throws:

NullPointerException - if topicFilter or qos is null

getSubscriptions

public List<SubscribePacket.Subscription> getSubscriptions()

Returns the list of subscriptions that the client wishes to listen to See MQTT5 Subscribe Payload

Returns:

List of subscriptions that the client wishes to listen to

getSubscriptionIdentifier

public Long getSubscriptionIdentifier()

Returns the positive long to associate with all subscriptions in this request. Publish packets that match a subscription in this request should include this identifier in the resulting message. See MQTT5 Subscription Identifier

Returns:

A positive long to associate with all subscriptions in this request.

getUserProperties

public List<UserProperty> getUserProperties()

Returns the list of MQTT5 user properties included with the packet. See MQTT5 User Property

Returns:

List of MQTT5 user properties included with the packet.