Collapse all Symbian^3 Application Developer Library

CStreamStore Class Reference

class CStreamStore : public CBase

Provides the core abstract framework for stores allowing streams to be created and manipulated.

Inherits from

CStreamStore
- CBase

Public Member Functions
IMPORT_C TInt	Commit ()
void	CommitL ()
IMPORT_C TInt	CompactL ()
IMPORT_C void	Delete ( TStreamId )
IMPORT_C void	DeleteL ( TStreamId )
TStreamId	ExtendL ()
IMPORT_C TInt	ReclaimL ()
IMPORT_C void	Revert ()
void	RevertL ()

Private Member Functions
IMPORT_C void	DoCommitL ()
IMPORT_C MIncrementalCollector *	DoCompactL ()
MStreamBuf *	DoCreateL ( TStreamId &)
IMPORT_C void	DoDeleteL ( TStreamId )
IMPORT_C TStreamId	DoExtendL ()
MStreamBuf *	DoReadL ( TStreamId )
IMPORT_C MIncrementalCollector *	DoReclaimL ()
IMPORT_C MStreamBuf *	DoReplaceL ( TStreamId )
IMPORT_C void	DoRevertL ()
IMPORT_C MStreamBuf *	DoWriteL ( TStreamId )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Member Functions Documentation

Commit()

IMPORT_C TInt

Commit

(

)

CommitL()

void

CommitL

(

)

[inline]

Commit changes and leaves if unsuccessful.

CStreamStore::Commit()

CompactL()

IMPORT_C TInt

CompactL

(

)

Delete(TStreamId)

IMPORT_C void

Delete

(

TStreamId

anId

)

Parameters

TStreamId anId

DeleteL(TStreamId)

IMPORT_C void

DeleteL

(

TStreamId

anId

)

Parameters

TStreamId anId

DoCommitL()

IMPORT_C void

DoCommitL

(

)

[private, virtual]

DoCompactL()

IMPORT_C MIncrementalCollector *

DoCompactL

(

)

[private, virtual]

DoCreateL(TStreamId &)

MStreamBuf *

DoCreateL

(

TStreamId &

anId

)

[private, pure virtual]

Creates a new stream in the store. The function gets the allocated stream id in the anId parameter. A stream buffer for the stream should be returned, ready to write into the new stream. This provides the implementation for the RStoreWriteStream::CreateL() functions.

Parameters

TStreamId & anId

On return, contains the allocated stream id.

DoDeleteL(TStreamId)

IMPORT_C void

DoDeleteL

(

TStreamId

anId

)

[private, virtual]

Parameters

TStreamId anId

DoExtendL()

IMPORT_C TStreamId

DoExtendL

(

)

[private, virtual]

DoReadL(TStreamId)

MStreamBuf *

DoReadL

(

TStreamId

anId

)

const [private, pure virtual]

Opens the requested stream for reading. The function should return a stream buffer positioned at the beginning of this stream.

This function is called by the OpenL() and OpenLC() member functions of RStoreReadStream .

RStoreReadStream::OpenL() RStoreReadStream::OpenLC()

Parameters

TStreamId anId

The stream to be read.

DoReclaimL()

IMPORT_C MIncrementalCollector *

DoReclaimL

(

)

[private, virtual]

DoReplaceL(TStreamId)

IMPORT_C MStreamBuf *

DoReplaceL

(

TStreamId

anId

)

[private, virtual]

Parameters

TStreamId anId

DoRevertL()

IMPORT_C void

DoRevertL

(

)

[private, virtual]

DoWriteL(TStreamId)

IMPORT_C MStreamBuf *

DoWriteL

(

TStreamId

anId

)

[private, virtual]

Parameters

TStreamId anId

ExtendL()

TStreamId

ExtendL

(

)

[inline]

Generates a new stream within this store, and returns its id. This function can be used to create a new stream in advance of being written to.

This function is not supported by the direct file store, CDirectFileStore .

CDirectFileStore

ReclaimL()

IMPORT_C TInt

ReclaimL

(

)

Revert()

IMPORT_C void

Revert

(

)

RevertL()

void

RevertL

(

)

[inline]

Rolls back the store to its state at the last commit point and leaves if unsuccessful.

The function is not supported by the direct file store CDirectFileStore and the non-persistent in-memory store CBufStore .

CDirectFileStore CBufStore