Module io.github.bucket4j.core

Package io.github.bucket4j

Interface VerboseBlockingBucket

public interface VerboseBlockingBucket

Verbose API for BlockingBucket

Method Summary

Modifier and Type	Method	Description
default VerboseResult<Void>	consume(long numTokens)	Has the same semantic as BlockingBucket.consume(long)
VerboseResult<Void>	consume(long numTokens, BlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.consume(long, BlockingStrategy)
default VerboseResult<Void>	consumeUninterruptibly(long numTokens)	Has the same semantic as BlockingBucket.consumeUninterruptibly(long)
VerboseResult<Void>	consumeUninterruptibly(long numTokens, UninterruptibleBlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.consumeUninterruptibly(long, UninterruptibleBlockingStrategy)
default VerboseResult<Boolean>	tryConsume(long numTokens, long maxWaitTimeNanos)	Has the same semantic as BlockingBucket.tryConsume(long, long)
VerboseResult<Boolean>	tryConsume(long numTokens, long maxWaitTimeNanos, BlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.tryConsume(long, long, BlockingStrategy)
default VerboseResult<Boolean>	tryConsume(long numTokens, Duration maxWait)	Has the same semantic as BlockingBucket.tryConsume(long, Duration)
default VerboseResult<Boolean>	tryConsume(long numTokens, Duration maxWait, BlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.tryConsume(long, Duration, BlockingStrategy)
default VerboseResult<Boolean>	tryConsumeUninterruptibly(long numTokens, long maxWaitTimeNanos)	Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, long)
VerboseResult<Boolean>	tryConsumeUninterruptibly(long numTokens, long maxWaitTimeNanos, UninterruptibleBlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy)
default VerboseResult<Boolean>	tryConsumeUninterruptibly(long numTokens, Duration maxWait)	Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, Duration)
default VerboseResult<Boolean>	tryConsumeUninterruptibly(long numTokens, Duration maxWait, UninterruptibleBlockingStrategy blockingStrategy)	Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, Duration, UninterruptibleBlockingStrategy)

Method Detail

tryConsume

VerboseResult<Boolean> tryConsume(long numTokens,
                                  long maxWaitTimeNanos,
                                  BlockingStrategy blockingStrategy)
                           throws InterruptedException

Has the same semantic as BlockingBucket.tryConsume(long, long, BlockingStrategy)

Throws:

InterruptedException

tryConsume

default VerboseResult<Boolean> tryConsume(long numTokens,
                                          Duration maxWait,
                                          BlockingStrategy blockingStrategy)
                                   throws InterruptedException

Has the same semantic as BlockingBucket.tryConsume(long, Duration, BlockingStrategy)

Throws:

InterruptedException

tryConsume

default VerboseResult<Boolean> tryConsume(long numTokens,
                                          long maxWaitTimeNanos)
                                   throws InterruptedException

Has the same semantic as BlockingBucket.tryConsume(long, long)

Throws:

InterruptedException

tryConsume

default VerboseResult<Boolean> tryConsume(long numTokens,
                                          Duration maxWait)
                                   throws InterruptedException

Has the same semantic as BlockingBucket.tryConsume(long, Duration)

Throws:

InterruptedException

tryConsumeUninterruptibly

VerboseResult<Boolean> tryConsumeUninterruptibly(long numTokens,
                                                 long maxWaitTimeNanos,
                                                 UninterruptibleBlockingStrategy blockingStrategy)

Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy)

tryConsumeUninterruptibly

default VerboseResult<Boolean> tryConsumeUninterruptibly(long numTokens,
                                                         Duration maxWait,
                                                         UninterruptibleBlockingStrategy blockingStrategy)

Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, Duration, UninterruptibleBlockingStrategy)

tryConsumeUninterruptibly

default VerboseResult<Boolean> tryConsumeUninterruptibly(long numTokens,
                                                         long maxWaitTimeNanos)

Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, long)

tryConsumeUninterruptibly

default VerboseResult<Boolean> tryConsumeUninterruptibly(long numTokens,
                                                         Duration maxWait)

Has the same semantic as BlockingBucket.tryConsumeUninterruptibly(long, Duration)

consume

VerboseResult<Void> consume(long numTokens,
                            BlockingStrategy blockingStrategy)
                     throws InterruptedException

Has the same semantic as BlockingBucket.consume(long, BlockingStrategy)

Throws:

InterruptedException

consume

default VerboseResult<Void> consume(long numTokens)
                             throws InterruptedException

Has the same semantic as BlockingBucket.consume(long)

Throws:

InterruptedException

consumeUninterruptibly

VerboseResult<Void> consumeUninterruptibly(long numTokens,
                                           UninterruptibleBlockingStrategy blockingStrategy)

Has the same semantic as BlockingBucket.consumeUninterruptibly(long, UninterruptibleBlockingStrategy)

consumeUninterruptibly

default VerboseResult<Void> consumeUninterruptibly(long numTokens)

Has the same semantic as BlockingBucket.consumeUninterruptibly(long)