|
sl@0
|
1 |
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#ifndef __S32FILEITER_H__
|
|
sl@0
|
17 |
#define __S32FILEITER_H__
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef __S32STD_H__
|
|
sl@0
|
20 |
#include <s32std.h>
|
|
sl@0
|
21 |
#endif
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
//Forward declarations
|
|
sl@0
|
24 |
class CPermanentFileStore;
|
|
sl@0
|
25 |
class RPermanentStoreTocIter;
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
This class describes an object that can serve as a stream ID forward iterator
|
|
sl@0
|
29 |
for the controlled sequence of stream IDs in CPermanentFileStore instance.
|
|
sl@0
|
30 |
RPermanentFileStoreIter instances will allow you to access only stream IDs which are
|
|
sl@0
|
31 |
already commited to the store.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
Usage pattern:
|
|
sl@0
|
34 |
@code
|
|
sl@0
|
35 |
CPermanentFileStore* store;
|
|
sl@0
|
36 |
//create "store" ...
|
|
sl@0
|
37 |
RPermanentFileStoreIter iter;
|
|
sl@0
|
38 |
iter.ResetLC(*store);
|
|
sl@0
|
39 |
TStreamId id;
|
|
sl@0
|
40 |
while((id = iter.NextL()) != KNullStreamIdValue)
|
|
sl@0
|
41 |
{
|
|
sl@0
|
42 |
RStoreReadStream in;
|
|
sl@0
|
43 |
in.OpenLC(*store, id);
|
|
sl@0
|
44 |
//read from "in" stream
|
|
sl@0
|
45 |
CleanupStack::PopAndDestroy(&in);
|
|
sl@0
|
46 |
}
|
|
sl@0
|
47 |
CleanupStack::PopAndDestroy(&iter);
|
|
sl@0
|
48 |
@endcode
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
Any change (deleting/adding streams) of stream IDs sequence during the lifetime of
|
|
sl@0
|
51 |
RPermanentFileStoreIter instance will invalidate it.
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
@internalTechnology
|
|
sl@0
|
54 |
@released
|
|
sl@0
|
55 |
@see CPermanentFileStore
|
|
sl@0
|
56 |
@see TStreamId
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
class RPermanentFileStoreIter
|
|
sl@0
|
59 |
{
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
public:
|
|
sl@0
|
62 |
inline RPermanentFileStoreIter();
|
|
sl@0
|
63 |
IMPORT_C void Close();
|
|
sl@0
|
64 |
IMPORT_C void ResetLC(const CPermanentFileStore& aStore);
|
|
sl@0
|
65 |
inline void ResetL(const CPermanentFileStore& aStore);
|
|
sl@0
|
66 |
IMPORT_C TStreamId NextL();
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
private:
|
|
sl@0
|
69 |
RPermanentStoreTocIter* iImpl;
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
};
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
#include <s32fileiter.inl>
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
#endif//__S32FILEITER_H__
|