tech.ydb.topic.read

Interface AsyncReader

All Known Implementing Classes:

AsyncReaderImpl

public interface AsyncReader

Author:

Nikolay Perfilov

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	init() Initialize reading in the background.
CompletableFuture<Void>	shutdown() Stops internal threads and makes cleanup in background.
CompletableFuture<Status>	updateOffsetsInTransaction(YdbTransaction transaction, Map<String,List<PartitionOffsets>> offsets, UpdateOffsetsInTransactionSettings settings) Add offsets to transaction.
default CompletableFuture<Status>	updateOffsetsInTransaction(YdbTransaction transaction, PartitionOffsets offsets, UpdateOffsetsInTransactionSettings settings) Add offsets of a single partition session to transaction.Offsets could be from several topics.

Method Detail

init

CompletableFuture<Void> init()

Initialize reading in the background. Non-blocking

shutdown

CompletableFuture<Void> shutdown()

Stops internal threads and makes cleanup in background. Non-blocking

updateOffsetsInTransaction

CompletableFuture<Status> updateOffsetsInTransaction(YdbTransaction transaction,
                                                     Map<String,List<PartitionOffsets>> offsets,
                                                     UpdateOffsetsInTransactionSettings settings)

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.

Parameters:

transaction - a YdbTransaction that offsets should be added to. Transaction has to be active.

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

settings - Operation settings.

Returns:

CompletableFuture to operation status

updateOffsetsInTransaction

@ExperimentalApi(value="New transaction interfaces are experimental and may change without notice")
default CompletableFuture<Status> updateOffsetsInTransaction(YdbTransaction transaction,
                                                                                                                                                                 PartitionOffsets 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.

Parameters:

transaction - a YdbTransaction that offsets should be added to. Transaction has to be active.

offsets - Offsets that should be added to transaction. Could be constructed with helper methods Message.getPartitionOffsets() or DataReceivedEvent.getPartitionOffsets()

settings - Operation settings.

Returns:

CompletableFuture to operation status