Symbian^3 Product 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

Public Member Functions
IMPORT_C TIntCommit()
voidCommitL()
IMPORT_C TIntCompactL()
IMPORT_C voidDelete(TStreamId)
IMPORT_C voidDeleteL(TStreamId)
TStreamId ExtendL()
IMPORT_C TIntReclaimL()
IMPORT_C voidRevert()
voidRevertL()
Private Member Functions
IMPORT_C voidDoCommitL()
IMPORT_C MIncrementalCollector *DoCompactL()
MStreamBuf *DoCreateL(TStreamId &)
IMPORT_C voidDoDeleteL(TStreamId)
IMPORT_C TStreamIdDoExtendL()
MStreamBuf *DoReadL(TStreamId)
IMPORT_C MIncrementalCollector *DoReclaimL()
IMPORT_C MStreamBuf *DoReplaceL(TStreamId)
IMPORT_C voidDoRevertL()
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 TIntCommit()

CommitL()

voidCommitL()[inline]

Commit changes and leaves if unsuccessful.

CStreamStore::Commit()

CompactL()

IMPORT_C TIntCompactL()

Delete(TStreamId)

IMPORT_C voidDelete(TStreamIdanId)

Parameters

TStreamId anId

DeleteL(TStreamId)

IMPORT_C voidDeleteL(TStreamIdanId)

Parameters

TStreamId anId

DoCommitL()

IMPORT_C voidDoCommitL()[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 & anIdOn return, contains the allocated stream id.

DoDeleteL(TStreamId)

IMPORT_C voidDoDeleteL(TStreamIdanId)[private, virtual]

Parameters

TStreamId anId

DoExtendL()

IMPORT_C TStreamIdDoExtendL()[private, virtual]

DoReadL(TStreamId)

MStreamBuf *DoReadL(TStreamIdanId)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 anIdThe stream to be read.

DoReclaimL()

IMPORT_C MIncrementalCollector *DoReclaimL()[private, virtual]

DoReplaceL(TStreamId)

IMPORT_C MStreamBuf *DoReplaceL(TStreamIdanId)[private, virtual]

Parameters

TStreamId anId

DoRevertL()

IMPORT_C voidDoRevertL()[private, virtual]

DoWriteL(TStreamId)

IMPORT_C MStreamBuf *DoWriteL(TStreamIdanId)[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 TIntReclaimL()

Revert()

IMPORT_C voidRevert()

RevertL()

voidRevertL()[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

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.