org.apache.flink.table.runtime.io

Class CompressedHeaderlessChannelReaderInputView

java.lang.Object

org.apache.flink.runtime.memory.AbstractPagedInputView

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

org.apache.flink.table.runtime.io.CompressedHeaderlessChannelReaderInputView

All Implemented Interfaces:

DataInput, DataInputView, RequestDoneCallback<Buffer>, BufferRecycler

public class CompressedHeaderlessChannelReaderInputView
extends AbstractChannelReaderInputView
implements RequestDoneCallback<Buffer>, BufferRecycler

A DataInputView that is backed by a BufferFileReader, making it effectively a data input stream. The view reads it data in blocks from the underlying channel and decompress it before returning to caller. The view can only read data that has been written by CompressedHeaderlessChannelWriterOutputView, due to block formatting.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.buffer.BufferRecycler

BufferRecycler.DummyBufferRecycler

Field Summary

Fields inherited from class org.apache.flink.runtime.memory.AbstractPagedInputView

headerLength

Constructor Summary

Constructors

Constructor and Description
CompressedHeaderlessChannelReaderInputView(FileIOChannel.ID id, IOManager ioManager, BlockCompressionFactory compressionCodecFactory, int compressionBlockSize, int numBlocks)

Method Summary

Modifier and Type	Method and Description
List<MemorySegment>	close() Closes this InputView, closing the underlying reader and returning all memory segments.
FileIOChannel	getChannel() Get the underlying channel.
protected int	getLimitForSegment(MemorySegment segment) Gets the limit for reading bytes from the given memory segment.
BufferFileReader	getReader()
boolean	isClosed()
protected MemorySegment	nextSegment(MemorySegment current) The method by which concrete subclasses realize page crossing.
void	recycle(MemorySegment segment) Recycles the MemorySegment to its original BufferPool instance.
void	requestFailed(Buffer buffer, IOException e)
void	requestSuccessful(Buffer request)

Methods inherited from class org.apache.flink.runtime.memory.AbstractPagedInputView

advance, clear, doAdvance, getCurrentPositionInSegment, getCurrentSegment, getCurrentSegmentLimit, getHeaderLength, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, seekInput, skipBytes, skipBytesToRead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompressedHeaderlessChannelReaderInputView

public CompressedHeaderlessChannelReaderInputView(FileIOChannel.ID id,
                                                  IOManager ioManager,
                                                  BlockCompressionFactory compressionCodecFactory,
                                                  int compressionBlockSize,
                                                  int numBlocks)
                                           throws IOException

Throws:

IOException

Method Detail

nextSegment

protected MemorySegment nextSegment(MemorySegment current)
                             throws IOException

Description copied from class: AbstractPagedInputView

The method by which concrete subclasses realize page crossing. This method is invoked when the current page is exhausted and a new page is required to continue the reading. If no further page is available, this method must throw an EOFException.

Specified by:

nextSegment in class AbstractPagedInputView

Parameters:

current - The current page that was read to its limit. May be null, if this method is invoked for the first time.

Returns:

The next page from which the reading should continue. May not be null. If the input is exhausted, an EOFException must be thrown instead.

Throws:

EOFException - Thrown, if no further segment is available.

IOException - Thrown, if the method cannot provide the next page due to an I/O related problem.

getReader

public BufferFileReader getReader()

getLimitForSegment

protected int getLimitForSegment(MemorySegment segment)

Description copied from class: AbstractPagedInputView

Gets the limit for reading bytes from the given memory segment. This method must return the position of the byte after the last valid byte in the given memory segment. When the position returned by this method is reached, the view will attempt to switch to the next memory segment.

Specified by:

getLimitForSegment in class AbstractPagedInputView

Parameters:

segment - The segment to determine the limit for.

Returns:

The limit for the given memory segment.

close

public List<MemorySegment> close()
                          throws IOException

Description copied from class: AbstractChannelReaderInputView

Closes this InputView, closing the underlying reader and returning all memory segments.

Specified by:

close in class AbstractChannelReaderInputView

Returns:

A list containing all memory segments originally supplied to this view.

Throws:

IOException - Thrown, if the underlying reader could not be properly closed.

getChannel

public FileIOChannel getChannel()

Description copied from class: AbstractChannelReaderInputView

Get the underlying channel.

Specified by:

getChannel in class AbstractChannelReaderInputView

isClosed

public boolean isClosed()

requestSuccessful

public void requestSuccessful(Buffer request)

Specified by:

requestSuccessful in interface RequestDoneCallback<Buffer>

requestFailed

public void requestFailed(Buffer buffer,
                          IOException e)

Specified by:

requestFailed in interface RequestDoneCallback<Buffer>

recycle

public void recycle(MemorySegment segment)

Description copied from interface: BufferRecycler

Recycles the MemorySegment to its original BufferPool instance.

Specified by:

recycle in interface BufferRecycler

Parameters:

segment - The memory segment to be recycled.