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

Interface SubackOutboundOutput

All Superinterfaces:

SimpleAsyncOutput<SubackOutboundOutput>

@DoNotImplement
public interface SubackOutboundOutput
extends SimpleAsyncOutput<SubackOutboundOutput>

This is the output parameter of any SubackOutboundInterceptor providing methods to modify a SUBACK packet before it is sent to the client.

Since:

4.3.0, CE 2020.1

Method Summary

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

Method Details

getSubackPacket

@NotNull @NotNull ModifiableSubackPacket getSubackPacket()

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

Returns:

A modifiable SUBACK packet.

Since:

4.3.0, CE 2020.1

async

@NotNull @NotNull Async<SubackOutboundOutput> 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 SUBACK 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<SubackOutboundOutput>

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