Package org.apache.cassandra.io.util

Class RebufferingInputStream

java.lang.Object

java.io.InputStream

org.apache.cassandra.io.util.DataInputPlus.DataInputStreamPlus

org.apache.cassandra.io.util.RebufferingInputStream

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable, DataInputPlus

Direct Known Subclasses:

AsyncStreamingInputPlus, ChecksummedDataInput, CompressedInputStream, DataInputBuffer, FileInputStreamPlus, MemoryInputStream, NIODataInputStream, RandomAccessReader, StreamCompressionInputStream

public abstract class RebufferingInputStream
extends DataInputPlus.DataInputStreamPlus
implements DataInputPlus, Closeable

Rough equivalent of BufferedInputStream and DataInputStream wrapping a ByteBuffer that can be refilled via rebuffer. Implementations provide this buffer from various channels (socket, file, memory, etc).

RebufferingInputStream is not thread safe.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.io.util.DataInputPlus

DataInputPlus.DataInputStreamPlus

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	buffer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RebufferingInputStream(ByteBuffer buffer)

Method Summary

Modifier and Type	Method	Description
int	read()
int	read(byte[] b, int off, int len)
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
void	readFully(ByteBuffer dst)	Equivalent to read(byte[], int, int), where offset is dst.position() and length is dst.remaining()
int	readInt()
String	readLine()
long	readLong()
protected long	readPrimitiveSlowly(int bytes)
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
long	readUnsignedVInt()	Think hard before opting for an unsigned encoding.
int	readUnsignedVInt32()	Read up to a 32-bit integer back.
String	readUTF()
long	readVInt()	Read a 64-bit integer back.
int	readVInt32()	Read up to a 32-bit integer back.
protected abstract void	reBuffer()	Implementations must implement this method to refill the buffer.
int	skipBytes(int n)	Always skips the requested number of bytes, unless EOF is reached

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.cassandra.io.util.DataInputPlus

skipBytesFully

Field Details

buffer

protected ByteBuffer buffer

Constructor Details

RebufferingInputStream

protected RebufferingInputStream(ByteBuffer buffer)

Method Details

reBuffer

protected abstract void reBuffer()
                          throws IOException

Implementations must implement this method to refill the buffer. They can expect the buffer to be empty when this method is invoked.

Throws:

IOException

readFully

public void readFully(byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] b,
 int off,
 int len)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

readFully

public void readFully(ByteBuffer dst)
               throws IOException

Equivalent to read(byte[], int, int), where offset is dst.position() and length is dst.remaining()

Throws:

IOException

readPrimitiveSlowly

@DontInline
protected long readPrimitiveSlowly(int bytes)
                            throws IOException

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Description copied from interface: DataInputPlus

Always skips the requested number of bytes, unless EOF is reached

Specified by:

skipBytes in interface DataInput

Specified by:

skipBytes in interface DataInputPlus

Parameters:

n - number of bytes to skip

Returns:

number of bytes skipped

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readVInt

public long readVInt()
              throws IOException

Description copied from interface: DataInputPlus

Read a 64-bit integer back. This method assumes it was originally written using DataOutputPlus.writeVInt(long) or similar that zigzag encodes the vint.

Specified by:

readVInt in interface DataInputPlus

Throws:

IOException

readVInt32

public int readVInt32()
               throws IOException

Description copied from interface: DataInputPlus

Read up to a 32-bit integer back. This method assumes the integer was originally written using DataOutputPlus.writeVInt32(int) or similar that zigzag encodes the vint.

Specified by:

readVInt32 in interface DataInputPlus

Throws:

IOException

readUnsignedVInt

public long readUnsignedVInt()
                      throws IOException

Description copied from interface: DataInputPlus

Think hard before opting for an unsigned encoding. Is this going to bite someone because some day they might need to pass in a sentinel value using negative numbers? Is the risk worth it to save a few bytes? Signed, not a fan of unsigned values in protocols and formats

Specified by:

readUnsignedVInt in interface DataInputPlus

Throws:

IOException

readUnsignedVInt32

public int readUnsignedVInt32()
                       throws IOException

Description copied from interface: DataInputPlus

Read up to a 32-bit integer back. This method assumes the original integer was written using DataOutputPlus.writeUnsignedVInt32(int) or similar that doesn't zigzag encodes the vint.

Specified by:

readUnsignedVInt32 in interface DataInputPlus

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException