io.github.bucket4j

Interface BlockingStrategy

public interface BlockingStrategy

Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket. There is default implementation PARKING, also you can provide any other implementation which for example does something useful instead of blocking(acts as co-routine) or does spin loop.

Field Summary

Fields

Modifier and Type	Field and Description
static BlockingStrategy	PARKING

Method Summary

Modifier and Type	Method and Description
void	park(long nanosToPark) Park current thread to required duration of nanoseconds.
void	parkUninterruptibly(long nanosToPark) Parks current thread to required duration of nanoseconds ignoring all interrupts, if interrupt was happen then interruption flag will be restored on the current thread.

Field Detail

PARKING

static final BlockingStrategy PARKING

Method Detail

park

void park(long nanosToPark)
   throws InterruptedException

Park current thread to required duration of nanoseconds. Throws InterruptedException in case of current thread was interrupted.

Parameters:

nanosToPark - time to park in nanoseconds

Throws:

InterruptedException - if current tread is interrupted.

parkUninterruptibly

void parkUninterruptibly(long nanosToPark)

Parks current thread to required duration of nanoseconds ignoring all interrupts, if interrupt was happen then interruption flag will be restored on the current thread.

Parameters:

nanosToPark - time to park in nanoseconds