com.taosdata.jdbc.common.Consumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taos-jdbcdriver Show documentation

TDengine JDBC Driver

There is a newer version: 3.4.0

package com.taosdata.jdbc.common;

import com.taosdata.jdbc.tmq.ConsumerRecords;
import com.taosdata.jdbc.tmq.Deserializer;
import com.taosdata.jdbc.tmq.OffsetCommitCallback;
import com.taosdata.jdbc.tmq.TopicPartition;

import java.sql.SQLException;
import java.time.Duration;
import java.util.Collection;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

public interface Consumer {

    /**
     * create consumer
     * @param properties ip / port / user / password and so on.
     * @throws SQLException jni exception
     */
    void create(Properties properties) throws SQLException;

    /**
     * subscribe topics
     * @param topics collection of topics
     * @throws SQLException jni exception
     */
    void subscribe(Collection topics) throws SQLException;

    /**
     * unsubscribe topics
     * @throws SQLException jni exception
     */
    void unsubscribe() throws SQLException;

    /**
     * get subscribe topics
     * @return topic set
     * @throws SQLException jni exception
     */
    Set subscription() throws SQLException;

    /**
     * get result records
     * @param timeout wait time for poll data
     * @param deserializer convert resultSet to javaBean
     * @return ConsumerRecord is the collection of javaBean
     * @throws SQLException java reflect exception or resultSet convert exception
     */
    ConsumerRecords poll(Duration timeout, Deserializer deserializer) throws SQLException;

    /**
     * commit offset with sync
     * @throws SQLException jni exception
     */
    void commitSync() throws SQLException;

    /**
     * close consumer
     * @throws SQLException jni exception
     */
    void close() throws SQLException;

    void commitAsync(OffsetCommitCallback callback);

    /**
     * If this API is invoked for the same partition more than once, the latest offset will be used on the next poll().
     */
    void seek(TopicPartition partition, long offset) throws SQLException;

    long position(TopicPartition partition) throws SQLException;

    Map position(String topic) throws SQLException;

    Map beginningOffsets(String topic) throws SQLException;

    Map endOffsets(String topic) throws SQLException;
}