Interface UnsubscribeInboundOutput
-
- All Superinterfaces:
AsyncOutput<UnsubscribeInboundOutput>
,SimpleAsyncOutput<UnsubscribeInboundOutput>
@DoNotImplement public interface UnsubscribeInboundOutput extends AsyncOutput<UnsubscribeInboundOutput>
This is the output parameter of anyUnsubscribeInboundInterceptor
.It can be used to modify an inbound UNSUBSCRIBE packet.
- Since:
- 4.3.0, CE 2020.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull Async<UnsubscribeInboundOutput>
async(@NotNull Duration timeout)
If the timeout is expired beforeAsync.resume()
is called then the outcome is handled as failed.@NotNull ModifiableUnsubscribePacket
getUnsubscribePacket()
Use this Object to make any changes to the inbound UNSUBSCRIBE.-
Methods inherited from interface com.hivemq.extension.sdk.api.async.AsyncOutput
async
-
-
-
-
Method Detail
-
getUnsubscribePacket
@NotNull ModifiableUnsubscribePacket getUnsubscribePacket()
Use this Object to make any changes to the inbound UNSUBSCRIBE.- Returns:
- A modifiable UNSUBSCRIBE packet.
- Since:
- 4.3.0, CE 2020.1
-
async
@NotNull Async<UnsubscribeInboundOutput> async(@NotNull Duration timeout)
If the timeout is expired beforeAsync.resume()
is called then the outcome is handled as failed. This means that the outcome results in an Unsuback withUnsubackReasonCode.UNSPECIFIED_ERROR
and the unsubscribe will be prevented.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<UnsubscribeInboundOutput>
- 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
-
-