Package io.deephaven.engine.util.file

Class TrackedSeekableByteChannel

java.lang.Object

io.deephaven.engine.util.file.FileHandleAccessor

io.deephaven.engine.util.file.TrackedSeekableByteChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, SeekableByteChannel, WritableByteChannel

public final class TrackedSeekableByteChannel
extends FileHandleAccessor
implements SeekableByteChannel

SeekableByteChannel wrapper around FileHandle with support for re-opening the handle in case it has been closed asynchronously.

Note the applications must be sure to use read(ByteBuffer), write(ByteBuffer), and position(long) in a thread safe manner, using external synchronization or other means.

Field Summary

Fields inherited from class io.deephaven.engine.util.file.FileHandleAccessor

file, fileHandle

Constructor Summary

Constructors

Constructor	Description
TrackedSeekableByteChannel(FileHandleFactory.FileToHandleFunction fileHandleCreator, @NotNull File file)	Make a channel for a "local" file.

Method Summary

Modifier and Type	Method	Description
final void	close()
final boolean	isOpen()
final long	position()
final SeekableByteChannel	position(long newPosition)
final int	read(@NotNull ByteBuffer destination)
final long	size()
final SeekableByteChannel	truncate(long size)
final int	write(@NotNull ByteBuffer source)

Methods inherited from class io.deephaven.engine.util.file.FileHandleAccessor

refreshFileHandle, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TrackedSeekableByteChannel

public TrackedSeekableByteChannel(@NotNull
 FileHandleFactory.FileToHandleFunction fileHandleCreator,
 @NotNull
 @NotNull File file)
                           throws IOException

Make a channel for a "local" file.

Parameters:

fileHandleCreator - The function used to make file handles

file - The abstract path name to wrap access to

Throws:

IOException

Method Details

read

public final int read(@NotNull
 @NotNull ByteBuffer destination)
               throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Throws:

IOException

write

public final int write(@NotNull
 @NotNull ByteBuffer source)
                throws IOException

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Throws:

IOException

position

public final long position()
                    throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

position

public final SeekableByteChannel position(long newPosition)
                                   throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

size

public final long size()
                throws IOException

Specified by:

size in interface SeekableByteChannel

Throws:

IOException

truncate

public final SeekableByteChannel truncate(long size)
                                   throws IOException

Specified by:

truncate in interface SeekableByteChannel

Throws:

IOException

isOpen

public final boolean isOpen()

Specified by:

isOpen in interface Channel

close

public final void close()
                 throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException