org.apache.ignite.internal.processors.cache.persistence.file

Class FilePageStore

java.lang.Object

org.apache.ignite.internal.processors.cache.persistence.file.FilePageStore

All Implemented Interfaces:

PageStore

public class FilePageStore
extends Object
implements PageStore

File page store.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_SIZE Allocated field offset.

Constructor Summary

Constructors

Constructor and Description
FilePageStore(byte type, File file, FileIOFactory factory, MemoryConfiguration cfg)

Method Summary

Methods

Modifier and Type	Method and Description
long	allocatePage() Allocates next page index.
void	beginRecover()
void	ensure()
boolean	exists() Checks if page exists.
void	finishRecover()
static ByteBuffer	header(byte type, int pageSize)
long	pageOffset(long pageId) Gets page offset within the store file.
int	pages() Gets number of allocated pages.
void	read(long pageId, ByteBuffer pageBuf, boolean keepCrc) Reads a page.
void	readHeader(ByteBuffer buf) Reads a header.
void	stop(boolean cleanFile)
void	sync() Sync method used to ensure that the given pages are guaranteed to be written to the store.
void	truncate(int tag)
void	write(long pageId, ByteBuffer pageBuf, int tag) Writes a page.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_SIZE

public static final int HEADER_SIZE

Allocated field offset.

See Also:

Constant Field Values

Constructor Detail

FilePageStore

public FilePageStore(byte type,
             File file,
             FileIOFactory factory,
             MemoryConfiguration cfg)

Parameters:

file - File.

Method Detail

exists

public boolean exists()

Checks if page exists.

Specified by:

exists in interface PageStore

Returns:

True if page exists.

header

public static ByteBuffer header(byte type,
                int pageSize)

Parameters:

type - Type.

pageSize - Page size.

Returns:

Byte buffer instance.

stop

public void stop(boolean cleanFile)
          throws IgniteCheckedException

Parameters:

cleanFile - True to delete file.

Throws:

IgniteCheckedException - If failed.

truncate

public void truncate(int tag)
              throws IgniteCheckedException

Throws:

IgniteCheckedException

beginRecover

public void beginRecover()

finishRecover

public void finishRecover()

read

public void read(long pageId,
        ByteBuffer pageBuf,
        boolean keepCrc)
          throws IgniteCheckedException

Reads a page.

Specified by:

read in interface PageStore

Parameters:

pageId - Page ID.

pageBuf - Page buffer to read into.

keepCrc - by default reading zeroes CRC which was on file, but you can keep it in pageBuf if set keepCrc

Throws:

IgniteCheckedException - If reading failed (IO error occurred).

readHeader

public void readHeader(ByteBuffer buf)
                throws IgniteCheckedException

Reads a header.

Specified by:

readHeader in interface PageStore

Parameters:

buf - Buffer to write to.

Throws:

IgniteCheckedException - If failed.

write

public void write(long pageId,
         ByteBuffer pageBuf,
         int tag)
           throws IgniteCheckedException

Writes a page.

Specified by:

write in interface PageStore

Parameters:

pageId - Page ID.

pageBuf - Page buffer to write.

tag - Partition file version, 1-based incrementing counter. For outdated pages tag has lower value, and write does nothing

Throws:

IgniteCheckedException - If page writing failed (IO error occurred).

pageOffset

public long pageOffset(long pageId)

Gets page offset within the store file.

Specified by:

pageOffset in interface PageStore

Parameters:

pageId - Page ID.

Returns:

Page offset.

sync

public void sync()
          throws IgniteCheckedException

Sync method used to ensure that the given pages are guaranteed to be written to the store.

Specified by:

sync in interface PageStore

Throws:

IgniteCheckedException - If sync failed (IO error occurred).

ensure

public void ensure()
            throws IgniteCheckedException

Specified by:

ensure in interface PageStore

Throws:

IgniteCheckedException - If sync failed (IO error occurred).

allocatePage

public long allocatePage()
                  throws IgniteCheckedException

Allocates next page index.

Specified by:

allocatePage in interface PageStore

Returns:

Next page index.

Throws:

IgniteCheckedException - If failed to allocate.

pages

public int pages()

Gets number of allocated pages.

Specified by:

pages in interface PageStore

Returns:

Number of allocated pages.