PageBuffer (core API)

All Superinterfaces:: ReadPageBuffer, WritePageBuffer

All Known Implementing Classes:: LinkedListBuffer

public interface PageBuffer extends ReadPageBuffer, WritePageBuffer

The main interface for passing buffers of Tuples see core/ nz.org.riskscape.engine.Tuple between WorkerTasks. The same PageBuffer doubles as a WritePageBuffer for one or more WorkerTasks and a ReadPageBuffer for one or more WorkerTasks.

Method Summary

Modifier and Type

Method

Description

ReadPageBuffer

newReaderClone()

Methods inherited from interface nz.org.riskscape.engine.task.ReadPageBuffer
isComplete, isEmpty, numTuplesRead, read, size

Methods inherited from interface nz.org.riskscape.engine.task.WritePageBuffer
add, getTupleCapacity, isFull, markComplete, newPage, numTuplesRead, numTuplesWritten

Method Details
- newReaderClone
  
  ReadPageBuffer newReaderClone()
  
  Returns:
  
  a clone of the ReadPageBuffer. This allows multiple different threads to read from the same input buffer without interfering with each other. Both the cloned and the original ReadPageBuffer will get all the same input Tuples/pages, without actually duplicating the underlying input memory-wise.