io.openmessaging.storage.dledger.store.file

Class DefaultMmapFile

java.lang.Object

io.openmessaging.storage.dledger.store.file.ReferenceResource

io.openmessaging.storage.dledger.store.file.DefaultMmapFile

All Implemented Interfaces:

MmapFile

public class DefaultMmapFile
extends ReferenceResource
implements MmapFile

Field Summary

Fields

Modifier and Type	Field and Description
protected File	file
protected static org.slf4j.Logger	logger
static int	OS_PAGE_SIZE

Fields inherited from class io.openmessaging.storage.dledger.store.file.ReferenceResource

available, cleanupOver, refCount

Constructor Summary

Constructors

Constructor and Description
DefaultMmapFile(String fileName, int fileSize)

Method Summary

Modifier and Type	Method and Description
boolean	appendMessage(byte[] data) Appends a raw message data represents by a byte array to the current MappedFile.
boolean	appendMessage(byte[] data, int offset, int length) Content of data from offset to offset + length will be written to file.
static void	clean(ByteBuffer buffer)
boolean	cleanup(long currentRef)
int	commit(int commitLeastPages) Flushes the data in the secondary cache to page cache or disk immediately.
boolean	destroy(long intervalForcibly) Destroys the file and delete it from the file system.
static void	ensureDirOK(String dirName)
int	flush(int flushLeastPages) Flushes the data in cache to disk immediately.
boolean	getData(int pos, int size, ByteBuffer byteBuffer) get the data from file channel
FileChannel	getFileChannel() Returns the FileChannel behind the MappedFile.
long	getFileFromOffset() Returns the global offset of the current {code MappedFile}, it's a long value of the file name.
String	getFileName() Returns the file name of the MappedFile.
int	getFileSize() Returns the file size of the MappedFile.
int	getFlushedPosition() Returns the flushed position of this mapped file.
long	getLastModifiedTimestamp() Returns the last modified timestamp of the file.
MappedByteBuffer	getMappedByteBuffer() Returns the mapped byte buffer behind the mapped file.
int	getReadPosition() Returns the current max readable position of this mapped file.
int	getStartPosition() Returns the start position of this mapped file, before which the data is truncated
static int	getTotalMappedFiles()
static long	getTotalMappedVirtualMemory()
int	getWrotePosition() Returns the wrote position of this mapped file.
boolean	isFirstCreateInQueue() Returns true if the current file is first mapped file of some consume queue.
boolean	isFull() Returns true if this MappedFile is full and no new messages can be added.
SelectMmapBufferResult	selectMappedBuffer(int pos) Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.
SelectMmapBufferResult	selectMappedBuffer(int pos, int size) Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.
void	setCommittedPosition(int pos) Sets the committed position of this mapped file.
void	setFirstCreateInQueue(boolean firstCreateInQueue) Sets the flag whether the current file is first mapped file of some consume queue.
void	setFlushedPosition(int pos) Sets the flushed position of this mapped file.
void	setStartPosition(int startPosition) Sets the start position of this mapped file.
void	setWrotePosition(int pos) Sets the wrote position of this mapped file.
ByteBuffer	sliceByteBuffer() Returns a slice of the mapped byte buffer behind the mapped file.
String	toString()

Methods inherited from class io.openmessaging.storage.dledger.store.file.ReferenceResource

getRefCount, hold, isAvailable, isCleanupOver, release, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openmessaging.storage.dledger.store.file.MmapFile

hold, isAvailable, release, shutdown

Field Detail

OS_PAGE_SIZE

public static final int OS_PAGE_SIZE

See Also:

Constant Field Values

logger

protected static org.slf4j.Logger logger

file

protected File file

Constructor Detail

DefaultMmapFile

public DefaultMmapFile(String fileName,
                       int fileSize)
                throws IOException

Throws:

IOException

Method Detail

getTotalMappedFiles

public static int getTotalMappedFiles()

getTotalMappedVirtualMemory

public static long getTotalMappedVirtualMemory()

ensureDirOK

public static void ensureDirOK(String dirName)

clean

public static void clean(ByteBuffer buffer)

getLastModifiedTimestamp

public long getLastModifiedTimestamp()

Description copied from interface: MmapFile

Returns the last modified timestamp of the file.

Specified by:

getLastModifiedTimestamp in interface MmapFile

Returns:

the last modified timestamp

getFileSize

public int getFileSize()

Description copied from interface: MmapFile

Returns the file size of the MappedFile.

Specified by:

getFileSize in interface MmapFile

Returns:

the file size

getFileChannel

public FileChannel getFileChannel()

Description copied from interface: MmapFile

Returns the FileChannel behind the MappedFile.

Specified by:

getFileChannel in interface MmapFile

Returns:

the file channel

getFileFromOffset

public long getFileFromOffset()

Description copied from interface: MmapFile

Returns the global offset of the current {code MappedFile}, it's a long value of the file name.

Specified by:

getFileFromOffset in interface MmapFile

Returns:

the offset of this file

appendMessage

public boolean appendMessage(byte[] data)

Description copied from interface: MmapFile

Appends a raw message data represents by a byte array to the current MappedFile.

Specified by:

appendMessage in interface MmapFile

Parameters:

data - the byte array to append

Returns:

true if success; false otherwise.

appendMessage

public boolean appendMessage(byte[] data,
                             int offset,
                             int length)

Content of data from offset to offset + length will be written to file.

Specified by:

appendMessage in interface MmapFile

Parameters:

offset - The offset of the subarray to be used.

length - The length of the subarray to be used.

data - the byte array to append

Returns:

true if success; false otherwise.

flush

public int flush(int flushLeastPages)

Description copied from interface: MmapFile

Flushes the data in cache to disk immediately.

Specified by:

flush in interface MmapFile

Parameters:

flushLeastPages - the least pages to flush

Returns:

The current flushed position

commit

public int commit(int commitLeastPages)

Description copied from interface: MmapFile

Flushes the data in the secondary cache to page cache or disk immediately.

Specified by:

commit in interface MmapFile

Parameters:

commitLeastPages - the least pages to commit

Returns:

the committed position after the method call

getFlushedPosition

public int getFlushedPosition()

Description copied from interface: MmapFile

Returns the flushed position of this mapped file.

Specified by:

getFlushedPosition in interface MmapFile

Returns:

the flushed posotion

setFlushedPosition

public void setFlushedPosition(int pos)

Description copied from interface: MmapFile

Sets the flushed position of this mapped file.

Specified by:

setFlushedPosition in interface MmapFile

Parameters:

pos - the specific flushed position

getStartPosition

public int getStartPosition()

Description copied from interface: MmapFile

Returns the start position of this mapped file, before which the data is truncated

Specified by:

getStartPosition in interface MmapFile

Returns:

the wrote position

setStartPosition

public void setStartPosition(int startPosition)

Description copied from interface: MmapFile

Sets the start position of this mapped file.

Specified by:

setStartPosition in interface MmapFile

Parameters:

startPosition - the specific start position

isFull

public boolean isFull()

Description copied from interface: MmapFile

Returns true if this MappedFile is full and no new messages can be added.

Specified by:

isFull in interface MmapFile

Returns:

true if the file is full

selectMappedBuffer

public SelectMmapBufferResult selectMappedBuffer(int pos,
                                                 int size)

Description copied from interface: MmapFile

Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.

Specified by:

selectMappedBuffer in interface MmapFile

Parameters:

pos - the given position

size - the size of the returned sub-region

Returns:

a SelectMappedBufferResult instance contains the selected slice

selectMappedBuffer

public SelectMmapBufferResult selectMappedBuffer(int pos)

Description copied from interface: MmapFile

Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.

Specified by:

selectMappedBuffer in interface MmapFile

Parameters:

pos - the given position

Returns:

a SelectMappedBufferResult instance contains the selected slice

getData

public boolean getData(int pos,
                       int size,
                       ByteBuffer byteBuffer)

Description copied from interface: MmapFile

get the data from file channel

Specified by:

getData in interface MmapFile

Returns:

cleanup

public boolean cleanup(long currentRef)

Specified by:

cleanup in class ReferenceResource

destroy

public boolean destroy(long intervalForcibly)

Description copied from interface: MmapFile

Destroys the file and delete it from the file system.

Specified by:

destroy in interface MmapFile

Parameters:

intervalForcibly - If true then this method will destroy the file forcibly and ignore the reference

Returns:

true if success; false otherwise.

getWrotePosition

public int getWrotePosition()

Description copied from interface: MmapFile

Returns the wrote position of this mapped file.

Specified by:

getWrotePosition in interface MmapFile

Returns:

the wrote position

setWrotePosition

public void setWrotePosition(int pos)

Description copied from interface: MmapFile

Sets the wrote position of this mapped file.

Specified by:

setWrotePosition in interface MmapFile

Parameters:

pos - the specific wrote position

getReadPosition

public int getReadPosition()

Description copied from interface: MmapFile

Returns the current max readable position of this mapped file.

Specified by:

getReadPosition in interface MmapFile

Returns:

The max position which have valid data

setCommittedPosition

public void setCommittedPosition(int pos)

Description copied from interface: MmapFile

Sets the committed position of this mapped file.

Specified by:

setCommittedPosition in interface MmapFile

Parameters:

pos - the specific committed position

getFileName

public String getFileName()

Description copied from interface: MmapFile

Returns the file name of the MappedFile.

Specified by:

getFileName in interface MmapFile

Returns:

the file name

getMappedByteBuffer

public MappedByteBuffer getMappedByteBuffer()

Description copied from interface: MmapFile

Returns the mapped byte buffer behind the mapped file.

Specified by:

getMappedByteBuffer in interface MmapFile

Returns:

the mapped byte buffer

sliceByteBuffer

public ByteBuffer sliceByteBuffer()

Description copied from interface: MmapFile

Returns a slice of the mapped byte buffer behind the mapped file.

Specified by:

sliceByteBuffer in interface MmapFile

Returns:

the slice of the mapped byte buffer

isFirstCreateInQueue

public boolean isFirstCreateInQueue()

Description copied from interface: MmapFile

Returns true if the current file is first mapped file of some consume queue.

Specified by:

isFirstCreateInQueue in interface MmapFile

Returns:

true or false

setFirstCreateInQueue

public void setFirstCreateInQueue(boolean firstCreateInQueue)

Description copied from interface: MmapFile

Sets the flag whether the current file is first mapped file of some consume queue.

Specified by:

setFirstCreateInQueue in interface MmapFile

Parameters:

firstCreateInQueue - true or false

toString

public String toString()

Overrides:

toString in class Object