org.apache.cassandra.hints

Class ChecksummedDataInput

java.lang.Object

java.io.InputStream

org.apache.cassandra.io.util.RebufferingInputStream

org.apache.cassandra.io.util.RandomAccessReader

org.apache.cassandra.io.util.RandomAccessReader.RandomAccessReaderWithOwnChannel

org.apache.cassandra.hints.ChecksummedDataInput

All Implemented Interfaces:

java.io.Closeable, java.io.DataInput, java.lang.AutoCloseable, DataInputPlus, FileDataInput, RewindableDataInput

Direct Known Subclasses:

CompressedChecksummedDataInput

public class ChecksummedDataInput
extends RandomAccessReader.RandomAccessReaderWithOwnChannel

A RandomAccessReader wrapper that calculates the CRC in place. Useful for HintsReader, for example, where we must verify the CRC, yet don't want to allocate an extra byte array just that purpose. The CRC can be embedded in the input stream and checked via checkCrc(). In addition to calculating the CRC, it allows to enforce a maximum known size. This is needed so that Mutation.MutationSerializer doesn't blow up the heap when deserializing a corrupted sequence by reading a huge corrupted length of bytes via ByteBufferUtil.readWithLength(java.io.DataInput).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChecksummedDataInput.Builder

Nested classes/interfaces inherited from class org.apache.cassandra.io.util.RandomAccessReader

RandomAccessReader.BufferedRandomAccessFileMark, RandomAccessReader.RandomAccessReaderWithOwnChannel

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

DataInputPlus.DataInputStreamPlus

Field Summary

Fields inherited from class org.apache.cassandra.io.util.RandomAccessReader

bufferOffset, bufferSize, bufferType, channel, DEFAULT_BUFFER_SIZE, limiter, markedPointer, MAX_BUFFER_SIZE, regions

Fields inherited from class org.apache.cassandra.io.util.RebufferingInputStream

buffer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChecksummedDataInput(ChecksummedDataInput.Builder builder)

Method Summary

Modifier and Type	Method and Description
long	bytesPastLimit()
boolean	checkCrc()
void	checkLimit(int length)
InputPosition	getSeekPosition() Return a seekable representation of the current position.
protected long	getSourcePosition() Returns the position in the source file, which is different for getPosition() for compressed/encrypted files and may be imprecise.
void	limit(long newLimit)
static ChecksummedDataInput	open(java.io.File file)
int	read(byte[] b, int off, int len)
void	readFully(byte[] b)
void	reBuffer() Read data from file starting from current currentOffset to populate buffer.
void	resetCrc()
void	resetLimit()
void	seek(InputPosition pos)
void	tryUncacheRead()

Methods inherited from class org.apache.cassandra.io.util.RandomAccessReader.RandomAccessReaderWithOwnChannel

close

Methods inherited from class org.apache.cassandra.io.util.RandomAccessReader

allocateBuffer, available, bytesPastMark, bytesPastMark, bytesRemaining, current, getChannel, getFilePointer, getPath, getPosition, isEOF, length, mark, markSupported, open, readLine, reBufferMmap, reBufferStandard, releaseBuffer, reset, reset, seek, toString

Methods inherited from class org.apache.cassandra.io.util.RebufferingInputStream

read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readInt, readLong, readPrimitiveSlowly, readShort, readUnsignedByte, readUnsignedShort, readUnsignedVInt, readUTF, readVInt, skipBytes

Methods inherited from class java.io.InputStream

mark, read, skip

Methods inherited from class java.lang.Object

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

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

readUnsignedVInt, readVInt, skipBytes, skipBytesFully

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readInt, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF

Constructor Detail

ChecksummedDataInput

protected ChecksummedDataInput(ChecksummedDataInput.Builder builder)

Method Detail

open

public static ChecksummedDataInput open(java.io.File file)

getSeekPosition

public InputPosition getSeekPosition()

Return a seekable representation of the current position. For compressed files this is chunk position in file and offset within chunk.

seek

public void seek(InputPosition pos)

resetCrc

public void resetCrc()

limit

public void limit(long newLimit)

getSourcePosition

protected long getSourcePosition()

Returns the position in the source file, which is different for getPosition() for compressed/encrypted files and may be imprecise.

resetLimit

public void resetLimit()

checkLimit

public void checkLimit(int length)
                throws java.io.IOException

Throws:

java.io.IOException

bytesPastLimit

public long bytesPastLimit()

checkCrc

public boolean checkCrc()
                 throws java.io.IOException

Throws:

java.io.IOException

readFully

public void readFully(byte[] b)
               throws java.io.IOException

Specified by:

readFully in interface java.io.DataInput

Overrides:

readFully in class RebufferingInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class RebufferingInputStream

Throws:

java.io.IOException

reBuffer

public void reBuffer()

Description copied from class: RandomAccessReader

Read data from file starting from current currentOffset to populate buffer.

Overrides:

reBuffer in class RandomAccessReader

tryUncacheRead

public void tryUncacheRead()