tech.ydb.topic.read.DeferredCommitter 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 tech.ydb.topic.read.events.DataReceivedEvent;
import tech.ydb.topic.read.impl.DeferredCommitterImpl;

/**
 * A helper class that is used to call deferred commits.
 * Several {@link Message}s or/and {@link tech.ydb.topic.read.events.DataReceivedEvent}s can be accepted to commit later
 * all at once.
 * Contains no data references and therefore may also be useful in cases where commit() is called after processing data
 * in an external system.
 *
 * @author Nikolay Perfilov
 */
public interface DeferredCommitter extends MessageAccumulator {
    /**
     * Creates a new instance of {@link DeferredCommitter}
     *
     * @return a new instance of {@link DeferredCommitter}
     */
    static DeferredCommitter newInstance() {
        return new DeferredCommitterImpl();
    }

    /**
     * Commits offset ranges from all {@link Message}s and {@link DataReceivedEvent}s
     * that were added to this DeferredCommitter since last commit
     */
    void commit();
}