alluxio.fuse.file

Interface FuseFileStream

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FuseFileInOrOutStream, FuseFileInStream, FuseFileOutStream, FusePositionReader, FusePositionReadOrOutStream

public interface FuseFileStream
extends AutoCloseable

This interface should be implemented by all fuse file streams.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream and releases the lock.
void	closeStream() Closes the stream without releasing the locking resource.
void	flush() Flushes the stream.
FileStatus	getFileStatus()
boolean	isClosed()
boolean	isReadOnly()
int	read(ByteBuffer buf, long size, long offset) Reads data from the stream.
void	releaseLock() Releases the lock resource the stream obtained.
void	truncate(long size) Truncates the file to the given size.
void	write(ByteBuffer buf, long size, long offset) Writes data to the stream.

Method Detail

read

int read(ByteBuffer buf,
         long size,
         long offset)

Reads data from the stream.

Parameters:

buf - the byte buffer to read data to

size - the size to read

offset - the offset of the target stream to begin reading

Returns:

the bytes read

write

void write(ByteBuffer buf,
           long size,
           long offset)

Writes data to the stream.

Parameters:

buf - the byte buffer to read data from and write to the stream

size - the size to write

offset - the offset to write

getFileStatus

FileStatus getFileStatus()

Returns:

file status

flush

void flush()

Flushes the stream.

truncate

void truncate(long size)

Truncates the file to the given size.

Parameters:

size - the truncate size

close

void close()

Closes the stream and releases the lock.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Returns:

if the stream is closed

isReadOnly

boolean isReadOnly()

Returns:

if this stream is for read only

releaseLock

void releaseLock()

Releases the lock resource the stream obtained.

closeStream

void closeStream()

Closes the stream without releasing the locking resource.