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

Interface PubrelOutboundOutput

All Superinterfaces:

SimpleAsyncOutput<PubrelOutboundOutput>

@DoNotImplement
public interface PubrelOutboundOutput
extends SimpleAsyncOutput<PubrelOutboundOutput>

This is the output parameter of any PubrelOutboundInterceptor.

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
@NotNull Async<PubrelOutboundOutput>	async(@NotNull Duration timeout)	If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
@NotNull ModifiablePubrelPacket	getPubrelPacket()	Use this object to make any changes to the PUBREL message.

Method Details

getPubrelPacket

@NotNull @NotNull ModifiablePubrelPacket getPubrelPacket()

Use this object to make any changes to the PUBREL message.

Returns:

An modifiable PubrelPacket.

Since:

4.3.0, CE 2020.1

async

@NotNull @NotNull Async<PubrelOutboundOutput> 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 PUBREL 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<PubrelOutboundOutput>

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