Package com.hivemq.extension.sdk.api.events.client.parameters

Interface DisconnectEventInput

All Superinterfaces:

ClientBasedInput

All Known Subinterfaces:

AuthenticationFailedInput, ClientInitiatedDisconnectInput, ConnectionLostInput, ServerInitiatedDisconnectInput

@DoNotImplement
public interface DisconnectEventInput
extends ClientBasedInput

Input object for ClientLifecycleEventListener methods for disconnect events.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
@NotNull Optional<DisconnectedReasonCode>	getReasonCode()
@NotNull Optional<String>	getReasonString()
@NotNull Optional<UserProperties>	getUserProperties()

Methods inherited from interface com.hivemq.extension.sdk.api.parameter.ClientBasedInput

getClientInformation, getConnectionInformation

Method Details

getReasonCode

@NotNull @NotNull Optional<DisconnectedReasonCode> getReasonCode()

Returns:

An Optional containing the disconnected reason code if present.

Since:

4.0.0, CE 2019.1

getReasonString

@NotNull @NotNull Optional<String> getReasonString()

Returns:

An Optional containing the disconnect reason string if present.

Since:

4.0.0, CE 2019.1

getUserProperties

@NotNull @NotNull Optional<UserProperties> getUserProperties()

Returns:

An Optional containing the disconnect user properties if present.

Since:

4.0.0, CE 2019.1