com.hivemq.mqtt.callback.PublishStatusFutureCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation
HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5
The newest version!
/*
 * Copyright 2019-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hivemq.mqtt.callback;

import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.ListenableFuture;
import com.hivemq.bootstrap.ClientConnection;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.mqtt.handler.publish.PublishStatus;
import com.hivemq.mqtt.message.pool.FreePacketIdRanges;
import com.hivemq.mqtt.message.publish.PUBLISH;
import com.hivemq.mqtt.services.PublishPollService;
import com.hivemq.persistence.util.FutureUtils;
import io.netty.channel.Channel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.atomic.AtomicInteger;

public class PublishStatusFutureCallback implements FutureCallback {

    private static final @NotNull Logger log = LoggerFactory.getLogger(PublishStatusFutureCallback.class);

    private final @NotNull PublishPollService publishPollService;
    private final boolean sharedSubscription;
    private final @NotNull String queueId;
    private final @NotNull PUBLISH publish;
    private final @NotNull FreePacketIdRanges messageIDPool;
    private final int packetIdentifier;
    private final @NotNull Channel channel;
    private final @NotNull String client;

    public PublishStatusFutureCallback(
            final @NotNull PublishPollService publishPollService,
            final boolean sharedSubscription,
            final @NotNull String queueId,
            final @NotNull PUBLISH publish,
            final @NotNull FreePacketIdRanges messageIDPool,
            final @NotNull Channel channel,
            final @NotNull String client) {
        this.publishPollService = publishPollService;
        this.sharedSubscription = sharedSubscription;
        this.queueId = queueId;
        this.publish = publish;
        packetIdentifier = publish.getPacketIdentifier();
        this.messageIDPool = messageIDPool;
        this.channel = channel;
        this.client = client;
    }

    @Override
    public void onSuccess(final PublishStatus status) {
        try {
            if (status == PublishStatus.IN_PROGRESS) {
                log.error("'IN_PROGRESS' is not an expected publish status in the PublishStatusFutureCallback");
                return;
            }
            // QoS 0 messages are already removed
            if (publish.getQoS().getQosNumber() > 0) {
                if (sharedSubscription) {
                    if (status == PublishStatus.DELIVERED) {
                        final ListenableFuture future =
                                publishPollService.removeMessageFromSharedQueue(queueId, publish.getUniqueId());
                        FutureUtils.addExceptionLogger(future);

                    } else if (status == PublishStatus.NOT_CONNECTED || status == PublishStatus.FAILED) {
                        final ListenableFuture future =
                                publishPollService.removeInflightMarker(queueId, publish.getUniqueId());
                        FutureUtils.addExceptionLogger(future);
                    }
                } else {
                    if (status == PublishStatus.DELIVERED) {
                        final ListenableFuture future =
                                publishPollService.removeMessageFromQueue(queueId, packetIdentifier);
                        FutureUtils.addExceptionLogger(future);
                    }
                }
            }
        } catch (final Exception e) {
            log.error("Exceptions in publish status callback handling, queue ID = {}", queueId, e);
        }

        if (status != PublishStatus.NOT_CONNECTED) {
            final AtomicInteger inFlightMessages = ClientConnection.of(channel).getInFlightMessageCount();
            if (inFlightMessages == null || inFlightMessages.decrementAndGet() <= 0) {
                publishPollService.pollMessages(client, channel);
            }
        }
        if (packetIdentifier != 0) {
            messageIDPool.returnId(packetIdentifier);
        }
    }

    @Override
    public void onFailure(final @NotNull Throwable throwable) {
    }
}