Package org.apache.druid.frame.channel

Class ReadableFileFrameChannel

java.lang.Object

org.apache.druid.frame.channel.ReadableFileFrameChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ReadableFrameChannel

public class ReadableFileFrameChannel
extends Object
implements ReadableFrameChannel

Channel backed by a FrameFile. This class is backed by an actual file that is on disk and memory-mapped. For situations where a stream in frame file format is being read over the network, use ReadableByteChunksFrameChannel or FrameFileHttpResponseHandler instead.

Constructor Summary

Constructors

Constructor	Description
ReadableFileFrameChannel(FrameFile frameFile)
ReadableFileFrameChannel(FrameFile frameFile, int startFrame, int endFrame)

Method Summary

Modifier and Type	Method	Description
boolean	canRead()	Returns whether this channel has a frame or error condition currently available.
void	close()	Releases any resources associated with this readable channel.
boolean	isEntireFile()	Returns whether this channel represents the entire underlying FrameFile.
boolean	isFinished()	Returns whether this channel is finished.
FrameFile	newFrameFileReference()	Returns a new reference to the FrameFile that this channel is reading from.
Frame	read()	Returns the next available frame from this channel.
com.google.common.util.concurrent.ListenableFuture<?>	readabilityFuture()	Returns a future that will resolve when either ReadableFrameChannel.isFinished() or ReadableFrameChannel.canRead() would return true.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadableFileFrameChannel

public ReadableFileFrameChannel(FrameFile frameFile,
 int startFrame,
 int endFrame)

ReadableFileFrameChannel

public ReadableFileFrameChannel(FrameFile frameFile)

Method Details

isFinished

public boolean isFinished()

Description copied from interface: ReadableFrameChannel

Returns whether this channel is finished. Finished channels will not generate any further frames or errors. Generally, once you discover that a channel is finished, you should call ReadableFrameChannel.close() and then discard it. Note that it is possible for a channel to be unfinished and also have no available frames or errors. This happens when it is not in a ready-for-reading state. See ReadableFrameChannel.readabilityFuture() for details.

Specified by:

isFinished in interface ReadableFrameChannel

canRead

public boolean canRead()

Description copied from interface: ReadableFrameChannel

Returns whether this channel has a frame or error condition currently available. If this method returns true, then you can call ReadableFrameChannel.read() to retrieve the frame or error. Note that it is possible for a channel to be unfinished and also have no available frames or errors. This happens when it is not in a ready-for-reading state. See ReadableFrameChannel.readabilityFuture() for details.

Specified by:

canRead in interface ReadableFrameChannel

read

public Frame read()

Description copied from interface: ReadableFrameChannel

Returns the next available frame from this channel. Before calling this method, you should check ReadableFrameChannel.canRead() to ensure there is a frame or error available.

Specified by:

read in interface ReadableFrameChannel

readabilityFuture

public com.google.common.util.concurrent.ListenableFuture<?> readabilityFuture()

Description copied from interface: ReadableFrameChannel

Returns a future that will resolve when either ReadableFrameChannel.isFinished() or ReadableFrameChannel.canRead() would return true. The future will never resolve to an exception. If something exceptional has happened, the exception can be retrieved from ReadableFrameChannel.read().

Specified by:

readabilityFuture in interface ReadableFrameChannel

close

public void close()

Description copied from interface: ReadableFrameChannel

Releases any resources associated with this readable channel. After calling this, you should not call any other methods on the channel.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ReadableFrameChannel

isEntireFile

public boolean isEntireFile()

Returns whether this channel represents the entire underlying FrameFile.

newFrameFileReference

public FrameFile newFrameFileReference()

Returns a new reference to the FrameFile that this channel is reading from. Callers should close this reference when done reading.