Package io.deephaven.util.channel

Interface SeekableChannelContext

All Superinterfaces:

AutoCloseable, SafeCloseable

public interface SeekableChannelContext
extends SafeCloseable

Context object for reading and writing to channels created by SeekableChannelsProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SeekableChannelContext.ContextHolder

Field Summary

Fields

Modifier and Type	Field	Description
static final SeekableChannelContext	NULL

Method Summary

Modifier and Type	Method	Description
default void	close()	Release any resources associated with this context.
static SeekableChannelContext.ContextHolder	ensureContext(SeekableChannelsProvider provider, SeekableChannelContext context)	A pattern that allows callers to ensure a valid context has been created for provider.

Field Details

NULL

static final SeekableChannelContext NULL

Method Details

ensureContext

static SeekableChannelContext.ContextHolder ensureContext(SeekableChannelsProvider provider,
 SeekableChannelContext context)

A pattern that allows callers to ensure a valid context has been created for provider. In the case where the given context is compatible with provider, a no-op holder around that context will be returned. Otherwise, a holder with a new SeekableChannelsProvider.makeSingleUseContext() will be returned. The returned holder should ideally be used in a try-with-resources construction.

Parameters:

provider - the provider

context - the context

Returns:

the context holder

close

default void close()

Release any resources associated with this context. The context should not be used afterward.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable