org.apache.flink.runtime.io.disk.iomanager

Interface BlockChannelReader

All Superinterfaces:

FileIOChannel

All Known Implementing Classes:

AsynchronousBlockReader

public interface BlockChannelReader
extends FileIOChannel

A reader that reads data in blocks from a file channel. The reader reads the blocks into a MemorySegment. To support asynchronous implementations, the read method does not immediately return the full memory segment, but rather adds it to a blocking queue of finished read operations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.disk.iomanager.FileIOChannel

FileIOChannel.Enumerator, FileIOChannel.ID

Method Summary

Methods

Modifier and Type	Method and Description
MemorySegment	getNextReturnedSegment() Gets the next memory segment that has been filled with data by the reader.
LinkedBlockingQueue<MemorySegment>	getReturnQueue() Gets the queue in which the full memory segments are queued after the read is complete.
void	readBlock(MemorySegment segment) Issues a read request, which will fill the given segment with the next block in the underlying file channel.

Methods inherited from interface org.apache.flink.runtime.io.disk.iomanager.FileIOChannel

close, closeAndDelete, deleteChannel, getChannelID, isClosed

Method Detail

readBlock

void readBlock(MemorySegment segment)
               throws IOException

Issues a read request, which will fill the given segment with the next block in the underlying file channel. Once the read request is fulfilled, the segment will be added to this reader's return queue.

Parameters:

segment - The segment to read the block into.

Throws:

IOException - Thrown, when the reader encounters an I/O error.

getNextReturnedSegment

MemorySegment getNextReturnedSegment()
                                     throws IOException

Gets the next memory segment that has been filled with data by the reader. This method blocks until such a segment is available, or until an error occurs in the reader, or the reader is closed.

WARNING: If this method is invoked without any segment ever returning (for example, because the readBlock(MemorySegment) method has not been invoked appropriately), the method may block forever.

Returns:

The next memory segment from the reader's return queue.

Throws:

IOException - Thrown, if an I/O error occurs in the reader while waiting for the request to return.

getReturnQueue

LinkedBlockingQueue<MemorySegment> getReturnQueue()

Gets the queue in which the full memory segments are queued after the read is complete.

Returns:

The queue with the full memory segments.