Package io.deephaven.util.channel

Interface SeekableChannelsProvider

All Superinterfaces:

AutoCloseable, SafeCloseable

All Known Implementing Classes:

CachedChannelProvider, LocalFSChannelProvider

public interface SeekableChannelsProvider
extends SafeCloseable

Method Summary

Modifier and Type	Method	Description
static InputStream	channelPositionInputStream(SeekableChannelsProvider provider, SeekableByteChannel ch)	Wraps getInputStream(SeekableByteChannel) to ensure the channel's position is incremented the exact amount that has been consumed from the resulting input stream.
InputStream	getInputStream(SeekableByteChannel channel)	Creates an InputStream from the current position of channel; closing the resulting input stream does not close the channel.
default SeekableByteChannel	getReadChannel(@NotNull SeekableChannelContext channelContext, @NotNull String uriStr)
SeekableByteChannel	getReadChannel(@NotNull SeekableChannelContext channelContext, @NotNull URI uri)
default SeekableByteChannel	getWriteChannel(@NotNull String path, boolean append)
SeekableByteChannel	getWriteChannel(@NotNull Path path, boolean append)
boolean	isCompatibleWith(@NotNull SeekableChannelContext channelContext)	Check if the given context is compatible with this provider.
SeekableChannelContext	makeContext()	Create a new SeekableChannelContext object for creating read channels via this provider.
default SeekableChannelContext	makeSingleUseContext()	Create a new "single-use" SeekableChannelContext object for creating read channels via this provider.

Methods inherited from interface io.deephaven.util.SafeCloseable

close

Method Details

channelPositionInputStream

static InputStream channelPositionInputStream(SeekableChannelsProvider provider,
 SeekableByteChannel ch)
                                       throws IOException

Wraps getInputStream(SeekableByteChannel) to ensure the channel's position is incremented the exact amount that has been consumed from the resulting input stream. To remain valid, the caller must ensure that the resulting input stream isn't re-wrapped by any downstream code in a way that would adversely affect the position (such as re-wrapping the resulting input stream with buffering).

Equivalent to ChannelPositionInputStream.of(ch, provider.getInputStream(ch)).

Parameters:

provider - the provider

ch - the seekable channel

Returns:

the position-safe input stream

Throws:

IOException - if an IO exception occurs

See Also:

• ChannelPositionInputStream.of(SeekableByteChannel, InputStream)

makeContext

SeekableChannelContext makeContext()

Create a new SeekableChannelContext object for creating read channels via this provider.

makeSingleUseContext

default SeekableChannelContext makeSingleUseContext()

Create a new "single-use" SeekableChannelContext object for creating read channels via this provider. This is meant for contexts that have a short lifecycle and expect to read a small amount from a read channel.

isCompatibleWith

boolean isCompatibleWith(@NotNull
 @NotNull SeekableChannelContext channelContext)

Check if the given context is compatible with this provider. Useful to test if we can use provided context object for creating channels with this provider.

getReadChannel

default SeekableByteChannel getReadChannel(@NotNull
 @NotNull SeekableChannelContext channelContext,
 @NotNull
 @NotNull String uriStr)
                                    throws IOException

Throws:

IOException

getReadChannel

SeekableByteChannel getReadChannel(@NotNull
 @NotNull SeekableChannelContext channelContext,
 @NotNull
 @NotNull URI uri)
                            throws IOException

Throws:

IOException

getInputStream

InputStream getInputStream(SeekableByteChannel channel)
                    throws IOException

Creates an InputStream from the current position of channel; closing the resulting input stream does not close the channel. The InputStream will be buffered; either explicitly in the case where the implementation uses an unbuffered getReadChannel(SeekableChannelContext, URI), or implicitly when the implementation uses a buffered getReadChannel(SeekableChannelContext, URI). channel must have been created by this provider. The caller can't assume the position of channel after consuming the InputStream. For use-cases that require the channel's position to be incremented the exact amount the InputStream has been consumed, use channelPositionInputStream(SeekableChannelsProvider, SeekableByteChannel).

Parameters:

channel - the channel

Returns:

the input stream

Throws:

IOException - if an IO exception occurs

getWriteChannel

default SeekableByteChannel getWriteChannel(@NotNull
 @NotNull String path,
 boolean append)
                                     throws IOException

Throws:

IOException

getWriteChannel

SeekableByteChannel getWriteChannel(@NotNull
 @NotNull Path path,
 boolean append)
                             throws IOException

Throws:

IOException