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

Interface PubcompOutboundInterceptor

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 PubcompOutboundInterceptor
extends Interceptor

Interface for the outbound PUBCOMP 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 onOutboundPubcomp(PubcompOutboundInput, PubcompOutboundOutput) throws an exception or a call to PubcompOutboundOutput.async(Duration) times out with TimeoutFallback.FAILURE, HiveMQ will ignore this interceptor and will:

1. Log the exception
2. Revert the changes to the ModifiablePubcompPacket made by the interceptor
3. Call the next PubcompOutboundInterceptor or send the PUBCOMP to the client if no interceptor is left

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
void	onOutboundPubcomp(@NotNull PubcompOutboundInput pubcompOutboundInput, @NotNull PubcompOutboundOutput pubcompOutboundOutput)	When a PubcompOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBCOMP packet for any MQTT client.

Method Details

onOutboundPubcomp

void onOutboundPubcomp(@NotNull PubcompOutboundInput pubcompOutboundInput, @NotNull PubcompOutboundOutput pubcompOutboundOutput)

When a PubcompOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBCOMP packet for any MQTT client.

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

Parameters:

pubcompOutboundInput - The PubcompOutboundInput parameter.

pubcompOutboundOutput - The PubcompOutboundOutput parameter.

Since:

4.3.0, CE 2020.1