RStorePagePool Class Reference

#include <s32stor.h>

class RStorePagePool : public TCachePagePool

Inherits from

RStorePagePool
- TCachePagePool
  - MPagePool

Public Member Functions
	RStorePagePool()
	RStorePagePool(CPageCache &)
	RStorePagePool(CStreamStore &)
	RStorePagePool(CStreamStore &, const TStorePagePoolToken &)
IMPORT_C void	Close()
IMPORT_C void	Create(CStreamStore &)
void	Discard()
TBool	HasAvailable()
TBool	IsDirty()
TBool	IsEmpty()
void	MarkCurrent()
void	MarkDirty()
IMPORT_C void	Open(CStreamStore &, const TStorePagePoolToken &)
IMPORT_C void	ReclaimAllL()
IMPORT_C TBool	ReclaimL()
void	Release()
IMPORT_C TStorePagePoolToken	Token()

Protected Member Functions
virtual IMPORT_C void	DoDeleteL(TPageRef)
virtual IMPORT_C TPageRef	ExtendL(const TAny *, TPageReclamation)
virtual IMPORT_C void	ReadL(TPageRef, TAny *)
virtual IMPORT_C void	WriteL(TPageRef, const TAny *, TPageChange)

Inherited Functions
	MPagePool::Delete(TPageRef)
	MPagePool::DeleteL(TPageRef)
	MPagePool::Pop()
	MPagePool::PushL()
	TCachePagePool::AcquireL()
	TCachePagePool::AllocL()
	TCachePagePool::AssignL(const TAny *,TPageReclamation)
	TCachePagePool::Flush()
	TCachePagePool::FlushL()
	TCachePagePool::LockL(TPageRef)
	TCachePagePool::Purge()
	TCachePagePool::Set(CPageCache &)
	TCachePagePool::TCachePagePool()
	TCachePagePool::TCachePagePool(CPageCache &)
	TCachePagePool::Unlock(const TAny *,TPageChange)
	TCachePagePool::UpdateL(const TAny *)

Detailed Description

Uses a store to implement the page pool interface MPagePool.

Pages can be reclaimable (tracked by the page pool, so that they can be freed when required) or not (in which case they must be deleted explicitly): this is indicated by a flag of type TPageReclamation. Non-reclaimable pages each have their own stream in the store; reclaimable pages are bundled 15 to a stream. To track the reclaimable pages, the page pool has a separate token, type TStorePagePoolToken, that must be saved by the user of the pool.

The store used must support CStreamStore::ExtendL(), CStreamStore::DeleteL() and allow streams to be re-written. CPermanentFileStore meets these conditions.

A store page pool uses a cache to store pages in-memory and to cache frequently accessed pages. You should provide a cache object (CPageCache) to the pool for this purpose.

Constructor & Destructor Documentation

RStorePagePool ( )

IMPORT_C

RStorePagePool

(

)

Default constructor.

RStorePagePool ( CPageCache & )

IMPORT_C

RStorePagePool

(

CPageCache &

aCache

)

Constructor with a page cache for the pool.

Parameter	Description
aCache	Page cache for the pool

RStorePagePool ( CStreamStore & )

IMPORT_C

RStorePagePool

(

CStreamStore &

aStore

)

Constructor with a stream store to use for the pool.

Parameter	Description
aStore	Stream store to use for the pool

RStorePagePool ( CStreamStore &, const TStorePagePoolToken & )

IMPORT_C	RStorePagePool	(	CStreamStore &	aStore,
			const TStorePagePoolToken &	aToken
		)

Constructor with a stream store and settings to use for the pool.

Parameter	Description
aStore	Stream store to use for the pool
aToken	Stream store pool settings

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Flushes and purges the page cache and stops using the stream store.

Create ( CStreamStore & )

IMPORT_C void

Create

(

CStreamStore &

aStore

)

Creates a new pool.

Parameter	Description
aStore	Stream store to use for the pool

Discard ( )

void

Discard

(

)

[inline]

Invalidates the list of free pages in the reclaimable set.

This should be done if there has been a failure in updating the BTree, as this list is possibly corrupt now. The reclaimable set can be deleted using ReclaimAllL(), and the BTree then repaired.

DoDeleteL ( TPageRef )

IMPORT_C void

DoDeleteL

(

TPageRef

aRef

)

[protected, virtual]

Reimplemented from TCachePagePool::DoDeleteL(TPageRef)

ExtendL ( const TAny *, TPageReclamation )

IMPORT_C TPageRef	ExtendL	(	const TAny *	aPage,
			TPageReclamation	aReclamation
		)	[protected, virtual]

Reimplemented from TCachePagePool::ExtendL(const TAny *,TPageReclamation)

HasAvailable ( )

TBool

HasAvailable

(

)

const [inline]

Tests if there is a free page in the pool.

Returns: True if there is a free page in the pool, otherwise false

IsDirty ( )

TBool

IsDirty

(

)

const [inline]

Tests if the dirty flag has been set on the page pool.

Returns: True if the dirty flag has been set, otherwise false

IsEmpty ( )

TBool

IsEmpty

(

)

const [inline]

Tests if the page pool is empty.

Returns: True if the page pool is empty, otherwise false

MarkCurrent ( )

void

MarkCurrent

(

)

[inline]

Clears the dirty flag.

MarkDirty ( )

void

MarkDirty

(

)

[inline]

Sets the dirty flag on the pool.

Open ( CStreamStore &, const TStorePagePoolToken & )

IMPORT_C void	Open	(	CStreamStore &	aStore,
			const TStorePagePoolToken &	aToken
		)

Opens an existing pool.

Parameter	Description
aStore	Stream store for the pool
aToken	Pool settings

ReadL ( TPageRef, TAny * )

IMPORT_C void	ReadL	(	TPageRef	aRef,
			TAny *	aPage
		)	[protected, virtual]

Reimplemented from TCachePagePool::ReadL(TPageRef,TAny *)

ReclaimAllL ( )

IMPORT_C void

ReclaimAllL

(

)

Deletes all streams in the store.

ReclaimL ( )

IMPORT_C TBool

ReclaimL

(

)

Deletes the first stream that stores reclaimable pages in the store.

Returns: True if there are remaining streams (pages), false if there are no more streams

Release ( )

void

Release

(

)

[inline]

Purges the page cache and stops using the stream store.

Token ( )

IMPORT_C TStorePagePoolToken

Token

(

)

const

Gets an object that encapsulates the page pool settings.

That object can then be used to externalise the settings.

Returns: Encapsulates the page pool settings

WriteL ( TPageRef, const TAny *, TPageChange )

IMPORT_C void	WriteL	(	TPageRef	aRef,
			const TAny *	aPage,
			TPageChange	aChange
		)	[protected, virtual]

Reimplemented from TCachePagePool::WriteL(TPageRef,const TAny *,TPageChange)