com.hivemq.persistence.retained.RetainedMessagePersistence 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.persistence.retained;

import com.google.common.util.concurrent.ListenableFuture;
import com.hivemq.annotations.ReadOnly;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extensions.iteration.ChunkCursor;
import com.hivemq.extensions.iteration.MultipleChunkResult;
import com.hivemq.persistence.RetainedMessage;

import java.util.Map;
import java.util.Set;

/**
 * @author Dominik Obermaier
 * @author Lukas Brandl
 */
public interface RetainedMessagePersistence {

    /**
     * @return The amount of all retained messages stored in the persistence.
     */
    long size();

    /**
     * Remove the retained message for a given topic
     *
     * @param topic for which the retained message should be removed
     */
    @NotNull ListenableFuture remove(@NotNull String topic);

    /**
     * @param topic of the retained message
     * @return the retained message for the topic
     */
    @NotNull ListenableFuture get(@NotNull String topic);

    /**
     * Add a new rained message to a given topic
     *
     * @param topic           of the retained message
     * @param retainedMessage to be added
     */
    @NotNull ListenableFuture persist(@NotNull String topic, @NotNull RetainedMessage retainedMessage);

    /**
     * @param topicWithWildcards for the retained messages
     * @return all topics matching the given wildcard topic, that have retained messages
     */
    @NotNull
    @ReadOnly
    ListenableFuture> getWithWildcards(@NotNull String topicWithWildcards);

    /**
     * Close the file persistence.
     *
     * @return a future which completes, when closing is done.
     */
    @NotNull ListenableFuture closeDB();

    /**
     * Trigger a clean up a in a given persistence bucket.
     *
     * @param bucketIndex the persistence bucket index.
     * @return a future which completes, when clean up is done.
     */
    @NotNull ListenableFuture cleanUp(int bucketIndex);

    /**
     * Remove all retained messages in the persistence.
     *
     * @return a future which completes, when all messages are removed.
     */
    @NotNull ListenableFuture clear();

    /**
     * Process a request for a chunk of all the client sessions from this node
     *
     * @param cursor the cursor returned from the last chunk or a new (empty) cursor to start iterating the persistence
     * @return a result containing the new cursor and a map of clientIds to their session
     */
    @NotNull ListenableFuture>> getAllLocalRetainedMessagesChunk(
            @NotNull ChunkCursor cursor);
}