io.axual.client.consumer

Interface Consumer<K,V>

Type Parameters:

K - the type parameter

V - the type parameter

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AvroConsumer, BaseConsumer, GenericConsumer

public interface Consumer<K,V>
extends java.lang.AutoCloseable

Common interface used for all Axual Client Consumers, exposing only what is needed to start/stop/end consuming.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the consumer.
BaseConsumerConfig<K,V>	getConfig() Get the configuration for this consumer
ConsumeFailedException	getConsumeResult() Returns the result of the background consume task.
boolean	isConsuming() Indicated whether the consumer is still consuming, might return ConsumeFailedException if no longer consuming because of an error
java.util.concurrent.Future<ConsumeFailedException>	startConsuming() Start the consuming process
ConsumeFailedException	stopConsuming() Stops consuming and disconnects

Method Detail

getConfig

BaseConsumerConfig<K,V> getConfig()

Get the configuration for this consumer

Returns:

the configuration of this consumer

startConsuming

java.util.concurrent.Future<ConsumeFailedException> startConsuming()

Start the consuming process

Returns:

a boolean indicating whether the consuming was successfully started

stopConsuming

ConsumeFailedException stopConsuming()

Stops consuming and disconnects

Returns:

null if the consumer closed correctly, or an exception to throw in the calling thread otherwise

isConsuming

boolean isConsuming()

Indicated whether the consumer is still consuming, might return ConsumeFailedException if no longer consuming because of an error

Returns:

true if the consumer is currently consuming, false otherwise

getConsumeResult

ConsumeFailedException getConsumeResult()

Returns the result of the background consume task. May block until task/thread completes.

Returns:

a result in the form of an exception, or null if no error

close

void close()

Closes the consumer. Throws any exception returned by stopConsuming() if applicable.

Specified by:

close in interface java.lang.AutoCloseable