Interface DisconnectPacket
-
- All Known Subinterfaces:
ModifiableInboundDisconnectPacket
,ModifiableOutboundDisconnectPacket
@Immutable @DoNotImplement public interface DisconnectPacket
Represents a DISCONNECT packet.Contains all values of an MQTT 5 DISCONNECT packet, but will also be used to represent MQTT 3.x DISCONNECT packets.
- Since:
- 4.3.0, CE 2020.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull DisconnectReasonCode
getReasonCode()
The reason code of the DISCONNECT packet.@NotNull Optional<String>
getReasonString()
The optional reason string of the DISCONNECT packet.@NotNull Optional<String>
getServerReference()
The optional server reference of the DISCONNECT packet.@NotNull Optional<Long>
getSessionExpiryInterval()
The optional session expiry interval in seconds (duration for which the clients session is stored) of the DISCONNECT packet.@NotNull UserProperties
getUserProperties()
The user properties from the DISCONNECT packet.
-
-
-
Method Detail
-
getReasonCode
@NotNull DisconnectReasonCode getReasonCode()
The reason code of the DISCONNECT packet.It will be
DisconnectReasonCode.NORMAL_DISCONNECTION
for MQTT 3.x clients (if not modified by an interceptor).- Returns:
- An enum containing the reason for disconnecting.
- Since:
- 4.3.0, CE 2020.1
-
getReasonString
@NotNull Optional<String> getReasonString()
The optional reason string of the DISCONNECT packet.For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty (if not modified by a previousDisconnectInboundInterceptor
orDisconnectOutboundInterceptor
).- Returns:
- A string containing the disconnect reason if present.
- Since:
- 4.3.0, CE 2020.1
-
getSessionExpiryInterval
@NotNull Optional<Long> getSessionExpiryInterval()
The optional session expiry interval in seconds (duration for which the clients session is stored) of the DISCONNECT packet.If absent, the session expiry interval of the CONNECT/CONNACK handshake will be used.
For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty (if not modified by a previousDisconnectInboundInterceptor
orDisconnectOutboundInterceptor
).- Returns:
- A long representing the session expiry interval if present.
- Since:
- 4.3.0, CE 2020.1
-
getServerReference
@NotNull Optional<String> getServerReference()
The optional server reference of the DISCONNECT packet.It is only present for outbound DISCONNECT packets from the server to a client.
For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty (if not modified by a previousDisconnectInboundInterceptor
orDisconnectOutboundInterceptor
).- Returns:
- A string representing the server reference if present.
- Since:
- 4.3.0, CE 2020.1
-
getUserProperties
@NotNull UserProperties getUserProperties()
The user properties from the DISCONNECT packet.For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty (if not modified by a previousDisconnectInboundInterceptor
orDisconnectOutboundInterceptor
).- Returns:
- The
UserProperties
of the DISCONNECT packet. - Since:
- 4.3.0, CE 2020.1
-
-