Package com.hivemq.extension.sdk.api.interceptor.disconnect.parameter

Interface DisconnectOutboundOutput

All Superinterfaces:

SimpleAsyncOutput<DisconnectOutboundOutput>

@DoNotImplement
public interface DisconnectOutboundOutput
extends SimpleAsyncOutput<DisconnectOutboundOutput>

This is the output parameter of any DisconnectOutboundInterceptor providing methods to define the outcome of DISCONNECT interception. It can be used to modify an outbound DISCONNECT packet.

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
@NotNull Async<DisconnectOutboundOutput>	async(@NotNull Duration timeout)	If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
@NotNull ModifiableOutboundDisconnectPacket	getDisconnectPacket()	Use this object to make any changes to the outbound DISCONNECT.

Method Details

getDisconnectPacket

@NotNull @NotNull ModifiableOutboundDisconnectPacket getDisconnectPacket()

Use this object to make any changes to the outbound DISCONNECT.

Returns:

A ModifiableOutboundDisconnectPacket.

Since:

4.3.0, CE 2020.1

async

@NotNull @NotNull Async<DisconnectOutboundOutput> async(@NotNull Duration timeout)

If the timeout is expired before Async.resume() is called then the outcome is handled as failed. In that case an unmodified DISCONNECT is forwarded to the next interceptor or client, all changes made by this interceptor are not passed on.

Do not call this method more than once. If an async method is called multiple times an exception is thrown.

Specified by:

async in interface SimpleAsyncOutput<DisconnectOutboundOutput>

Parameters:

timeout - Timeout that HiveMQ waits for the result of the async operation.

Throws:

UnsupportedOperationException - If async is called more than once.

Since:

4.3.0, CE 2020.1