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
static void	clear(Path rootPath) Clear the dir.
void	close() Close the page store dir.
static PageStoreDir	createPageStoreDir(AlluxioConfiguration conf, PageStoreOptions pageStoreOptions) Create an instance of PageStoreDir.
static List<PageStoreDir>	createPageStoreDirs(AlluxioConfiguration conf) Create a list of PageStoreDir based on the configuration.
long	deletePage(PageInfo bytes)
long	getCachedBytes()
long	getCapacityBytes()
CacheEvictor	getEvictor()
static String	getFileBucket(int fileBuckets, String fileId)
PageStore	getPageStore()
Path	getRootPath()
boolean	hasFile(String fileId)
boolean	putPage(PageInfo pageInfo)
boolean	putTempFile(String fileId)
long	release(int bytes) Release the pre-reserved space.
boolean	reserve(int bytes)
void	reset() Reset page store.
void	scanPages(java.util.function.Consumer<Optional<PageInfo>> pageInfoConsumer) Scan the pages under this dir.

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

createPageStoreDirs

static List<PageStoreDir> createPageStoreDirs(AlluxioConfiguration conf)
                                       throws IOException

Create a list of PageStoreDir based on the configuration.

Parameters:

conf - AlluxioConfiguration

Returns:

A list of LocalCacheDir

Throws:

IOException

createPageStoreDir

static PageStoreDir createPageStoreDir(AlluxioConfiguration conf,
                                       PageStoreOptions pageStoreOptions)

Create an instance of PageStoreDir.

Parameters:

conf -

pageStoreOptions -

Returns:

PageStoreDir

getFileBucket

static String getFileBucket(int fileBuckets,
                            String fileId)

Parameters:

fileBuckets - number of buckets

fileId - file id

Returns:

file bucket

clear

static void clear(Path rootPath)
           throws IOException

Clear the dir.

Parameters:

rootPath -

Throws:

IOException - when failed to clean up the specific location

getRootPath

Path getRootPath()

Returns:

root path

getPageStore

PageStore getPageStore()

Returns:

pageStore

getCapacityBytes

long getCapacityBytes()

Returns:

capacity

reset

void reset()
    throws IOException

Reset page store.

Throws:

IOException

scanPages

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

Scan the pages under this dir.

Parameters:

pageInfoConsumer -

Throws:

IOException

getCachedBytes

long getCachedBytes()

Returns:

cached bytes in this directory

putPage

boolean putPage(PageInfo pageInfo)

Parameters:

pageInfo -

Returns:

if the page added successfully

putTempFile

boolean putTempFile(String fileId)

Parameters:

fileId -

Returns:

if the fileId added successfully

reserve

boolean reserve(int 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(int bytes)

Release the pre-reserved space.

Parameters:

bytes -

Returns:

the bytes used after the release

hasFile

boolean hasFile(String fileId)

Parameters:

fileId -

Returns:

true if the file is contained, false otherwise

getEvictor

CacheEvictor getEvictor()

Returns:

the evictor of this dir

close

void close()

Close the page store dir.