org.redisson.api

Interface RRingBuffer<V>

Type Parameters:

V - value type

All Superinterfaces:

Collection<V>, Iterable<V>, Queue<V>, RCollectionAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RQueue<V>, RQueueAsync<V>, RRingBufferAsync<V>

All Known Implementing Classes:

RedissonRingBuffer

public interface RRingBuffer<V>
extends RQueue<V>, RRingBufferAsync<V>

RingBuffer based queue evicts elements from the head if queue capacity became full.

The head element removed if new element added and queue is full.

Must be initialized with capacity size trySetCapacity(int) before usage.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
int	capacity() Returns capacity of this queue
int	remainingCapacity() Returns remaining capacity of this queue
boolean	trySetCapacity(int capacity) Sets queue capacity only if it is not set before.

Methods inherited from interface org.redisson.api.RQueue

poll, pollLastAndOfferFirstTo, readAll

Methods inherited from interface java.util.Queue

add, element, offer, peek, poll, remove

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RRingBufferAsync

capacityAsync, remainingCapacityAsync, trySetCapacityAsync

Methods inherited from interface org.redisson.api.RQueueAsync

offerAsync, peekAsync, pollAsync, pollAsync, pollLastAndOfferFirstToAsync, readAllAsync

Methods inherited from interface org.redisson.api.RCollectionAsync

addAllAsync, addAsync, containsAllAsync, containsAsync, removeAllAsync, removeAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Method Detail

trySetCapacity

boolean trySetCapacity(int capacity)

Sets queue capacity only if it is not set before.

Parameters:

capacity - - queue capacity

Returns:

true if capacity set successfully false if capacity already set

remainingCapacity

int remainingCapacity()

Returns remaining capacity of this queue

Returns:

remaining capacity

capacity

int capacity()

Returns capacity of this queue

Returns:

queue capacity