Collapse all Symbian^3 Product Developer Library

RFilePagePool Class Reference

class RFilePagePool : public TCachePagePool

Uses a file directly to implement the page pool interface MPagePool.

The pages are written sequentially through the file. You should call Close() to release the file resource after CreateL(), OpenL(), ReplaceL() or Temp().

A file 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.

CPageCache RFile

Inherits from

RFilePagePool
- TCachePagePool
  - MPagePool

Public Member Functions
	RFilePagePool()
	RFilePagePool(CPageCache &)
void	Attach(RFile &)
IMPORT_C void	Close()
TInt	Create(RFs &, const TDesC &, TUint)
void	Detach()
RFile &	File()
IMPORT_C TInt	Flush()
IMPORT_C void	FlushL()
TInt	Open(RFs &, const TDesC &, TUint)
IMPORT_C void	Release()
TInt	Replace(RFs &, const TDesC &, TUint)
TInt	Temp(RFs &, const TDesC &, TFileName &, TUint)

Protected Member Functions
IMPORT_C TPageRef	ExtendL(const TAny *, TPageReclamation)
IMPORT_C void	ReadL(TPageRef, TAny *)
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::DoDeleteL(TPageRef)
	TCachePagePool::LockL(TPageRef)
	TCachePagePool::Purge()
	TCachePagePool::Set(CPageCache &)
	TCachePagePool::TCachePagePool()
	TCachePagePool::TCachePagePool(CPageCache &)
	TCachePagePool::Unlock(const TAny *,TPageChange)
	TCachePagePool::UpdateL(const TAny *)

Private Attributes
__MUTABLE RFile	iFile

Constructor & Destructor Documentation

RFilePagePool()

IMPORT_C

RFilePagePool

(

)

RFilePagePool(CPageCache &)

IMPORT_C

RFilePagePool

(

CPageCache &

aCache

)

Parameters

CPageCache & aCache

Member Functions Documentation

Attach(RFile &)

void

Attach

(

RFile &

aFile

)

[inline]

Sets an existing file to be used for the page pool.

Parameters

RFile & aFile

File to use for the page pool

Close()

IMPORT_C void

(

)

Create(RFs &, const TDesC &, TUint)

TInt	Create	(	RFs &	aFs,
			const TDesC &	aName,
			TUint	aFileMode
		)	[inline]

Creates a new file for the page pool.

TFileMode

Parameters

RFs & aFs	A file server session
const TDesC & aName	The name of the file. Any path components which are not specified here are taken from the session path.
TUint aFileMode	The mode in which the file is opened. For more information see the TFileMode enumeration.

Detach()

void

Detach

(

)

[inline]

Ends the use of the file for the page pool, but does not close the file.

ExtendL(const TAny *, TPageReclamation)

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

Parameters

const TAny * aPage
TPageReclamation aReclamation

File()

RFile &

File

(

)

const [inline]

Flush()

IMPORT_C TInt

Flush

(

)

FlushL()

IMPORT_C void

FlushL

(

)

Open(RFs &, const TDesC &, TUint)

TInt	Open	(	RFs &	aFs,
			const TDesC &	aName,
			TUint	aFileMode
		)	[inline]

Opens a file to use for the page pool.

TFileMode

Parameters

RFs & aFs	A file server session
const TDesC & aName	The name of the file
TUint aFileMode	The mode in which the file is opened. For more information, see the TFileMode enumeration.

ReadL(TPageRef, TAny *)

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

Parameters

TPageRef aRef
TAny * aPage

Release()

IMPORT_C void

Release

(

)

Replace(RFs &, const TDesC &, TUint)

TInt	Replace	(	RFs &	aFs,
			const TDesC &	aName,
			TUint	aFileMode
		)	[inline]

Creates or opens a file for the page pool.

If there is an existing file with the same name, this function overwrites it. If the file does not already exist, it is created.

TFileMode

Parameters

RFs & aFs	A file server session.
const TDesC & aName	The name of the file. Any path components which are not specified here are taken from the session path.
TUint aFileMode	The mode in which the file is opened. For more information see the TFileMode enumeration.

Temp(RFs &, const TDesC &, TFileName &, TUint)

TInt	Temp	(	RFs &	aFs,
			const TDesC &	aPath,
			TFileName &	aName,
			TUint	aFileMode
		)	[inline]

Creates and opens a file for the page pool with a unique name.

Parameters

RFs & aFs	A file server session.
const TDesC & aPath	The directory in which the file should be created.
TFileName & aName	On return, contains the full path and name of the file. The filename is guaranteed to be unique within the directory specified by aPath.
TUint aFileMode	The mode in which the file is opened. For more information see the TFileMode enumeration.

WriteL(TPageRef, const TAny *, TPageChange)

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

Parameters

TPageRef aRef
const TAny * aPage
TPageChange aChange

Member Data Documentation

__MUTABLE RFile iFile

__MUTABLE RFile

iFile

[private]