Interface DisconnectInboundOutput
-
- All Superinterfaces:
SimpleAsyncOutput<DisconnectInboundOutput>
@DoNotImplement public interface DisconnectInboundOutput extends SimpleAsyncOutput<DisconnectInboundOutput>
This is the output parameter of anyDisconnectInboundInterceptor
providing methods to define the outcome of a DISCONNECT interception. It can be used to modify an inbound DISCONNECT packet.- Since:
- 4.3.0, CE 2020.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull Async<DisconnectInboundOutput>
async(@NotNull Duration timeout)
If the timeout is expired beforeAsync.resume()
is called then the outcome is handled as failed.@NotNull ModifiableInboundDisconnectPacket
getDisconnectPacket()
Use this object to make any changes to the inbound DISCONNECT.
-
-
-
Method Detail
-
getDisconnectPacket
@NotNull ModifiableInboundDisconnectPacket getDisconnectPacket()
Use this object to make any changes to the inbound DISCONNECT.- Returns:
- A
ModifiableInboundDisconnectPacket
. - Since:
- 4.3.0, CE 2020.1
-
async
@NotNull Async<DisconnectInboundOutput> async(@NotNull Duration timeout)
If the timeout is expired beforeAsync.resume()
is called then the outcome is handled as failed. In that case an unmodified DISCONNECT is forwarded to the next interceptor or server, 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 interfaceSimpleAsyncOutput<DisconnectInboundOutput>
- Parameters:
timeout
- Timeout that HiveMQ waits for the result of the async operation.- Returns:
- An
Async
object, usually containing the output object. - Throws:
UnsupportedOperationException
- If async is called more than once.- Since:
- 4.3.0, CE 2020.1
-
-