- Type Parameters:
E- item type
- All Superinterfaces:
public interface ReadResultSet<E> extends Iterable<E>
Ringbuffer.readManyAsync(long, int, int, com.hazelcast.core.IFunction)operation.
If an item is retrieved multiple times from the result set, a new instance is returned for every invocation. This is done to prevent unexpected sharing if the
is shared between multiple threads.
Fields Modifier and Type Field Description
SEQUENCE_UNAVAILABLEValue returned from methods returning a sequence number when the information is not available (e.g.
Modifier and Type Method Description
get(int index)Gets the item at the given index.
getNextSequenceToReadFrom()Returns the sequence of the item following the last read item.
getSequence(int index)Return the sequence number for the item at the given index.
readCount()Returns the number of items that have been read before filtering.
size()Return the result set size.
int readCount()Returns the number of items that have been read before filtering.
If no filter is set, then the
readCountwill be equal to
size(). But if a filter is applied, it could be that items are read, but are filtered out. So if you are trying to make another read based on the
ReadResultSetthen you should increment the sequence by
readCountand not by
size(). Otherwise you will be re-reading the same filtered messages.
- the number of items read (including the filtered ones).
E get(int index)Gets the item at the given index.
index- the index
- the found item.
IllegalArgumentException- if index out of bounds.
long getSequence(int index)Return the sequence number for the item at the given index.
int size()Return the result set size. See also
- the result set size
long getNextSequenceToReadFrom()Returns the sequence of the item following the last read item. This sequence can then be used to read items following the ones returned by this result set. Usually this sequence is equal to the sequence used to retrieve this result set incremented by the
readCount(). In cases when the reader tolerates lost items, this is not the case. For instance, if the reader requests an item with a stale sequence (one which has already been overwritten), the read will jump to the oldest sequence and read from there. Similarly, if the reader requests an item in the future (e.g. because the partition was lost and the reader was unaware of this), the read method will jump back to the newest available sequence. Because of these jumps and only in the case when the reader is loss tolerant, the next sequence must be retrieved using this method. A return value of -1 means that the information is not available.
- the sequence of the item following the last item in the result set