alluxio.client.file.cache

Class TimeBoundPageStore

java.lang.Object

alluxio.client.file.cache.TimeBoundPageStore

All Implemented Interfaces:

PageStore, AutoCloseable

public class TimeBoundPageStore
extends Object
implements PageStore

A wrapper class on PageStore with timeout. Note that, this page store will not queue any request.

Field Summary

Fields inherited from interface alluxio.client.file.cache.PageStore

LOG

Constructor Summary

Constructors

Constructor and Description
TimeBoundPageStore(PageStore pageStore, PageStoreOptions options)

Method Summary

Modifier and Type	Method and Description
void	close()
void	delete(PageId pageId) Deletes a page from the store.
int	get(PageId pageId, int pageOffset, int bytesToRead, byte[] buffer, int bufferOffset) Gets part of a page from the store to the destination buffer.
long	getCacheSize()
java.util.stream.Stream<PageInfo>	getPages() Gets a stream of all pages from the page store.
void	put(PageId pageId, byte[] page) Writes a new page from a source channel to the store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.client.file.cache.PageStore

create, get, getStorePath, initialize, open

Constructor Detail

TimeBoundPageStore

public TimeBoundPageStore(PageStore pageStore,
                          PageStoreOptions options)

Parameters:

pageStore - page store

options - time out in ms

Method Detail

put

public void put(PageId pageId,
                byte[] page)
         throws ResourceExhaustedException,
                IOException

Description copied from interface: PageStore

Writes a new page from a source channel to the store.

Specified by:

put in interface PageStore

Parameters:

pageId - page identifier

page - page data

Throws:

ResourceExhaustedException - when there is not enough space found on disk

IOException - when the store fails to write this page

get

public int get(PageId pageId,
               int pageOffset,
               int bytesToRead,
               byte[] buffer,
               int bufferOffset)
        throws IOException,
               PageNotFoundException

Description copied from interface: PageStore

Gets part of a page from the store to the destination buffer.

Specified by:

get in interface PageStore

Parameters:

pageId - page identifier

pageOffset - offset within page

bytesToRead - bytes to read in this page

buffer - destination buffer

bufferOffset - offset in buffer

Returns:

the number of bytes read

Throws:

IOException - when the store fails to read this page

PageNotFoundException - when the page isn't found in the store

delete

public void delete(PageId pageId)
            throws IOException,
                   PageNotFoundException

Description copied from interface: PageStore

Deletes a page from the store.

Specified by:

delete in interface PageStore

Parameters:

pageId - page identifier

Throws:

IOException - when the store fails to delete this page

PageNotFoundException - when the page isn't found in the store

getPages

public java.util.stream.Stream<PageInfo> getPages()
                                           throws IOException

Description copied from interface: PageStore

Gets a stream of all pages from the page store. This stream needs to be closed as it may open IO resources.

Specified by:

getPages in interface PageStore

Returns:

a stream of all pages from page store

Throws:

IOException - if any error occurs

getCacheSize

public long getCacheSize()

Specified by:

getCacheSize in interface PageStore

Returns:

an estimated cache size in bytes

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception