com.hivemq.client.mqtt.mqtt5.message.connect.connack

Interface Mqtt5ConnAck

All Superinterfaces:

Mqtt5Message

@DoNotImplement
public interface Mqtt5ConnAck
extends Mqtt5Message

MQTT 5 ConnAck packet. This message is translated from and to an MQTT 5 CONNACK packet.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
@NotNull Optional<MqttClientIdentifier>	getAssignedClientIdentifier()
@NotNull Optional<Mqtt5EnhancedAuth>	getEnhancedAuth()
@NotNull Mqtt5ConnAckReasonCode	getReasonCode()
@NotNull Optional<MqttUtf8String>	getReasonString()
@NotNull Optional<MqttUtf8String>	getResponseInformation()
@NotNull Mqtt5ConnAckRestrictions	getRestrictions()
@NotNull OptionalInt	getServerKeepAlive()
@NotNull Optional<MqttUtf8String>	getServerReference()
@NotNull OptionalLong	getSessionExpiryInterval()
default @NotNull Mqtt5MessageType	getType()
@NotNull Mqtt5UserProperties	getUserProperties()
boolean	isSessionPresent()

Method Detail

getReasonCode

@NotNull
@NotNull Mqtt5ConnAckReasonCode getReasonCode()

Returns:

the Reason Code of this ConnAck message.

isSessionPresent

boolean isSessionPresent()

Returns:

whether the server has a session present.

getSessionExpiryInterval

@NotNull
@NotNull OptionalLong getSessionExpiryInterval()

Returns:

the optional session expiry interval set from the server. If absent, the session expiry interval from the Connect message is used.

getServerKeepAlive

@NotNull
@NotNull OptionalInt getServerKeepAlive()

Returns:

the optional keep alive set from the server. If absent, the keep alive from the Connect message is used.

getAssignedClientIdentifier

@NotNull
@NotNull Optional<MqttClientIdentifier> getAssignedClientIdentifier()

Returns:

the optional client identifier assigned by the server. If absent, the client identifier from the Connect message is used.

getEnhancedAuth

@NotNull
@NotNull Optional<Mqtt5EnhancedAuth> getEnhancedAuth()

Returns:

the optional enhanced authentication and/or authorization related data of this ConnAck message.

getRestrictions

@NotNull
@NotNull Mqtt5ConnAckRestrictions getRestrictions()

Returns:

the restrictions set from the server.

getResponseInformation

@NotNull
@NotNull Optional<MqttUtf8String> getResponseInformation()

Returns:

the optional response information of this ConnAck message to retrieve a response topic from.

getServerReference

@NotNull
@NotNull Optional<MqttUtf8String> getServerReference()

Returns:

the optional server reference.

getReasonString

@NotNull
@NotNull Optional<MqttUtf8String> getReasonString()

Returns:

the optional reason string of this ConnAck message.

getUserProperties

@NotNull
@NotNull Mqtt5UserProperties getUserProperties()

Returns:

the optional user properties of this ConnAck message.

getType

@NotNull
default @NotNull Mqtt5MessageType getType()

Specified by:

getType in interface Mqtt5Message

Returns:

the type of this MQTT message.