alluxio.client.file.cache.store

Interface PageStoreDir

All Known Implementing Classes:

LocalPageStoreDir, MemoryPageStoreDir, RocksPageStoreDir

public interface PageStoreDir

Directory of page store.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
void	abort(java.lang.String fileId) Abort a temporary file.
static void	clear(java.nio.file.Path rootPath) Clear the dir.
void	close() Close the page store dir.
default void	commit(java.lang.String fileId) Commit a temporary file.
void	commit(java.lang.String fileId, java.lang.String newFileId) Commit a temporary file with a new file ID.
static PageStoreDir	createPageStoreDir(CacheEvictorOptions cacheEvictorOptions, PageStoreOptions pageStoreOptions) Create an instance of PageStoreDir.
static java.util.List<PageStoreDir>	createPageStoreDirs(CacheManagerOptions options) Create a list of PageStoreDir based on the configuration.
long	deletePage(PageInfo bytes)
long	getCachedBytes()
long	getCapacityBytes()
CacheEvictor	getEvictor()
static java.lang.String	getFileBucket(int fileBuckets, java.lang.String fileId)
PageStore	getPageStore()
java.nio.file.Path	getRootPath()
boolean	hasFile(java.lang.String fileId)
boolean	hasTempFile(java.lang.String fileId)
void	putPage(PageInfo pageInfo)
boolean	putTempFile(java.lang.String fileId)
void	putTempPage(PageInfo pageInfo)
long	release(long bytes) Release the pre-reserved space.
boolean	reserve(long bytes)
void	reset() Reset page store.
void	scanPages(java.util.function.Consumer<java.util.Optional<PageInfo>> pageInfoConsumer) Scan the pages under this dir.

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

createPageStoreDirs

static java.util.List<PageStoreDir> createPageStoreDirs(CacheManagerOptions options)
                                                 throws java.io.IOException

Create a list of PageStoreDir based on the configuration.

Parameters:

options - of cache manager

Returns:

A list of LocalCacheDir

Throws:

java.io.IOException

createPageStoreDir

static PageStoreDir createPageStoreDir(CacheEvictorOptions cacheEvictorOptions,
                                       PageStoreOptions pageStoreOptions)

Create an instance of PageStoreDir.

Parameters:

cacheEvictorOptions -

pageStoreOptions -

Returns:

PageStoreDir

getFileBucket

static java.lang.String getFileBucket(int fileBuckets,
                                      java.lang.String fileId)

Parameters:

fileBuckets - number of buckets

fileId - file id

Returns:

file bucket

clear

static void clear(java.nio.file.Path rootPath)
           throws java.io.IOException

Clear the dir.

Parameters:

rootPath -

Throws:

java.io.IOException - when failed to clean up the specific location

getRootPath

java.nio.file.Path getRootPath()

Returns:

root path

getPageStore

PageStore getPageStore()

Returns:

pageStore

getCapacityBytes

long getCapacityBytes()

Returns:

capacity

reset

void reset()
    throws java.io.IOException

Reset page store.

Throws:

java.io.IOException

scanPages

void scanPages(java.util.function.Consumer<java.util.Optional<PageInfo>> pageInfoConsumer)
        throws java.io.IOException

Scan the pages under this dir.

Parameters:

pageInfoConsumer -

Throws:

java.io.IOException

getCachedBytes

long getCachedBytes()

Returns:

cached bytes in this directory

putPage

void putPage(PageInfo pageInfo)

Parameters:

pageInfo -

putTempPage

void putTempPage(PageInfo pageInfo)

Parameters:

pageInfo -

putTempFile

boolean putTempFile(java.lang.String fileId)

Parameters:

fileId - file id

Returns:

if the temp file is added successfully

reserve

boolean reserve(long bytes)

Parameters:

bytes -

Returns:

if the bytes requested could be reserved

deletePage

long deletePage(PageInfo bytes)

Parameters:

bytes -

Returns:

the bytes used after release

release

long release(long bytes)

Release the pre-reserved space.

Parameters:

bytes -

Returns:

the bytes used after the release

hasFile

boolean hasFile(java.lang.String fileId)

Parameters:

fileId -

Returns:

true if the file is contained, false otherwise

hasTempFile

boolean hasTempFile(java.lang.String fileId)

Parameters:

fileId -

Returns:

true if the temp file is contained, false otherwise

getEvictor

CacheEvictor getEvictor()

Returns:

the evictor of this dir

close

void close()

Close the page store dir.

commit

default void commit(java.lang.String fileId)
             throws java.io.IOException

Commit a temporary file.

Parameters:

fileId -

Throws:

java.io.IOException

commit

void commit(java.lang.String fileId,
            java.lang.String newFileId)
     throws java.io.IOException

Commit a temporary file with a new file ID.

Parameters:

fileId -

newFileId -

Throws:

java.io.IOException

abort

void abort(java.lang.String fileId)
    throws java.io.IOException

Abort a temporary file.

Parameters:

fileId -

Throws:

java.io.IOException