Adds an item to the tail of this ringbuffer. Overflow policy determines what will happen
if there is no space left in this ringbuffer. If
OVERWRITE was passed,
the new item will overwrite the oldest one regardless of the configured time-to-live.
In the case when FAIL was specified the add operation will keep failing until an oldest item in this ringbuffer will reach its time-to-live.
The returned value is the sequence number of the added item. You can read the added item using this number.
the item to add.
overflow policy to be used.
the sequence of the added item or -1 if the insert did not succeed.
Adds all items in the specified array to the tail of this buffer. The behavior of this method is essentially
the same as the one of the
The method does not guarantee that the inserted items will have contiguous sequence numbers.
items to be added
overflow policy to be used
the sequence number of the last written item from the specified array
capacity of this ringbuffer.
Destroys this object cluster-wide. Clears all resources taken for this object.
Returns the unique name of this object.
Returns the key of the partition that this DistributedObject is assigned to. For a partitioned data structure, the returned value will not be null, but otherwise undefined.
Returns the service name for this object.
Returns the head sequence. The head is the side of the ringbuffer where the oldest items are found.
If the ringbuffer is empty, the head will be one more than the tail.
The initial value of the head is 0.
head sequence of this ringbuffer.
Reads a batch of items from this ringbuffer.
If the number of available items starting at
sequence is smaller than
then this method will not wait for more items to arrive.
Instead, available items will be returned.
If there are less items available than
minCount, then this call will not return a response until
a necessary number of items becomes available.
sequence number of the first item to be read.
minimum number of items to be read.
maximum number of items to be read.
Reads a single item from this ringbuffer.
If the sequence is equal to the current tail sequence plus one, this call will not return a response until an item is added. If it is more than that, an error will be thrown.
take, this method does not remove an item from the ringbuffer. This means that the same item
can be read by multiple processes.
the sequence number of the item to read.
the item that was read.
Returns the remaining capacity of this ringbuffer.
The returned value could be stale as soon as it is returned.
If the time-to-live was NOT set in the configuration, the remaining capacity will always be equal to the capacity.
remaining capacity of this ringbuffer.
Returns the number of the items in this ringbuffer.
If time-to-live was NOT configured for this ringbuffer, the size will always be equal to the capacity after the first loop is completed around the ring. This is because no items are getting removed and are overwritten instead.
size of this ringbuffer.
Returns the tail sequence. The tail is the side of the ringbuffer at which the items are added.
The initial value of the tail sequence is -1.
tail sequence of this ringbuffer.
Generated using TypeDoc