Package com.hivemq.extension.sdk.api.interceptor.puback

Interface PubackOutboundInterceptor

All Superinterfaces:

Interceptor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PubackOutboundInterceptor
extends Interceptor

Interface for the outbound PUBACK interception.

Interceptors are always called by the same Thread for all messages from the same client.

If the same instance is shared between multiple clients it can be called in different Threads and must therefore be thread-safe.

When the method onOutboundPuback(PubackOutboundInput, PubackOutboundOutput) throws an exception or a call to PubackOutboundOutput.async(Duration) times out with TimeoutFallback.FAILURE, HiveMQ will ignore this interceptor and will:

1. Log the exception
2. Revert the changes to the ModifiablePubackPacket made by the interceptor
3. Call the next PubackOutboundInterceptor or send the PUBACK to the client if no interceptor is left

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
void	onOutboundPuback(@NotNull PubackOutboundInput pubackOutboundInput, @NotNull PubackOutboundOutput pubackOutboundOutput)	When a PubackOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBACK packet to any MQTT client.

Method Detail

onOutboundPuback

void onOutboundPuback(@NotNull PubackOutboundInput pubackOutboundInput,
                      @NotNull PubackOutboundOutput pubackOutboundOutput)

When a PubackOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBACK packet to any MQTT client.

When the extension is enabled after HiveMQ is already running, this method will also be called for future PUBACKs for clients that are already connected.

Parameters:

pubackOutboundInput - The PubackOutboundInput parameter.

pubackOutboundOutput - The PubackOutboundOutput parameter.

Since:

4.3.0, CE 2020.1