DefaultMmapFile (openmessaging-dledger 0.1 API)

java.lang.Object
- io.openmessaging.storage.dledger.store.file.ReferenceResource
- - io.openmessaging.storage.dledger.store.file.DefaultMmapFile

所有已实现的接口:: MmapFile

public class DefaultMmapFile
extends ReferenceResource
implements MmapFile

字段概要

字段
限定符和类型字段和说明

protected java.io.File file

protected static org.slf4j.Logger logger

static int OS_PAGE_SIZE
- 从类继承的字段 io.openmessaging.storage.dledger.store.file.ReferenceResource
  available, cleanupOver, refCount

字段
限定符和类型	字段和说明
`protected java.io.File`	`file`
`protected static org.slf4j.Logger`	`logger`
`static int`	`OS_PAGE_SIZE`

构造器概要

构造器
构造器和说明

DefaultMmapFile(java.lang.String fileName, int fileSize)

构造器
构造器和说明
`DefaultMmapFile(java.lang.String fileName, int fileSize)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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 wrote to file.
`static void`	`clean(java.nio.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(java.lang.String dirName)`
`int`	`flush(int flushLeastPages)` Flushes the data in cache to disk immediately.
`boolean`	`getData(int pos, int size, java.nio.ByteBuffer byteBuffer)` get the data from file channel
`java.nio.channels.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.
`java.lang.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.
`java.nio.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.
`java.nio.ByteBuffer`	`sliceByteBuffer()` Returns a slice of the mapped byte buffer behind the mapped file.
`java.lang.String`	`toString()`

从类继承的方法 io.openmessaging.storage.dledger.store.file.ReferenceResource
getRefCount, hold, isAvailable, isCleanupOver, release, shutdown

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.openmessaging.storage.dledger.store.file.MmapFile
hold, isAvailable, release, shutdown

- 字段详细资料
  - OS_PAGE_SIZE
```
public static final int OS_PAGE_SIZE
```
    另请参阅:
    
    常量字段值
  - logger
```
protected static org.slf4j.Logger logger
```
  - file
```
protected java.io.File file
```
- 构造器详细资料
  - DefaultMmapFile
```
public DefaultMmapFile(java.lang.String fileName,
                       int fileSize)
                throws java.io.IOException
```
    抛出:
    
    java.io.IOException
- 方法详细资料
  - getTotalMappedFiles
```
public static int getTotalMappedFiles()
```
  - getTotalMappedVirtualMemory
```
public static long getTotalMappedVirtualMemory()
```
  - ensureDirOK
```
public static void ensureDirOK(java.lang.String dirName)
```
  - clean
```
public static void clean(java.nio.ByteBuffer buffer)
```
  - getLastModifiedTimestamp
```
public long getLastModifiedTimestamp()
```
    从接口复制的说明: MmapFile
    
    Returns the last modified timestamp of the file.
    
    指定者:
    
    getLastModifiedTimestamp 在接口中 MmapFile
    
    返回:
    
    the last modified timestamp
  - getFileSize
```
public int getFileSize()
```
    从接口复制的说明: MmapFile
    
    Returns the file size of the MappedFile.
    
    指定者:
    
    getFileSize 在接口中 MmapFile
    
    返回:
    
    the file size
  - getFileChannel
```
public java.nio.channels.FileChannel getFileChannel()
```
    从接口复制的说明: MmapFile
    
    Returns the FileChannel behind the MappedFile.
    
    指定者:
    
    getFileChannel 在接口中 MmapFile
    
    返回:
    
    the file channel
  - getFileFromOffset
```
public long getFileFromOffset()
```
    从接口复制的说明: MmapFile
    
    Returns the global offset of the current {code MappedFile}, it's a long value of the file name.
    
    指定者:
    
    getFileFromOffset 在接口中 MmapFile
    
    返回:
    
    the offset of this file
  - appendMessage
```
public boolean appendMessage(byte[] data)
```
    从接口复制的说明: MmapFile
    
    Appends a raw message data represents by a byte array to the current MappedFile.
    
    指定者:
    
    appendMessage 在接口中 MmapFile
    
    参数:
    
    data - the byte array to append
    
    返回:
    
    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 wrote to file.
    
    指定者:
    
    appendMessage 在接口中 MmapFile
    
    参数:
    
    offset - The offset of the subarray to be used.
    
    length - The length of the subarray to be used.
    
    data - the byte array to append
    
    返回:
    
    true if success; false otherwise.
  - flush
```
public int flush(int flushLeastPages)
```
    从接口复制的说明: MmapFile
    
    Flushes the data in cache to disk immediately.
    
    指定者:
    
    flush 在接口中 MmapFile
    
    参数:
    
    flushLeastPages - the least pages to flush
    
    返回:
    
    The current flushed position
  - commit
```
public int commit(int commitLeastPages)
```
    从接口复制的说明: MmapFile
    
    Flushes the data in the secondary cache to page cache or disk immediately.
    
    指定者:
    
    commit 在接口中 MmapFile
    
    参数:
    
    commitLeastPages - the least pages to commit
    
    返回:
    
    the committed position after the method call
  - getFlushedPosition
```
public int getFlushedPosition()
```
    从接口复制的说明: MmapFile
    
    Returns the flushed position of this mapped file.
    
    指定者:
    
    getFlushedPosition 在接口中 MmapFile
    
    返回:
    
    the flushed posotion
  - setFlushedPosition
```
public void setFlushedPosition(int pos)
```
    从接口复制的说明: MmapFile
    
    Sets the flushed position of this mapped file.
    
    指定者:
    
    setFlushedPosition 在接口中 MmapFile
    
    参数:
    
    pos - the specific flushed position
  - getStartPosition
```
public int getStartPosition()
```
    从接口复制的说明: MmapFile
    
    Returns the start position of this mapped file, before which the data is truncated
    
    指定者:
    
    getStartPosition 在接口中 MmapFile
    
    返回:
    
    the wrote position
  - setStartPosition
```
public void setStartPosition(int startPosition)
```
    从接口复制的说明: MmapFile
    
    Sets the start position of this mapped file.
    
    指定者:
    
    setStartPosition 在接口中 MmapFile
    
    参数:
    
    startPosition - the specific start position
  - isFull
```
public boolean isFull()
```
    从接口复制的说明: MmapFile
    
    Returns true if this MappedFile is full and no new messages can be added.
    
    指定者:
    
    isFull 在接口中 MmapFile
    
    返回:
    
    true if the file is full
  - selectMappedBuffer
```
public SelectMmapBufferResult selectMappedBuffer(int pos,
                                                 int size)
```
    从接口复制的说明: MmapFile
    
    Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.
    
    指定者:
    
    selectMappedBuffer 在接口中 MmapFile
    
    参数:
    
    pos - the given position
    
    size - the size of the returned sub-region
    
    返回:
    
    a SelectMappedBufferResult instance contains the selected slice
  - selectMappedBuffer
```
public SelectMmapBufferResult selectMappedBuffer(int pos)
```
    从接口复制的说明: MmapFile
    
    Selects a slice of the mapped byte buffer's sub-region behind the mapped file, starting at the given position.
    
    指定者:
    
    selectMappedBuffer 在接口中 MmapFile
    
    参数:
    
    pos - the given position
    
    返回:
    
    a SelectMappedBufferResult instance contains the selected slice
  - getData
```
public boolean getData(int pos,
                       int size,
                       java.nio.ByteBuffer byteBuffer)
```
    从接口复制的说明: MmapFile
    
    get the data from file channel
    
    指定者:
    
    getData 在接口中 MmapFile
    
    返回:
  - cleanup
```
public boolean cleanup(long currentRef)
```
    指定者:
    
    cleanup 在类中 ReferenceResource
  - destroy
```
public boolean destroy(long intervalForcibly)
```
    从接口复制的说明: MmapFile
    
    Destroys the file and delete it from the file system.
    
    指定者:
    
    destroy 在接口中 MmapFile
    
    参数:
    
    intervalForcibly - If true then this method will destroy the file forcibly and ignore the reference
    
    返回:
    
    true if success; false otherwise.
  - getWrotePosition
```
public int getWrotePosition()
```
    从接口复制的说明: MmapFile
    
    Returns the wrote position of this mapped file.
    
    指定者:
    
    getWrotePosition 在接口中 MmapFile
    
    返回:
    
    the wrote position
  - setWrotePosition
```
public void setWrotePosition(int pos)
```
    从接口复制的说明: MmapFile
    
    Sets the wrote position of this mapped file.
    
    指定者:
    
    setWrotePosition 在接口中 MmapFile
    
    参数:
    
    pos - the specific wrote position
  - getReadPosition
```
public int getReadPosition()
```
    从接口复制的说明: MmapFile
    
    Returns the current max readable position of this mapped file.
    
    指定者:
    
    getReadPosition 在接口中 MmapFile
    
    返回:
    
    The max position which have valid data
  - setCommittedPosition
```
public void setCommittedPosition(int pos)
```
    从接口复制的说明: MmapFile
    
    Sets the committed position of this mapped file.
    
    指定者:
    
    setCommittedPosition 在接口中 MmapFile
    
    参数:
    
    pos - the specific committed position
  - getFileName
```
public java.lang.String getFileName()
```
    从接口复制的说明: MmapFile
    
    Returns the file name of the MappedFile.
    
    指定者:
    
    getFileName 在接口中 MmapFile
    
    返回:
    
    the file name
  - getMappedByteBuffer
```
public java.nio.MappedByteBuffer getMappedByteBuffer()
```
    从接口复制的说明: MmapFile
    
    Returns the mapped byte buffer behind the mapped file.
    
    指定者:
    
    getMappedByteBuffer 在接口中 MmapFile
    
    返回:
    
    the mapped byte buffer
  - sliceByteBuffer
```
public java.nio.ByteBuffer sliceByteBuffer()
```
    从接口复制的说明: MmapFile
    
    Returns a slice of the mapped byte buffer behind the mapped file.
    
    指定者:
    
    sliceByteBuffer 在接口中 MmapFile
    
    返回:
    
    the slice of the mapped byte buffer
  - isFirstCreateInQueue
```
public boolean isFirstCreateInQueue()
```
    从接口复制的说明: MmapFile
    
    Returns true if the current file is first mapped file of some consume queue.
    
    指定者:
    
    isFirstCreateInQueue 在接口中 MmapFile
    
    返回:
    
    true or false
  - setFirstCreateInQueue
```
public void setFirstCreateInQueue(boolean firstCreateInQueue)
```
    从接口复制的说明: MmapFile
    
    Sets the flag whether the current file is first mapped file of some consume queue.
    
    指定者:
    
    setFirstCreateInQueue 在接口中 MmapFile
    
    参数:
    
    firstCreateInQueue - true or false
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 DefaultMmapFile

字段概要

从类继承的字段 io.openmessaging.storage.dledger.store.file.ReferenceResource

构造器概要

方法概要

从类继承的方法 io.openmessaging.storage.dledger.store.file.ReferenceResource

从类继承的方法 java.lang.Object

从接口继承的方法 io.openmessaging.storage.dledger.store.file.MmapFile

字段详细资料

OS_PAGE_SIZE

logger

file

构造器详细资料

DefaultMmapFile

方法详细资料

getTotalMappedFiles

getTotalMappedVirtualMemory

ensureDirOK

clean

getLastModifiedTimestamp

getFileSize

getFileChannel

getFileFromOffset

appendMessage

appendMessage

flush

commit

getFlushedPosition

setFlushedPosition

getStartPosition

setStartPosition

isFull

selectMappedBuffer

selectMappedBuffer

getData

cleanup

destroy

getWrotePosition

setWrotePosition

getReadPosition

setCommittedPosition

getFileName

getMappedByteBuffer

sliceByteBuffer

isFirstCreateInQueue

setFirstCreateInQueue

toString