alluxio.client.file.cache

Interface ShadowCacheManager

All Known Implementing Classes:

ClockCuckooShadowCacheManager, MultipleBloomShadowCacheManager

public interface ShadowCacheManager

The interface represents a shadow cache which supports put/read/delete/aging operations.

Method Summary

Modifier and Type	Method and Description
void	aging() Aging all the pages stored in this shadow cache.
static ShadowCacheManager	create(AlluxioConfiguration conf)
boolean	delete(PageId pageId) Deletes a page from the cache.
int	get(PageId pageId, int bytesToRead, CacheScope scope) Reads the entire page and refresh its access time if the queried page is found in the cache.
double	getFalsePositiveRatio()
long	getShadowCacheByteHit()
long	getShadowCacheByteRead()
long	getShadowCacheBytes()
long	getShadowCacheBytes(CacheScope scope)
long	getShadowCachePageHit()
long	getShadowCachePageRead()
long	getShadowCachePages()
long	getShadowCachePages(CacheScope scope)
boolean	put(PageId pageId, int size, CacheScope scope) Puts a page with specified size and scope into the shadow cache manager.
void	stopUpdate() Stop the background aging task.
void	updateWorkingSetSize() Update working set size in number of pages and bytes.

Method Detail

create

static ShadowCacheManager create(AlluxioConfiguration conf)

Parameters:

conf - the Alluxio configuration

Returns:

an instance of ShadowCacheManager

put

boolean put(PageId pageId,
            int size,
            CacheScope scope)

Puts a page with specified size and scope into the shadow cache manager.

Parameters:

pageId - page identifier

size - page size

scope - cache scope

Returns:

true if the put was successful, false otherwise

get

int get(PageId pageId,
        int bytesToRead,
        CacheScope scope)

Reads the entire page and refresh its access time if the queried page is found in the cache.

Parameters:

pageId - page identifier

bytesToRead - number of bytes to read in this page

scope - cache scope

Returns:

the number of bytes read, 0 if page is not found, -1 on errors

delete

boolean delete(PageId pageId)

Deletes a page from the cache.

Parameters:

pageId - page identifier

Returns:

true if the page is successfully deleted, false otherwise

aging

void aging()

Aging all the pages stored in this shadow cache. Specifically, aging operation removes all the stale pages which are not accessed for more than a sliding window.

updateWorkingSetSize

void updateWorkingSetSize()

Update working set size in number of pages and bytes. Suggest calling this method before getting the number of pages or bytes.

stopUpdate

void stopUpdate()

Stop the background aging task.

getShadowCachePages

long getShadowCachePages()

Returns:

the number of pages in this shadow cache

getShadowCachePages

long getShadowCachePages(CacheScope scope)

Parameters:

scope - cache scope

Returns:

the number of pages of given cache scope in this shadow cache

getShadowCacheBytes

long getShadowCacheBytes()

Returns:

the number of bytes in this shadow cache

getShadowCacheBytes

long getShadowCacheBytes(CacheScope scope)

Parameters:

scope - cache scope

Returns:

the number of bytes of given cache scope in this shadow cache

getShadowCachePageRead

long getShadowCachePageRead()

Returns:

the number of pages read in this shadow cache

getShadowCachePageHit

long getShadowCachePageHit()

Returns:

the number of pages hit in this shadow cache

getShadowCacheByteRead

long getShadowCacheByteRead()

Returns:

the number of bytes read in this shadow cache

getShadowCacheByteHit

long getShadowCacheByteHit()

Returns:

the number of bytes hit in this shadow cache

getFalsePositiveRatio

double getFalsePositiveRatio()

Returns:

the false positive ratio