discord4j.common

Class ResettableInterval

java.lang.Object

discord4j.common.ResettableInterval

public class ResettableInterval
extends Object

Emit ticks at a constant rate specified at start(Duration, Duration) and will continue until stop() is called or start(Duration, Duration) is re-invoked, resetting the previous emitter. The ticks are available from the ticks() method.

Constructor Summary

Constructors

Constructor and Description
ResettableInterval(Scheduler scheduler) Create a ResettableInterval that emits ticks on the given Scheduler upon calling start(Duration, Duration).

Method Summary

Modifier and Type	Method and Description
void	start(Duration delay, Duration period) Begin producing ticks at the given rate.
void	stop() Dispose the current emitter task without completing or cancelling existing subscriptions to ticks().
Flux<Long>	ticks() Return a Flux that emits ticks at the currently configured rate.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResettableInterval

public ResettableInterval(Scheduler scheduler)

Create a ResettableInterval that emits ticks on the given Scheduler upon calling start(Duration, Duration).

Parameters:

scheduler - the Reactor Scheduler to use to emit ticks

Method Detail

start

public void start(Duration delay,
                  Duration period)

Begin producing ticks at the given rate.

Parameters:

delay - the Duration to wait before emitting the first tick

period - the period Duration used to emit ticks.

See Also:

Flux.interval(Duration, Duration, Scheduler)

stop

public void stop()

Dispose the current emitter task without completing or cancelling existing subscriptions to ticks().

ticks

public Flux<Long> ticks()

Return a Flux that emits ticks at the currently configured rate.

Returns:

a Flux of increasing values since the last start(Duration, Duration) call