|
sl@0
|
1 |
// Copyright (c) 2005-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 __SQLITESYMBIAN_H__
|
|
sl@0
|
17 |
#define __SQLITESYMBIAN_H__
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#include <e32std.h>
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
//Forward declarations
|
|
sl@0
|
22 |
class RFs;
|
|
sl@0
|
23 |
typedef struct sqlite3 sqlite3;
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
TInt sqlite3SymbianLastOsError(void);
|
|
sl@0
|
26 |
TInt sqlite3SymbianLibInit(void);
|
|
sl@0
|
27 |
void sqlite3SymbianLibFinalize(void);
|
|
sl@0
|
28 |
RFs& sqlite3SymbianFs(void);
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
TInt sqlite3SymbianProfilerStart(TInt aCounterType);
|
|
sl@0
|
31 |
TInt sqlite3SymbianProfilerStop(TInt aCounterType);
|
|
sl@0
|
32 |
TInt sqlite3SymbianProfilerReset(TInt aCounterType);
|
|
sl@0
|
33 |
TInt sqlite3SymbianProfilerQuery(TInt aCounterType, TDes8& aResult);
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
The operation code for registering a free page callback.
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
@see TSqlFreePageCallback
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
@internalComponent
|
|
sl@0
|
41 |
*/
|
|
sl@0
|
42 |
const TInt KSqlFcntlRegisterFreePageCallback = 1000001;
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
/**
|
|
sl@0
|
45 |
This structure is used for sending a request (via TVfs::FileControl()) to the OS porting layer to
|
|
sl@0
|
46 |
register a free page callback - TSqlFreePageCallback::iCallback, which will be called when the number of
|
|
sl@0
|
47 |
the free pages reaches or is above the threshold - TSqlFreePageCallback::iThreshold.
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
@see TSqlFreePageCallback
|
|
sl@0
|
50 |
|
|
sl@0
|
51 |
@internalComponent
|
|
sl@0
|
52 |
*/
|
|
sl@0
|
53 |
NONSHARABLE_STRUCT(TSqlFreePageCallback)
|
|
sl@0
|
54 |
{
|
|
sl@0
|
55 |
/**
|
|
sl@0
|
56 |
"Free page" callback type definition.
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
typedef void (*TCallback)(void* aThis, TInt aFreePageCount);
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
inline TSqlFreePageCallback();
|
|
sl@0
|
61 |
inline TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TCallback aCallback);
|
|
sl@0
|
62 |
inline TBool IsValid() const;
|
|
sl@0
|
63 |
inline void CheckAndCallback(TInt aFreePageCount) const;
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
void* iThis; //"this" pointer of the object that has to be called back
|
|
sl@0
|
66 |
TInt iThreshold; //"free page threshold" in pages
|
|
sl@0
|
67 |
TCallback iCallback; //a pointer to the callback function
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
};
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
Initalizes TSqlFreePageCallback data members with their default values.
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
inline TSqlFreePageCallback::TSqlFreePageCallback() :
|
|
sl@0
|
75 |
iThis(NULL),
|
|
sl@0
|
76 |
iThreshold(0),
|
|
sl@0
|
77 |
iCallback(NULL)
|
|
sl@0
|
78 |
{
|
|
sl@0
|
79 |
}
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
/**
|
|
sl@0
|
82 |
Initalizes TSqlFreePageCallback data members with the supplied callback values.
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
@param aThis "this" pointer of the object that has to be called back,
|
|
sl@0
|
85 |
@param aThreshold "free page threshold" in pages,
|
|
sl@0
|
86 |
@param aCallback a pointer to the callback function;
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
inline TSqlFreePageCallback::TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TSqlFreePageCallback::TCallback aCallback) :
|
|
sl@0
|
89 |
iThis(aThis),
|
|
sl@0
|
90 |
iThreshold(aFreePageThreshold),
|
|
sl@0
|
91 |
iCallback(aCallback)
|
|
sl@0
|
92 |
{
|
|
sl@0
|
93 |
}
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
/**
|
|
sl@0
|
96 |
@return True if this is a valid (initialized) callback object.
|
|
sl@0
|
97 |
*/
|
|
sl@0
|
98 |
inline TBool TSqlFreePageCallback::IsValid() const
|
|
sl@0
|
99 |
{
|
|
sl@0
|
100 |
return iThis && iThreshold >= 0 && iCallback;
|
|
sl@0
|
101 |
}
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
/**
|
|
sl@0
|
104 |
Calls the callback if aFreePageCount value is above the threshold.
|
|
sl@0
|
105 |
|
|
sl@0
|
106 |
@param aFreePageCount Database free pages count
|
|
sl@0
|
107 |
*/
|
|
sl@0
|
108 |
inline void TSqlFreePageCallback::CheckAndCallback(TInt aFreePageCount) const
|
|
sl@0
|
109 |
{
|
|
sl@0
|
110 |
if(aFreePageCount > 0 && aFreePageCount >= iThreshold)
|
|
sl@0
|
111 |
{
|
|
sl@0
|
112 |
(*iCallback)(iThis, aFreePageCount);
|
|
sl@0
|
113 |
}
|
|
sl@0
|
114 |
}
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
#endif//__SQLITESYMBIAN_H__
|