Package io.confluent.parallelconsumer.internal

Interface DrainingCloseable

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

JStreamParallelStreamProcessor<K,V>, ParallelConsumer<K,V>, ParallelStreamProcessor<K,V>

All Known Implementing Classes:

AbstractParallelEoSStreamProcessor, ExternalEngine, JStreamParallelEoSStreamProcessor, ParallelEoSStreamProcessor

public interface DrainingCloseable
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DrainingCloseable.DrainingMode

Field Summary

Fields

Modifier and Type	Field	Description
static Duration	DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
default void	close()	Close the consumer, without draining.
void	close(Duration timeout, DrainingCloseable.DrainingMode drainingMode)	Close the consumer.
default void	closeDontDrainFirst()
default void	closeDontDrainFirst(Duration timeout)
default void	closeDrainFirst()
default void	closeDrainFirst(Duration timeout)
long	workRemaining()	Of the records consumed from the broker, how many do we have remaining in our local queues

Field Details

DEFAULT_TIMEOUT

static final Duration DEFAULT_TIMEOUT

Method Details

close

default void close()

Close the consumer, without draining. Uses a reasonable default timeout.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

DEFAULT_TIMEOUT, close(Duration, DrainingMode)

closeDrainFirst

default void closeDrainFirst()

See Also:

DrainingCloseable.DrainingMode.DRAIN

closeDontDrainFirst

default void closeDontDrainFirst()

See Also:

DrainingCloseable.DrainingMode.DONT_DRAIN

closeDrainFirst

default void closeDrainFirst(Duration timeout)

See Also:

DrainingCloseable.DrainingMode.DRAIN

closeDontDrainFirst

default void closeDontDrainFirst(Duration timeout)

See Also:

DrainingCloseable.DrainingMode.DONT_DRAIN

close

void close(Duration timeout, DrainingCloseable.DrainingMode drainingMode)

Close the consumer.

Parameters:

timeout - how long to wait before giving up

drainingMode - wait for messages already consumed from the broker to be processed before closing

workRemaining

long workRemaining()

Of the records consumed from the broker, how many do we have remaining in our local queues

Returns:

the number of consumed but outstanding records to process