io.deephaven.kafka.ingest.KafkaRecordConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-extensions-kafka Show documentation

Kafka: Integrating Engine tables with Kafka

There is a newer version: 0.37.1

Show newest version

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.kafka.ingest;

import io.deephaven.stream.StreamFailureConsumer;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.jetbrains.annotations.NotNull;

import java.util.List;

/**
 * Consumer for lists of ConsumerRecords coming from Kafka. The StreamFailureConsumer is extended so that we can report
 * errors emanating from our consumer thread.
 */
public interface KafkaRecordConsumer extends StreamFailureConsumer {

    /**
     * Consume a list of ConsumerRecords coming from Kafka.
     *
     * @param receiveTime the time, in nanoseconds since the epoch, the records were received in this process
     * @param records the records to consume
     * @return the total number of message bytes processed, according whether any key and/or value fields were
     *         processed, and the corresponding values for
     *         {@code org.apache.kafka.clients.consumer.ConsumerRecord.serializedKeySize}
     *         {@code org.apache.kafka.clients.consumer.ConsumerRecord.serializedValueSize}
     */
    long consume(long receiveTime, @NotNull List> records);
}