io.axual.client.consumer.base

Class BaseConsumer<K,V>

java.lang.Object

io.axual.client.janitor.Janitor.ManagedCloseable

io.axual.client.consumer.base.BaseConsumer<K,V>

All Implemented Interfaces:

Consumer<K,V>, java.lang.AutoCloseable

Direct Known Subclasses:

AvroConsumer, GenericConsumer

public abstract class BaseConsumer<K,V>
extends Janitor.ManagedCloseable
implements Consumer<K,V>

Generic consumer class, the strategy is implemented in the used source

Constructor Summary

Constructors

Constructor and Description
BaseConsumer(BaseMessageSource<K,V> messageSource, Processor<K,V> processor)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the consumer.
ConsumeFailedException	consumeLoop()
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() This method starts the actual consumeThreadRunning, it can be stopped by calling stopconsuming()
ConsumeFailedException	stopConsuming() Stops consuming and disconnects

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseConsumer

public BaseConsumer(BaseMessageSource<K,V> messageSource,
                    Processor<K,V> processor)

Method Detail

getConfig

public BaseConsumerConfig<K,V> getConfig()

Description copied from interface: Consumer

Get the configuration for this consumer

Specified by:

getConfig in interface Consumer<K,V>

Returns:

the configuration of this consumer

startConsuming

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

This method starts the actual consumeThreadRunning, it can be stopped by calling stopconsuming()

Specified by:

startConsuming in interface Consumer<K,V>

Returns:

whether or not it was successfully started

stopConsuming

public ConsumeFailedException stopConsuming()

Description copied from interface: Consumer

Stops consuming and disconnects

Specified by:

stopConsuming in interface Consumer<K,V>

Returns:

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

isConsuming

public boolean isConsuming()

Description copied from interface: Consumer

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

Specified by:

isConsuming in interface Consumer<K,V>

Returns:

true if the consumer is currently consuming, false otherwise

getConsumeResult

public ConsumeFailedException getConsumeResult()

Description copied from interface: Consumer

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

Specified by:

getConsumeResult in interface Consumer<K,V>

Returns:

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

consumeLoop

public ConsumeFailedException consumeLoop()

close

public void close()

Description copied from interface: Consumer

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

Specified by:

close in interface Consumer<K,V>

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class Janitor.ManagedCloseable