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

Interface PubrecOutboundOutput

All Superinterfaces:

SimpleAsyncOutput<PubrecOutboundOutput>

@DoNotImplement
public interface PubrecOutboundOutput
extends SimpleAsyncOutput<PubrecOutboundOutput>

This is the output parameter of any PubrecOutboundInterceptor.

Since:

4.3.0, CE 2020.1

Method Summary

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

Method Details

getPubrecPacket

@NotNull @NotNull ModifiablePubrecPacket getPubrecPacket()

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

Returns:

A modifiable ModifiablePubrecPacket.

Since:

4.3.0, CE 2020.1

async

@NotNull @NotNull Async<PubrecOutboundOutput> 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 PUBREC 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<PubrecOutboundOutput>

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