io.thill.kafkalite.client

Class QueuedKafkaConsumer<K,V>

java.lang.Object

io.thill.kafkalite.client.QueuedKafkaConsumer<K,V>

All Implemented Interfaces:

AutoCloseable

public class QueuedKafkaConsumer<K,V>
extends Object
implements AutoCloseable

Queueing Kafka Consumer, useful for tests since it can poll 1 message at a time with a timeout

Constructor Summary

Constructors

Constructor and Description
QueuedKafkaConsumer(org.apache.kafka.common.TopicPartition topicPartition, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isEmpty()
boolean	isEmpty(long waitMillis)
org.apache.kafka.clients.consumer.ConsumerRecord<K,V>	poll() Poll a single record, waiting for up to one second for it to be available.
org.apache.kafka.clients.consumer.ConsumerRecord<K,V>	poll(long timeoutMillis) Poll a single record, waiting for up to the given number of milliseconds for it to be available.
org.apache.kafka.clients.consumer.ConsumerRecord<K,V>	poll(long timeout, TimeUnit unit) Poll a single record, waiting for up to the given time/timeUnit for it to be available.
void	seekToBeginning() Seek to beginning of topic partition
void	seekToEnd() Seek to end of topic partition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueuedKafkaConsumer

public QueuedKafkaConsumer(org.apache.kafka.common.TopicPartition topicPartition,
                           Properties properties)

Method Detail

seekToBeginning

public void seekToBeginning()

Seek to beginning of topic partition

seekToEnd

public void seekToEnd()

Seek to end of topic partition

poll

public org.apache.kafka.clients.consumer.ConsumerRecord<K,V> poll()

Poll a single record, waiting for up to one second for it to be available. After 1 second, null is returned.

Returns:

The record, or null if it did not exist within 1 second

poll

public org.apache.kafka.clients.consumer.ConsumerRecord<K,V> poll(long timeoutMillis)

Poll a single record, waiting for up to the given number of milliseconds for it to be available. After the given number of milliseconds, null is returned.

Parameters:

timeoutMillis - The timeout in milliseconds

Returns:

The record, of null if it did not exist within the given number of milliseconds

poll

public org.apache.kafka.clients.consumer.ConsumerRecord<K,V> poll(long timeout,
                                                                  TimeUnit unit)

Poll a single record, waiting for up to the given time/timeUnit for it to be available. After the timeout, null is returned.

Parameters:

timeout - The timeout value

unit - The unit of the timeout

Returns:

The record, of null if it did not exist within the timeout

isEmpty

public boolean isEmpty()

isEmpty

public boolean isEmpty(long waitMillis)

close

public void close()

Specified by:

close in interface AutoCloseable