alluxio.client.file.cache

Interface CacheManager

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

CacheManagerWithShadowCache, LocalCacheManager, NoExceptionCacheManager

public interface CacheManager
extends java.lang.AutoCloseable

Interface for managing cached pages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CacheManager.Factory Factory class to get or create a CacheManager.
static class	CacheManager.State State of a cache.

Method Summary

Modifier and Type	Method and Description
boolean	append(PageId pageId, int appendAt, byte[] page, CacheContext cacheContext)
boolean	delete(PageId pageId) Deletes a page from the cache.
default int	get(PageId pageId, int bytesToRead, byte[] buffer, int offsetInBuffer) Reads the entire page if the queried page is found in the cache, stores the result in buffer.
default int	get(PageId pageId, int pageOffset, int bytesToRead, byte[] buffer, int offsetInBuffer) Reads a part of a page if the queried page is found in the cache, stores the result in buffer.
default int	get(PageId pageId, int pageOffset, int bytesToRead, byte[] buffer, int offsetInBuffer, CacheContext cacheContext) Reads a part of a page if the queried page is found in the cache, stores the result in buffer.
int	get(PageId pageId, int pageOffset, int bytesToRead, PageReadTargetBuffer buffer, CacheContext cacheContext) Reads a part of a page if the queried page is found in the cache, stores the result in buffer.
default java.util.List<PageId>	getCachedPageIdsByFileId(java.lang.String fileId, long fileLength) Get page ids by the given file id.
default boolean	put(PageId pageId, byte[] page) Puts a page into the cache manager.
default boolean	put(PageId pageId, byte[] page, CacheContext cacheContext) Puts a page into the cache manager with scope and quota respected.
default boolean	put(PageId pageId, java.nio.ByteBuffer page) Puts a page into the cache manager.
boolean	put(PageId pageId, java.nio.ByteBuffer page, CacheContext cacheContext) Puts a page into the cache manager with scope and quota respected.
CacheManager.State	state()

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

put

default boolean put(PageId pageId,
                    byte[] page)

Puts a page into the cache manager. This method is best effort. It is possible that this put operation returns without page written.

Parameters:

pageId - page identifier

page - page data

Returns:

true if the put was successful, false otherwise

put

default boolean put(PageId pageId,
                    java.nio.ByteBuffer page)

Puts a page into the cache manager. This method is best effort. It is possible that this put operation returns without page written.

Parameters:

pageId - page identifier

page - page data

Returns:

true if the put was successful, false otherwise

put

default boolean put(PageId pageId,
                    byte[] page,
                    CacheContext cacheContext)

Puts a page into the cache manager with scope and quota respected. This method is best effort. It is possible that this put operation returns without page written.

Parameters:

pageId - page identifier

page - page data

cacheContext - cache related context

Returns:

true if the put was successful, false otherwise

put

boolean put(PageId pageId,
            java.nio.ByteBuffer page,
            CacheContext cacheContext)

Puts a page into the cache manager with scope and quota respected. This method is best effort. It is possible that this put operation returns without page written.

Parameters:

pageId - page identifier

page - page data

cacheContext - cache related context

Returns:

true if the put was successful, false otherwise

get

default int get(PageId pageId,
                int bytesToRead,
                byte[] buffer,
                int offsetInBuffer)

Reads the entire page if the queried page is found in the cache, stores the result in buffer.

Parameters:

pageId - page identifier

bytesToRead - number of bytes to read in this page

buffer - destination buffer to write

offsetInBuffer - offset in the destination buffer to write

Returns:

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

get

default int get(PageId pageId,
                int pageOffset,
                int bytesToRead,
                byte[] buffer,
                int offsetInBuffer)

Reads a part of a page if the queried page is found in the cache, stores the result in buffer.

Parameters:

pageId - page identifier

pageOffset - offset into the page

bytesToRead - number of bytes to read in this page

buffer - destination buffer to write

offsetInBuffer - offset in the destination buffer to write

Returns:

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

get

default int get(PageId pageId,
                int pageOffset,
                int bytesToRead,
                byte[] buffer,
                int offsetInBuffer,
                CacheContext cacheContext)

Reads a part of a page if the queried page is found in the cache, stores the result in buffer.

Parameters:

pageId - page identifier

pageOffset - offset into the page

bytesToRead - number of bytes to read in this page

buffer - destination buffer to write

offsetInBuffer - offset in the destination buffer to write

cacheContext - cache related context

Returns:

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

get

int get(PageId pageId,
        int pageOffset,
        int bytesToRead,
        PageReadTargetBuffer buffer,
        CacheContext cacheContext)

Reads a part of a page if the queried page is found in the cache, stores the result in buffer.

Parameters:

pageId - page identifier

pageOffset - offset into the page

bytesToRead - number of bytes to read in this page

buffer - destination buffer to write

cacheContext - cache related context

Returns:

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

getCachedPageIdsByFileId

default java.util.List<PageId> getCachedPageIdsByFileId(java.lang.String fileId,
                                                        long fileLength)

Get page ids by the given file id.

Parameters:

fileId - file identifier

fileLength - file length (this will not be needed after we have per-file metadata)

Returns:

a list of page ids which belongs to the file

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

state

CacheManager.State state()

Returns:

state of this cache

append

boolean append(PageId pageId,
               int appendAt,
               byte[] page,
               CacheContext cacheContext)

Parameters:

pageId -

appendAt -

page -

cacheContext -

Returns:

true if append was successful