io.vertx.kafka.client.consumer.impl

Class KafkaReadStreamImpl<K,V>

java.lang.Object

io.vertx.kafka.client.consumer.impl.KafkaReadStreamImpl<K,V>

All Implemented Interfaces:

ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>, StreamBase, KafkaReadStream<K,V>

public class KafkaReadStreamImpl<K,V>
extends Object
implements KafkaReadStream<K,V>

Kafka read stream implementation

Constructor Summary

Constructors

Constructor and Description
KafkaReadStreamImpl(Vertx vertx, org.apache.kafka.clients.consumer.Consumer<K,V> consumer, KafkaClientOptions options)

Method Summary

Modifier and Type	Method and Description
Future<Void>	assign(Set<org.apache.kafka.common.TopicPartition> partitions) Manually assign a set of partitions to this consumer.
KafkaReadStream<K,V>	assign(Set<org.apache.kafka.common.TopicPartition> partitions, Handler<AsyncResult<Void>> completionHandler) Manually assign a set of partitions to this consumer.
Future<Set<org.apache.kafka.common.TopicPartition>>	assignment() Like KafkaReadStream.assignment(Handler) but returns a Future of the asynchronous result
KafkaReadStream<K,V>	assignment(Handler<AsyncResult<Set<org.apache.kafka.common.TopicPartition>>> handler) Get the set of partitions currently assigned to this consumer.
KafkaReadStream	batchHandler(Handler<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>> handler) Set the handler that will be called when a new batch of records is returned from Kafka.
Future<Map<org.apache.kafka.common.TopicPartition,Long>>	beginningOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Like KafkaReadStream.beginningOffsets(Set, Handler) but returns a Future of the asynchronous result
void	beginningOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,Long>>> handler) Get the first offset for the given partitions.
Future<Long>	beginningOffsets(org.apache.kafka.common.TopicPartition topicPartition) Like KafkaReadStream.beginningOffsets(TopicPartition, Handler) but returns a Future of the asynchronous result
void	beginningOffsets(org.apache.kafka.common.TopicPartition topicPartition, Handler<AsyncResult<Long>> handler) Get the first offset for the given partition.
Future<Void>	close() Close the stream
void	close(Handler<AsyncResult<Void>> completionHandler) Close the stream
Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>	commit() Commit current offsets for all the subscribed list of topics and partition.
void	commit(Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>> completionHandler) Commit current offsets for all the subscribed list of topics and partition.
Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>	commit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets) Commit the specified offsets for the specified list of topics and partitions to Kafka.
void	commit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets, Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>> completionHandler) Commit the specified offsets for the specified list of topics and partitions to Kafka.
Future<org.apache.kafka.clients.consumer.OffsetAndMetadata>	committed(org.apache.kafka.common.TopicPartition topicPartition) Like KafkaReadStream.committed(TopicPartition, Handler) but returns a Future of the asynchronous result
void	committed(org.apache.kafka.common.TopicPartition topicPartition, Handler<AsyncResult<org.apache.kafka.clients.consumer.OffsetAndMetadata>> handler) Get the last committed offset for the given partition (whether the commit happened by this process or another).
long	demand() Returns the current demand.
KafkaReadStreamImpl<K,V>	endHandler(Handler<Void> endHandler) Set an end handler.
Future<Map<org.apache.kafka.common.TopicPartition,Long>>	endOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Like KafkaReadStream.endOffsets(Set, Handler) but returns a Future of the asynchronous result
void	endOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,Long>>> handler) Get the last offset for the given partitions.
Future<Long>	endOffsets(org.apache.kafka.common.TopicPartition topicPartition) Like KafkaReadStream.endOffsets(TopicPartition, Handler) but returns a Future of the asynchronous result
void	endOffsets(org.apache.kafka.common.TopicPartition topicPartition, Handler<AsyncResult<Long>> handler) Get the last offset for the given partition.
KafkaReadStreamImpl<K,V>	exceptionHandler(Handler<Throwable> handler) Set an exception handler on the read stream.
KafkaReadStreamImpl<K,V>	fetch(long amount) Fetch the specified amount of elements.
KafkaReadStreamImpl<K,V>	handler(Handler<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>> handler) Set a data handler.
Future<Map<String,List<org.apache.kafka.common.PartitionInfo>>>	listTopics() Like KafkaReadStream.listTopics(Handler) but returns a Future of the asynchronous result
KafkaReadStream<K,V>	listTopics(Handler<AsyncResult<Map<String,List<org.apache.kafka.common.PartitionInfo>>>> handler) Get metadata about partitions for all topics that the user is authorized to view.
Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndTimestamp>>	offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> topicPartitionTimestamps) Like KafkaReadStream.offsetsForTimes(Map, Handler) but returns a Future of the asynchronous result
void	offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> topicPartitionTimestamps, Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndTimestamp>>> handler) Look up the offsets for the given partitions by timestamp.
Future<org.apache.kafka.clients.consumer.OffsetAndTimestamp>	offsetsForTimes(org.apache.kafka.common.TopicPartition topicPartition, long timestamp) Like KafkaReadStream.offsetsForTimes(TopicPartition, long, Handler) but returns a Future of the asynchronous result
void	offsetsForTimes(org.apache.kafka.common.TopicPartition topicPartition, long timestamp, Handler<AsyncResult<org.apache.kafka.clients.consumer.OffsetAndTimestamp>> handler) * Look up the offset for the given partition by timestamp.
KafkaReadStream<K,V>	partitionsAssignedHandler(Handler<Set<org.apache.kafka.common.TopicPartition>> handler) Set the handler called when topic partitions are assigned to the consumer
Future<List<org.apache.kafka.common.PartitionInfo>>	partitionsFor(String topic) Like KafkaReadStream.partitionsFor(String, Handler) but returns a Future of the asynchronous result
KafkaReadStreamImpl<K,V>	partitionsFor(String topic, Handler<AsyncResult<List<org.apache.kafka.common.PartitionInfo>>> handler) Get metadata about the partitions for a given topic.
KafkaReadStream<K,V>	partitionsRevokedHandler(Handler<Set<org.apache.kafka.common.TopicPartition>> handler) Set the handler called when topic partitions are revoked to the consumer
KafkaReadStreamImpl<K,V>	pause() Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
Future<Void>	pause(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Suspend fetching from the requested partitions.
KafkaReadStream<K,V>	pause(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Void>> completionHandler) Suspend fetching from the requested partitions.
Future<Set<org.apache.kafka.common.TopicPartition>>	paused() Like KafkaReadStream.paused(Handler) but returns a Future of the asynchronous result
void	paused(Handler<AsyncResult<Set<org.apache.kafka.common.TopicPartition>>> handler) Get the set of partitions that were previously paused by a call to KafkaReadStream.pause(Set).
Future<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>>	poll(Duration timeout) Like KafkaReadStream.poll(Duration, Handler) but returns a Future of the asynchronous result
void	poll(Duration timeout, Handler<AsyncResult<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>>> handler) Executes a poll for getting messages from Kafka.
KafkaReadStream<K,V>	pollTimeout(Duration timeout) Sets the poll timeout for the underlying native Kafka Consumer.
Future<Long>	position(org.apache.kafka.common.TopicPartition partition) Like KafkaReadStream.position(TopicPartition, Handler) but returns a Future of the asynchronous result
void	position(org.apache.kafka.common.TopicPartition partition, Handler<AsyncResult<Long>> handler) Get the offset of the next record that will be fetched (if a record with that offset exists).
KafkaReadStreamImpl<K,V>	resume() Resume reading, and sets the buffer in flowing mode.
Future<Void>	resume(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Resume specified partitions which have been paused with pause.
KafkaReadStream<K,V>	resume(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Void>> completionHandler) Resume specified partitions which have been paused with pause.
Future<Void>	seek(org.apache.kafka.common.TopicPartition topicPartition, long offset) Overrides the fetch offsets that the consumer will use on the next poll.
KafkaReadStream<K,V>	seek(org.apache.kafka.common.TopicPartition topicPartition, long offset, Handler<AsyncResult<Void>> completionHandler) Overrides the fetch offsets that the consumer will use on the next poll.
Future<Void>	seekToBeginning(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Seek to the first offset for each of the given partitions.
KafkaReadStream<K,V>	seekToBeginning(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Void>> completionHandler) Seek to the first offset for each of the given partitions.
Future<Void>	seekToEnd(Set<org.apache.kafka.common.TopicPartition> topicPartitions) Seek to the last offset for each of the given partitions.
KafkaReadStream<K,V>	seekToEnd(Set<org.apache.kafka.common.TopicPartition> topicPartitions, Handler<AsyncResult<Void>> completionHandler) Seek to the last offset for each of the given partitions.
protected <T> void	submitTask(BiConsumer<org.apache.kafka.clients.consumer.Consumer<K,V>,Promise<T>> task, Handler<AsyncResult<T>> handler)
Future<Void>	subscribe(Pattern pattern) Subscribe to all topics matching specified pattern to get dynamically assigned partitions.
KafkaReadStream<K,V>	subscribe(Pattern pattern, Handler<AsyncResult<Void>> completionHandler) Subscribe to all topics matching specified pattern to get dynamically assigned partitions.
Future<Void>	subscribe(Set<String> topics) Subscribe to the given list of topics to get dynamically assigned partitions.
KafkaReadStream<K,V>	subscribe(Set<String> topics, Handler<AsyncResult<Void>> completionHandler) Subscribe to the given list of topics to get dynamically assigned partitions.
Future<Set<String>>	subscription() Like KafkaReadStream.subscription(Handler) but returns a Future of the asynchronous result
KafkaReadStream<K,V>	subscription(Handler<AsyncResult<Set<String>>> handler) Get the current subscription.
Future<Void>	unsubscribe() Unsubscribe from topics currently subscribed with subscribe.
KafkaReadStream<K,V>	unsubscribe(Handler<AsyncResult<Void>> completionHandler) Unsubscribe from topics currently subscribed with subscribe.
org.apache.kafka.clients.consumer.Consumer<K,V>	unwrap()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.kafka.client.consumer.KafkaReadStream

create, create, create, create, create, create, create, create, create, create

Methods inherited from interface io.vertx.core.streams.ReadStream

pipe, pipeTo, pipeTo

Constructor Detail

KafkaReadStreamImpl

public KafkaReadStreamImpl(Vertx vertx,
                           org.apache.kafka.clients.consumer.Consumer<K,V> consumer,
                           KafkaClientOptions options)

Method Detail

submitTask

protected <T> void submitTask(BiConsumer<org.apache.kafka.clients.consumer.Consumer<K,V>,Promise<T>> task,
                              Handler<AsyncResult<T>> handler)

pause

public Future<Void> pause(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Suspend fetching from the requested partitions.

Specified by:

pause in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition from which suspend fetching

Returns:

a Future completed with the operation result

pause

public KafkaReadStream<K,V> pause(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                                  Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Suspend fetching from the requested partitions.

Due to internal buffering of messages, the record handler will continue to observe messages from the given topicPartitions until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will not see messages from the given topicPartitions.

Specified by:

pause in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition from which suspend fetching

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

paused

public void paused(Handler<AsyncResult<Set<org.apache.kafka.common.TopicPartition>>> handler)

Description copied from interface: KafkaReadStream

Get the set of partitions that were previously paused by a call to KafkaReadStream.pause(Set).

Specified by:

paused in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on operation completed

paused

public Future<Set<org.apache.kafka.common.TopicPartition>> paused()

Description copied from interface: KafkaReadStream

Like KafkaReadStream.paused(Handler) but returns a Future of the asynchronous result

Specified by:

paused in interface KafkaReadStream<K,V>

resume

public Future<Void> resume(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Resume specified partitions which have been paused with pause.

Specified by:

resume in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition from which resume fetching

Returns:

a Future completed with the operation result

resume

public KafkaReadStream<K,V> resume(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                                   Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Resume specified partitions which have been paused with pause.

Specified by:

resume in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition from which resume fetching

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

committed

public void committed(org.apache.kafka.common.TopicPartition topicPartition,
                      Handler<AsyncResult<org.apache.kafka.clients.consumer.OffsetAndMetadata>> handler)

Description copied from interface: KafkaReadStream

Get the last committed offset for the given partition (whether the commit happened by this process or another).

Specified by:

committed in interface KafkaReadStream<K,V>

Parameters:

topicPartition - topic partition for getting last committed offset

handler - handler called on operation completed

committed

public Future<org.apache.kafka.clients.consumer.OffsetAndMetadata> committed(org.apache.kafka.common.TopicPartition topicPartition)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.committed(TopicPartition, Handler) but returns a Future of the asynchronous result

Specified by:

committed in interface KafkaReadStream<K,V>

seekToEnd

public Future<Void> seekToEnd(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Seek to the last offset for each of the given partitions.

Specified by:

seekToEnd in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition for which seek

Returns:

a Future completed with the operation result

seekToEnd

public KafkaReadStream<K,V> seekToEnd(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                                      Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Seek to the last offset for each of the given partitions.

Due to internal buffering of messages, the record handler will continue to observe messages fetched with respect to the old offset until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new offset.

Specified by:

seekToEnd in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition for which seek

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

seekToBeginning

public Future<Void> seekToBeginning(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Seek to the first offset for each of the given partitions.

Specified by:

seekToBeginning in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition for which seek

Returns:

a Future completed with the operation result

seekToBeginning

public KafkaReadStream<K,V> seekToBeginning(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                                            Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Seek to the first offset for each of the given partitions.

Due to internal buffering of messages, the record handler will continue to observe messages fetched with respect to the old offset until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new offset.

Specified by:

seekToBeginning in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - topic partition for which seek

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

seek

public Future<Void> seek(org.apache.kafka.common.TopicPartition topicPartition,
                         long offset)

Description copied from interface: KafkaReadStream

Overrides the fetch offsets that the consumer will use on the next poll.

Specified by:

seek in interface KafkaReadStream<K,V>

Parameters:

topicPartition - topic partition for which seek

offset - offset to seek inside the topic partition

Returns:

a Future completed with the operation result

seek

public KafkaReadStream<K,V> seek(org.apache.kafka.common.TopicPartition topicPartition,
                                 long offset,
                                 Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Overrides the fetch offsets that the consumer will use on the next poll.

Due to internal buffering of messages, the record handler will continue to observe messages fetched with respect to the old offset until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new offset.

Specified by:

seek in interface KafkaReadStream<K,V>

Parameters:

topicPartition - topic partition for which seek

offset - offset to seek inside the topic partition

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

partitionsRevokedHandler

public KafkaReadStream<K,V> partitionsRevokedHandler(Handler<Set<org.apache.kafka.common.TopicPartition>> handler)

Description copied from interface: KafkaReadStream

Set the handler called when topic partitions are revoked to the consumer

Specified by:

partitionsRevokedHandler in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on revoked topic partitions

Returns:

current KafkaReadStream instance

partitionsAssignedHandler

public KafkaReadStream<K,V> partitionsAssignedHandler(Handler<Set<org.apache.kafka.common.TopicPartition>> handler)

Description copied from interface: KafkaReadStream

Set the handler called when topic partitions are assigned to the consumer

Specified by:

partitionsAssignedHandler in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on assigned topic partitions

Returns:

current KafkaReadStream instance

subscribe

public Future<Void> subscribe(Set<String> topics)

Description copied from interface: KafkaReadStream

Subscribe to the given list of topics to get dynamically assigned partitions.

Specified by:

subscribe in interface KafkaReadStream<K,V>

Parameters:

topics - topics to subscribe to

Returns:

a Future completed with the operation result

subscribe

public KafkaReadStream<K,V> subscribe(Set<String> topics,
                                      Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Subscribe to the given list of topics to get dynamically assigned partitions.

Due to internal buffering of messages, when changing the subscribed topics the old set of topics may remain in effect (as observed by the KafkaReadStream.handler(Handler) record handler}) until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new set of topics.

Specified by:

subscribe in interface KafkaReadStream<K,V>

Parameters:

topics - topics to subscribe to

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

subscribe

public KafkaReadStream<K,V> subscribe(Pattern pattern,
                                      Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Subscribe to all topics matching specified pattern to get dynamically assigned partitions.

Due to internal buffering of messages, when changing the subscribed topics the old set of topics may remain in effect (as observed by the KafkaReadStream.handler(Handler) record handler}) until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new set of topics.

Specified by:

subscribe in interface KafkaReadStream<K,V>

Parameters:

pattern - Pattern to subscribe to

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

subscribe

public Future<Void> subscribe(Pattern pattern)

Description copied from interface: KafkaReadStream

Subscribe to all topics matching specified pattern to get dynamically assigned partitions.

Specified by:

subscribe in interface KafkaReadStream<K,V>

Parameters:

pattern - Pattern to subscribe to

Returns:

a Future completed with the operation result

unsubscribe

public Future<Void> unsubscribe()

Description copied from interface: KafkaReadStream

Unsubscribe from topics currently subscribed with subscribe.

Specified by:

unsubscribe in interface KafkaReadStream<K,V>

Returns:

current KafkaReadStream instance

unsubscribe

public KafkaReadStream<K,V> unsubscribe(Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Unsubscribe from topics currently subscribed with subscribe.

Specified by:

unsubscribe in interface KafkaReadStream<K,V>

Parameters:

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

subscription

public KafkaReadStream<K,V> subscription(Handler<AsyncResult<Set<String>>> handler)

Description copied from interface: KafkaReadStream

Get the current subscription.

Specified by:

subscription in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on operation completed

Returns:

current KafkaReadStream instance

subscription

public Future<Set<String>> subscription()

Description copied from interface: KafkaReadStream

Like KafkaReadStream.subscription(Handler) but returns a Future of the asynchronous result

Specified by:

subscription in interface KafkaReadStream<K,V>

assign

public Future<Void> assign(Set<org.apache.kafka.common.TopicPartition> partitions)

Description copied from interface: KafkaReadStream

Manually assign a set of partitions to this consumer.

Specified by:

assign in interface KafkaReadStream<K,V>

Parameters:

partitions - partitions which want assigned

Returns:

current KafkaReadStream instance

assign

public KafkaReadStream<K,V> assign(Set<org.apache.kafka.common.TopicPartition> partitions,
                                   Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Manually assign a set of partitions to this consumer.

Due to internal buffering of messages, when reassigning the old set of partitions may remain in effect (as observed by the KafkaReadStream.handler(Handler) record handler)} until some time after the given completionHandler is called. In contrast, the once the given completionHandler is called the KafkaReadStream.batchHandler(Handler) will only see messages consistent with the new set of partitions.

Specified by:

assign in interface KafkaReadStream<K,V>

Parameters:

partitions - partitions which want assigned

completionHandler - handler called on operation completed

Returns:

current KafkaReadStream instance

assignment

public KafkaReadStream<K,V> assignment(Handler<AsyncResult<Set<org.apache.kafka.common.TopicPartition>>> handler)

Description copied from interface: KafkaReadStream

Get the set of partitions currently assigned to this consumer.

Specified by:

assignment in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on operation completed

Returns:

current KafkaReadStream instance

assignment

public Future<Set<org.apache.kafka.common.TopicPartition>> assignment()

Description copied from interface: KafkaReadStream

Like KafkaReadStream.assignment(Handler) but returns a Future of the asynchronous result

Specified by:

assignment in interface KafkaReadStream<K,V>

listTopics

public KafkaReadStream<K,V> listTopics(Handler<AsyncResult<Map<String,List<org.apache.kafka.common.PartitionInfo>>>> handler)

Description copied from interface: KafkaReadStream

Get metadata about partitions for all topics that the user is authorized to view.

Specified by:

listTopics in interface KafkaReadStream<K,V>

Parameters:

handler - handler called on operation completed

Returns:

current KafkaReadStream instance

listTopics

public Future<Map<String,List<org.apache.kafka.common.PartitionInfo>>> listTopics()

Description copied from interface: KafkaReadStream

Like KafkaReadStream.listTopics(Handler) but returns a Future of the asynchronous result

Specified by:

listTopics in interface KafkaReadStream<K,V>

commit

public Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>> commit()

Description copied from interface: KafkaReadStream

Commit current offsets for all the subscribed list of topics and partition.

Specified by:

commit in interface KafkaReadStream<K,V>

commit

public void commit(Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>> completionHandler)

Description copied from interface: KafkaReadStream

Commit current offsets for all the subscribed list of topics and partition.

Specified by:

commit in interface KafkaReadStream<K,V>

Parameters:

completionHandler - handler called on operation completed

commit

public Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>> commit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets)

Description copied from interface: KafkaReadStream

Commit the specified offsets for the specified list of topics and partitions to Kafka.

Specified by:

commit in interface KafkaReadStream<K,V>

Parameters:

offsets - offsets list to commit

Returns:

a Future completed with the operation result

commit

public void commit(Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets,
                   Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>>> completionHandler)

Description copied from interface: KafkaReadStream

Commit the specified offsets for the specified list of topics and partitions to Kafka.

Specified by:

commit in interface KafkaReadStream<K,V>

Parameters:

offsets - offsets list to commit

completionHandler - handler called on operation completed

partitionsFor

public KafkaReadStreamImpl<K,V> partitionsFor(String topic,
                                              Handler<AsyncResult<List<org.apache.kafka.common.PartitionInfo>>> handler)

Description copied from interface: KafkaReadStream

Get metadata about the partitions for a given topic.

Specified by:

partitionsFor in interface KafkaReadStream<K,V>

Parameters:

topic - topic partition for which getting partitions info

handler - handler called on operation completed

Returns:

current KafkaReadStream instance

partitionsFor

public Future<List<org.apache.kafka.common.PartitionInfo>> partitionsFor(String topic)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.partitionsFor(String, Handler) but returns a Future of the asynchronous result

Specified by:

partitionsFor in interface KafkaReadStream<K,V>

exceptionHandler

public KafkaReadStreamImpl<K,V> exceptionHandler(Handler<Throwable> handler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface KafkaReadStream<K,V>

Parameters:

handler - the exception handler

Returns:

a reference to this, so the API can be used fluently

handler

public KafkaReadStreamImpl<K,V> handler(Handler<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>> handler)

Description copied from interface: ReadStream

Set a data handler. As data is read, the handler will be called with the data.

Specified by:

handler in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

handler in interface KafkaReadStream<K,V>

Returns:

a reference to this, so the API can be used fluently

pause

public KafkaReadStreamImpl<K,V> pause()

Description copied from interface: ReadStream

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Specified by:

pause in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

pause in interface KafkaReadStream<K,V>

Returns:

a reference to this, so the API can be used fluently

resume

public KafkaReadStreamImpl<K,V> resume()

Description copied from interface: ReadStream

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Specified by:

resume in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

resume in interface KafkaReadStream<K,V>

Returns:

a reference to this, so the API can be used fluently

fetch

public KafkaReadStreamImpl<K,V> fetch(long amount)

Description copied from interface: ReadStream

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Specified by:

fetch in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

fetch in interface KafkaReadStream<K,V>

Returns:

a reference to this, so the API can be used fluently

demand

public long demand()

Description copied from interface: KafkaReadStream

Returns the current demand.

If the stream is in flowing mode will return Long.MAX_VALUE.
• If the stream is in fetch mode, will return the current number of elements still to be delivered or 0 if paused.

Specified by:

demand in interface KafkaReadStream<K,V>

Returns:

current demand

endHandler

public KafkaReadStreamImpl<K,V> endHandler(Handler<Void> endHandler)

Description copied from interface: ReadStream

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadStream<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Specified by:

endHandler in interface KafkaReadStream<K,V>

Returns:

a reference to this, so the API can be used fluently

close

public Future<Void> close()

Description copied from interface: KafkaReadStream

Close the stream

Specified by:

close in interface KafkaReadStream<K,V>

Returns:

a Future completed with the operation result

close

public void close(Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: KafkaReadStream

Close the stream

Specified by:

close in interface KafkaReadStream<K,V>

Parameters:

completionHandler - handler called on operation completed

position

public void position(org.apache.kafka.common.TopicPartition partition,
                     Handler<AsyncResult<Long>> handler)

Description copied from interface: KafkaReadStream

Get the offset of the next record that will be fetched (if a record with that offset exists).

Specified by:

position in interface KafkaReadStream<K,V>

Parameters:

partition - The partition to get the position for

handler - handler called on operation completed

position

public Future<Long> position(org.apache.kafka.common.TopicPartition partition)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.position(TopicPartition, Handler) but returns a Future of the asynchronous result

Specified by:

position in interface KafkaReadStream<K,V>

offsetsForTimes

public void offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> topicPartitionTimestamps,
                            Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndTimestamp>>> handler)

Description copied from interface: KafkaReadStream

Look up the offsets for the given partitions by timestamp.

Specified by:

offsetsForTimes in interface KafkaReadStream<K,V>

Parameters:

topicPartitionTimestamps - A map with pairs of (TopicPartition, Timestamp).

handler - handler called on operation completed

offsetsForTimes

public Future<Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndTimestamp>> offsetsForTimes(Map<org.apache.kafka.common.TopicPartition,Long> topicPartitionTimestamps)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.offsetsForTimes(Map, Handler) but returns a Future of the asynchronous result

Specified by:

offsetsForTimes in interface KafkaReadStream<K,V>

offsetsForTimes

public void offsetsForTimes(org.apache.kafka.common.TopicPartition topicPartition,
                            long timestamp,
                            Handler<AsyncResult<org.apache.kafka.clients.consumer.OffsetAndTimestamp>> handler)

Description copied from interface: KafkaReadStream

* Look up the offset for the given partition by timestamp.

Specified by:

offsetsForTimes in interface KafkaReadStream<K,V>

Parameters:

topicPartition - Partition to query.

timestamp - Timestamp used to determine the offset.

handler - handler called on operation completed

offsetsForTimes

public Future<org.apache.kafka.clients.consumer.OffsetAndTimestamp> offsetsForTimes(org.apache.kafka.common.TopicPartition topicPartition,
                                                                                    long timestamp)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.offsetsForTimes(TopicPartition, long, Handler) but returns a Future of the asynchronous result

Specified by:

offsetsForTimes in interface KafkaReadStream<K,V>

beginningOffsets

public void beginningOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                             Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,Long>>> handler)

Description copied from interface: KafkaReadStream

Get the first offset for the given partitions.

Specified by:

beginningOffsets in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - the partitions to get the earliest offsets.

handler - handler called on operation completed. Returns the earliest available offsets for the given partitions

beginningOffsets

public Future<Map<org.apache.kafka.common.TopicPartition,Long>> beginningOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.beginningOffsets(Set, Handler) but returns a Future of the asynchronous result

Specified by:

beginningOffsets in interface KafkaReadStream<K,V>

beginningOffsets

public void beginningOffsets(org.apache.kafka.common.TopicPartition topicPartition,
                             Handler<AsyncResult<Long>> handler)

Description copied from interface: KafkaReadStream

Get the first offset for the given partition.

Specified by:

beginningOffsets in interface KafkaReadStream<K,V>

Parameters:

topicPartition - the partition to get the earliest offset.

handler - handler called on operation completed. Returns the earliest available offset for the given partition

beginningOffsets

public Future<Long> beginningOffsets(org.apache.kafka.common.TopicPartition topicPartition)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.beginningOffsets(TopicPartition, Handler) but returns a Future of the asynchronous result

Specified by:

beginningOffsets in interface KafkaReadStream<K,V>

endOffsets

public void endOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions,
                       Handler<AsyncResult<Map<org.apache.kafka.common.TopicPartition,Long>>> handler)

Description copied from interface: KafkaReadStream

Get the last offset for the given partitions. The last offset of a partition is the offset of the upcoming message, i.e. the offset of the last available message + 1.

Specified by:

endOffsets in interface KafkaReadStream<K,V>

Parameters:

topicPartitions - the partitions to get the end offsets.

handler - handler called on operation completed. The end offsets for the given partitions.

endOffsets

public Future<Map<org.apache.kafka.common.TopicPartition,Long>> endOffsets(Set<org.apache.kafka.common.TopicPartition> topicPartitions)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.endOffsets(Set, Handler) but returns a Future of the asynchronous result

Specified by:

endOffsets in interface KafkaReadStream<K,V>

endOffsets

public void endOffsets(org.apache.kafka.common.TopicPartition topicPartition,
                       Handler<AsyncResult<Long>> handler)

Description copied from interface: KafkaReadStream

Get the last offset for the given partition. The last offset of a partition is the offset of the upcoming message, i.e. the offset of the last available message + 1.

Specified by:

endOffsets in interface KafkaReadStream<K,V>

Parameters:

topicPartition - the partition to get the end offset.

handler - handler called on operation completed. The end offset for the given partition.

endOffsets

public Future<Long> endOffsets(org.apache.kafka.common.TopicPartition topicPartition)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.endOffsets(TopicPartition, Handler) but returns a Future of the asynchronous result

Specified by:

endOffsets in interface KafkaReadStream<K,V>

unwrap

public org.apache.kafka.clients.consumer.Consumer<K,V> unwrap()

Specified by:

unwrap in interface KafkaReadStream<K,V>

Returns:

the underlying consumer

batchHandler

public KafkaReadStream batchHandler(Handler<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>> handler)

Description copied from interface: KafkaReadStream

Set the handler that will be called when a new batch of records is returned from Kafka. Batch handlers need to take care not to block the event loop when dealing with large batches. It is better to process records individually using the record handler.

Specified by:

batchHandler in interface KafkaReadStream<K,V>

Parameters:

handler - handler called each time Kafka returns a batch of records.

Returns:

current KafkaReadStream instance.

pollTimeout

public KafkaReadStream<K,V> pollTimeout(Duration timeout)

Description copied from interface: KafkaReadStream

Sets the poll timeout for the underlying native Kafka Consumer. Defaults to 1000 ms. Setting timeout to a lower value results in a more 'responsive' client, because it will block for a shorter period if no data is available in the assigned partition and therefore allows subsequent actions to be executed with a shorter delay. At the same time, the client will poll more frequently and thus will potentially create a higher load on the Kafka Broker.

Specified by:

pollTimeout in interface KafkaReadStream<K,V>

Parameters:

timeout - The time, spent waiting in poll if data is not available in the buffer. If 0, returns immediately with any records that are available currently in the native Kafka consumer's buffer, else returns empty. Must not be negative.

poll

public void poll(Duration timeout,
                 Handler<AsyncResult<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>>> handler)

Description copied from interface: KafkaReadStream

Executes a poll for getting messages from Kafka.

Specified by:

poll in interface KafkaReadStream<K,V>

Parameters:

timeout - The maximum time to block (must not be greater than Long.MAX_VALUE milliseconds)

handler - handler called after the poll with batch of records (can be empty).

poll

public Future<org.apache.kafka.clients.consumer.ConsumerRecords<K,V>> poll(Duration timeout)

Description copied from interface: KafkaReadStream

Like KafkaReadStream.poll(Duration, Handler) but returns a Future of the asynchronous result

Specified by:

poll in interface KafkaReadStream<K,V>