io.lacuna.bifurcan.durable.io

Class BufferedChannelInput

java.lang.Object

io.lacuna.bifurcan.durable.io.BufferedChannelInput

All Implemented Interfaces:

DurableInput, java.io.Closeable, java.io.DataInput, java.lang.AutoCloseable

public class BufferedChannelInput
extends java.lang.Object
implements DurableInput

An implementation of DurableInput atop BufferedChannel.

Nested Class Summary

Nested classes/interfaces inherited from interface io.lacuna.bifurcan.DurableInput

DurableInput.Bounds, DurableInput.Pool

Constructor Summary

Constructors

Constructor and Description
BufferedChannelInput(BufferedChannel channel)
BufferedChannelInput(BufferedChannel channel, long start, long end, java.lang.Runnable closeFn)

Method Summary

Modifier and Type	Method and Description
DurableInput.Bounds	bounds()
void	close() Closes the input, freeing any resources associated with it.
DurableInput	duplicate()
DurableInput.Pool	pool()
long	position()
int	read(java.nio.ByteBuffer dst) Copies as many byte as possible into dst, and returns the number of bytes.
byte	readByte() Reads and advances past the next int8 value.
char	readChar() Reads and advances past the next int16 value.
double	readDouble() Reads and advances past the next float64 value.
float	readFloat() Reads and advances past the next float32 value.
void	readFully(byte[] b, int off, int len) Copies bytes into b, starting at offset, throwing an EOFException if there are not len bytes available.
int	readInt() Reads and advances past the next int32 value.
long	readLong() Reads and advances past the next int64 value.
short	readShort() Reads and advances past the next int16 value.
long	remaining()
BufferedChannelInput	seek(long position) Updates the position of the input, and returns itself.
long	size()
int	skipBytes(int n) Advances the position by n bytes.
DurableInput	slice(long start, long end)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.DurableInput

asInputStream, from, hasRemaining, hexBytes, peekPrefix, readBoolean, readFully, readLine, readPrefix, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, readUVLQ, readVLQ, skipBlock, skipBytes, sliceBlock, sliceBytes, slicePrefixedBlock

Constructor Detail

BufferedChannelInput

public BufferedChannelInput(BufferedChannel channel)

BufferedChannelInput

public BufferedChannelInput(BufferedChannel channel,
                            long start,
                            long end,
                            java.lang.Runnable closeFn)

Method Detail

pool

public DurableInput.Pool pool()

Specified by:

pool in interface DurableInput

Returns:

a pool that can be used to provide future access to this input, potentially on another thread

slice

public DurableInput slice(long start,
                          long end)

Specified by:

slice in interface DurableInput

Returns:

an input representing the byte interval between [start, end)

close

public void close()

Description copied from interface: DurableInput

Closes the input, freeing any resources associated with it.

Specified by:

close in interface DurableInput

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

bounds

public DurableInput.Bounds bounds()

Specified by:

bounds in interface DurableInput

duplicate

public DurableInput duplicate()

Specified by:

duplicate in interface DurableInput

Returns:

an identical input, with the same position, but with an independently movable cursor

seek

public BufferedChannelInput seek(long position)

Description copied from interface: DurableInput

Updates the position of the input, and returns itself.

Specified by:

seek in interface DurableInput

size

public long size()

Specified by:

size in interface DurableInput

Returns:

the total number of available bytes

position

public long position()

Specified by:

position in interface DurableInput

Returns:

the position of the input

readFully

public void readFully(byte[] b,
                      int off,
                      int len)
               throws java.io.EOFException

Description copied from interface: DurableInput

Copies bytes into b, starting at offset, throwing an EOFException if there are not len bytes available.

Specified by:

readFully in interface DurableInput

Specified by:

readFully in interface java.io.DataInput

Throws:

java.io.EOFException

read

public int read(java.nio.ByteBuffer dst)

Description copied from interface: DurableInput

Copies as many byte as possible into dst, and returns the number of bytes.

Specified by:

read in interface DurableInput

remaining

public long remaining()

Specified by:

remaining in interface DurableInput

Returns:

the number of bytes between the end of the input and the current position

skipBytes

public int skipBytes(int n)

Description copied from interface: DurableInput

Advances the position by n bytes.

Specified by:

skipBytes in interface DurableInput

Specified by:

skipBytes in interface java.io.DataInput

readByte

public byte readByte()

Description copied from interface: DurableInput

Reads and advances past the next int8 value.

Specified by:

readByte in interface DurableInput

Specified by:

readByte in interface java.io.DataInput

readShort

public short readShort()

Description copied from interface: DurableInput

Reads and advances past the next int16 value.

Specified by:

readShort in interface DurableInput

Specified by:

readShort in interface java.io.DataInput

readChar

public char readChar()

Description copied from interface: DurableInput

Reads and advances past the next int16 value.

Specified by:

readChar in interface DurableInput

Specified by:

readChar in interface java.io.DataInput

readInt

public int readInt()

Description copied from interface: DurableInput

Reads and advances past the next int32 value.

Specified by:

readInt in interface DurableInput

Specified by:

readInt in interface java.io.DataInput

readLong

public long readLong()

Description copied from interface: DurableInput

Reads and advances past the next int64 value.

Specified by:

readLong in interface DurableInput

Specified by:

readLong in interface java.io.DataInput

readFloat

public float readFloat()

Description copied from interface: DurableInput

Reads and advances past the next float32 value.

Specified by:

readFloat in interface DurableInput

Specified by:

readFloat in interface java.io.DataInput

readDouble

public double readDouble()

Description copied from interface: DurableInput

Reads and advances past the next float64 value.

Specified by:

readDouble in interface DurableInput

Specified by:

readDouble in interface java.io.DataInput