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

Interface PubcompOutboundOutput

All Superinterfaces:

SimpleAsyncOutput<PubcompOutboundOutput>

@DoNotImplement
public interface PubcompOutboundOutput
extends SimpleAsyncOutput<PubcompOutboundOutput>

This is the output parameter of any PubcompOutboundInterceptor.

Since:

4.3.0, CE 2020.1

Method Summary

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

Method Details

getPubcompPacket

@NotNull @NotNull ModifiablePubcompPacket getPubcompPacket()

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

Returns:

An modifiable PubcompPacket

Since:

4.3.0, CE 2020.1

async

@NotNull @NotNull Async<PubcompOutboundOutput> 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 PUBCOMP 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<PubcompOutboundOutput>

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