com.alipay.sofa.jraft.storage.io

Interface FileReader

All Known Implementing Classes:

LocalDirReader, SnapshotFileReader

public interface FileReader

Read data from a file, all the method should be thread-safe.

Author:

boyan (boyan@alibaba-inc.com) 2018-Mar-13 11:48:34 AM

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOF

Method Summary

Modifier and Type	Method and Description
String	getPath() Get the file path.
int	readFile(ByteBufferCollector buf, String fileName, long offset, long maxCount) Read file into buf starts from offset at most maxCount.

Field Detail

EOF

static final int EOF

See Also:

Constant Field Values

Method Detail

getPath

String getPath()

Get the file path.

Returns:

path of the file

readFile

int readFile(ByteBufferCollector buf,
             String fileName,
             long offset,
             long maxCount)
      throws IOException,
             RetryAgainException

Read file into buf starts from offset at most maxCount.

Parameters:

buf - read bytes into this buf

fileName - file name

offset - the offset of file

maxCount - max read bytes

Returns:

-1 if reaches end, else return read count.

Throws:

IOException - if some I/O error occurs

RetryAgainException - if it's not allowed to read partly or it's allowed but throughput is throttled to 0, try again.