org.apache.flink.table.runtime.io

Class CompressedBlockChannelWriter

java.lang.Object

org.apache.flink.table.runtime.io.CompressedBlockChannelWriter

All Implemented Interfaces:

BlockChannelWriter<MemorySegment>, BlockChannelWriterWithCallback<MemorySegment>, FileIOChannel, BufferRecycler

public class CompressedBlockChannelWriter
extends Object
implements BlockChannelWriter<MemorySegment>, BufferRecycler

Compressed block channel writer provides a scenario where MemorySegment must be maintained.

Nested Class Summary

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

FileIOChannel.Enumerator, FileIOChannel.ID

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

BufferRecycler.DummyBufferRecycler

Constructor Summary

Constructors

Constructor and Description
CompressedBlockChannelWriter(IOManager ioManager, FileIOChannel.ID channel, LinkedBlockingQueue<MemorySegment> blockQueue, BlockCompressionFactory codecFactory, int preferBlockSize, int segmentSize)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the channel.
void	closeAndDelete() Closes the channel and deletes the underlying file.
void	deleteChannel() Deletes the file underlying this I/O channel.
FileIOChannel.ID	getChannelID() Gets the channel ID of this I/O channel.
MemorySegment	getNextReturnedBlock() Gets the next memory segment that has been written and is available again.
FileChannel	getNioFileChannel()
LinkedBlockingQueue<MemorySegment>	getReturnQueue() Gets the queue in which the memory segments are queued after the asynchronous write is completed
long	getSize() Gets the size (in bytes) of the file underlying the channel.
boolean	isClosed() Checks whether the channel has been closed.
void	recycle(MemorySegment memorySegment) Recycles the MemorySegment to its original BufferPool instance.
void	writeBlock(MemorySegment block) Writes the given block.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressedBlockChannelWriter

public CompressedBlockChannelWriter(IOManager ioManager,
                                    FileIOChannel.ID channel,
                                    LinkedBlockingQueue<MemorySegment> blockQueue,
                                    BlockCompressionFactory codecFactory,
                                    int preferBlockSize,
                                    int segmentSize)
                             throws IOException

Throws:

IOException

Method Detail

writeBlock

public void writeBlock(MemorySegment block)
                throws IOException

Description copied from interface: BlockChannelWriterWithCallback

Writes the given block. The request may be executed synchronously, or asynchronously, depending on the implementation.

Specified by:

writeBlock in interface BlockChannelWriterWithCallback<MemorySegment>

Parameters:

block - The segment to be written (transferring ownership to this writer).

Throws:

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

getChannelID

public FileIOChannel.ID getChannelID()

Description copied from interface: FileIOChannel

Gets the channel ID of this I/O channel.

Specified by:

getChannelID in interface FileIOChannel

Returns:

The channel ID.

getSize

public long getSize()
             throws IOException

Description copied from interface: FileIOChannel

Gets the size (in bytes) of the file underlying the channel.

Specified by:

getSize in interface FileIOChannel

Throws:

IOException

isClosed

public boolean isClosed()

Description copied from interface: FileIOChannel

Checks whether the channel has been closed.

Specified by:

isClosed in interface FileIOChannel

Returns:

True if the channel has been closed, false otherwise.

close

public void close()
           throws IOException

Description copied from interface: FileIOChannel

Closes the channel. For asynchronous implementations, this method waits until all pending requests are handled. Even if an exception interrupts the closing, the underlying FileChannel is closed.

Specified by:

close in interface FileIOChannel

Throws:

IOException - Thrown, if an error occurred while waiting for pending requests.

deleteChannel

public void deleteChannel()

Description copied from interface: FileIOChannel

Deletes the file underlying this I/O channel.

Specified by:

deleteChannel in interface FileIOChannel

closeAndDelete

public void closeAndDelete()
                    throws IOException

Description copied from interface: FileIOChannel

Closes the channel and deletes the underlying file. For asynchronous implementations, this method waits until all pending requests are handled.

Specified by:

closeAndDelete in interface FileIOChannel

Throws:

IOException - Thrown, if an error occurred while waiting for pending requests.

getNioFileChannel

public FileChannel getNioFileChannel()

Specified by:

getNioFileChannel in interface FileIOChannel

recycle

public void recycle(MemorySegment memorySegment)

Description copied from interface: BufferRecycler

Recycles the MemorySegment to its original BufferPool instance.

Specified by:

recycle in interface BufferRecycler

Parameters:

memorySegment - The memory segment to be recycled.

getNextReturnedBlock

public MemorySegment getNextReturnedBlock()
                                   throws IOException

Description copied from interface: BlockChannelWriter

Gets the next memory segment that has been written and is available again. This method blocks until such a segment is available, or until an error occurs in the writer, or the writer is closed.

NOTE: If this method is invoked without any segment ever returning (for example, because the BlockChannelWriterWithCallback.writeBlock(T) method has not been invoked accordingly), the method may block forever.

Specified by:

getNextReturnedBlock in interface BlockChannelWriter<MemorySegment>

Returns:

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

Throws:

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

getReturnQueue

public LinkedBlockingQueue<MemorySegment> getReturnQueue()

Description copied from interface: BlockChannelWriter

Gets the queue in which the memory segments are queued after the asynchronous write is completed

Specified by:

getReturnQueue in interface BlockChannelWriter<MemorySegment>

Returns:

The queue with the written memory segments.