tech.ydb.topic.read.AsyncReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ydb-sdk-topic Show documentation
Topic client implementation
There is a newer version: 2.3.0
package tech.ydb.topic.read;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

import io.grpc.ExperimentalApi;

import tech.ydb.common.transaction.YdbTransaction;
import tech.ydb.core.Status;
import tech.ydb.topic.read.events.DataReceivedEvent;
import tech.ydb.topic.settings.UpdateOffsetsInTransactionSettings;

/**
 * @author Nikolay Perfilov
 */
public interface AsyncReader {

    /**
     * Initialize reading in the background. Non-blocking
     */
    CompletableFuture init();

    /**
     * Stops internal threads and makes cleanup in background. Non-blocking
     */
    CompletableFuture shutdown();

    /**
     * Add offsets to transaction. Offsets could be from several topics.
     * These offsets are "committed" only after said transaction is successfully committed.
     * It is a separate request sent outside the reading stream.
     *
     * @param transaction a {@link YdbTransaction} that offsets should be added to.
     *                    Transaction has to be active.
     * @param offsets Offsets that should be added to transaction.
     *                Map key: topic Path
     *                Map value: List of Partition ranges for every partition in this topic to add
     * @param settings Operation settings.
     * @return {@link CompletableFuture} to operation status
     */
    CompletableFuture updateOffsetsInTransaction(YdbTransaction transaction,
                                                         Map> offsets,
                                                         UpdateOffsetsInTransactionSettings settings);

    /**
     * Add offsets of a single partition session to transaction.Offsets could be from several topics.
     * These offsets are "committed" only after said transaction is successfully committed.
     * It is a separate request sent outside the reading stream.
     *
     * @param transaction a {@link YdbTransaction} that offsets should be added to.
     *                    Transaction has to be active.
     * @param offsets Offsets that should be added to transaction.
     *                Could be constructed with helper methods {@link Message#getPartitionOffsets()}
     *                or {@link DataReceivedEvent#getPartitionOffsets()}
     * @param settings Operation settings.
     * @return {@link CompletableFuture} to operation status
     */
    @ExperimentalApi("New transaction interfaces are experimental and may change without notice")
    default CompletableFuture updateOffsetsInTransaction(YdbTransaction transaction, PartitionOffsets offsets,
                                                                 UpdateOffsetsInTransactionSettings settings) {
        return updateOffsetsInTransaction(transaction,
                Collections.singletonMap(offsets.getPartitionSession().getPath(), Collections.singletonList(offsets)),
                settings);
    }
}