os/persistentdata/persistentstorage/centralrepository/include/centralrepository.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/include/centralrepository.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,213 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __CENTRALREPOSITORY_H__
1.20 +#define __CENTRALREPOSITORY_H__
1.21 +
1.22 +#include <e32base.h>
1.23 +
1.24 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.25 + #include <centralrepositoryinternal.h>
1.26 +#endif
1.27 +
1.28 +namespace NCentralRepositoryConstants
1.29 +/** Namespace encapsulating the CentralRepository constants.
1.30 +@publishedAll
1.31 +@released
1.32 +*/
1.33 +{
1.34 +
1.35 +/** The maximum number of unicode characters that can be stored in a setting
1.36 +@publishedAll
1.37 +@released
1.38 +*/
1.39 +const TInt KMaxUnicodeStringLength = 1024;
1.40 +
1.41 +/** The maximum number of bytes that can be stored in a setting
1.42 +@publishedAll
1.43 +@released
1.44 +*/
1.45 +const TInt KMaxBinaryLength = KMaxUnicodeStringLength*2;
1.46 +
1.47 +/** Error key returned by CommitTransaction in case of an error that cannot be
1.48 +attributed to any single or partial key. Also notify value for spurious
1.49 +notifications (eg when a notification is cancelled or several values change at once )
1.50 +@publishedAll
1.51 +@released
1.52 +*/
1.53 +const TUint32 KUnspecifiedKey = 0xffffffffUL;
1.54 +
1.55 +/** Use KUnspecifiedKey instead of this value.
1.56 +@publishedAll
1.57 +@deprecated
1.58 +*/
1.59 +const TUint32 KInvalidNotificationId = KUnspecifiedKey;
1.60 +
1.61 +/** The 8 most significant bits of a setting's meta-data are reserved for internal use.
1.62 +Clients should not make use of the reserved bits (unless it is specifically stated
1.63 +otherwise in Symbian developer documentation). Clients should not rely on the value
1.64 +of the reserved bits. Reserved bits are not guaranteed to be 0 or 1 and are not
1.65 +guaranteed to stay constant from one GetMeta call to the next.
1.66 +@released
1.67 +@see CRepository::GetMeta
1.68 +@see KMetaUnreserved
1.69 +*/
1.70 +const TUint32 KMetaSymbianReserved = 0xFF000000;
1.71 +
1.72 +/** The 24 least significant bits of a setting's meta-data are available for use. Clients
1.73 +should make use of KMetaUnreserved to mask out the reserved bits following a call
1.74 +to GetMeta. Clients should not rely on the value of the reserved bits. Reserved bits
1.75 +are not guaranteed to be 0 or 1 and are not guaranteed to stay constant from one
1.76 +GetMeta call to the next.
1.77 +@released
1.78 +@see CRepository::GetMeta
1.79 +@see KMetaSymbianReserved
1.80 +*/
1.81 +const TUint32 KMetaUnreserved = 0x00FFFFFF;
1.82 +
1.83 +} // namespace NCentralRepositoryConstants
1.84 +
1.85 +/** Provides access to a repository.
1.86 +
1.87 +There are potentially 2^32 repositories, each identified by a UID. Within each
1.88 +repository up to 2^32 settings can be stored. Settings within a repository are
1.89 +identified by a 32-bit key and may be of the types integer, real or descriptor.
1.90 +@publishedAll
1.91 +@released
1.92 +*/
1.93 +class CRepository : public CBase
1.94 + {
1.95 +public:
1.96 +
1.97 + /** Transaction mode chosen with StartTransaction.
1.98 + */
1.99 + enum TTransactionMode
1.100 + {
1.101 + /** Standard optimistic non-serialised transaction. Can be started at any time
1.102 + Commit fails with KErrLocked if another client interrupts it by first committing
1.103 + changes: transaction should be repeated until KErrLocked is not returned.
1.104 + */
1.105 + EConcurrentReadWriteTransaction = 2,
1.106 + /** Pessimistic locking transaction intended for reading consistent values.
1.107 + Can only be started if EReadWriteTransaction is not in progress.
1.108 + Automatically promoted to EReadWriteTransaction on first write operation
1.109 + if no other read transaction is in progress (or fails if not attainable).
1.110 + Use ONLY if all clients can agree not to use EConcurrentReadWriteTransaction,
1.111 + and only make changes in an EReadWriteTransaction.
1.112 + */
1.113 + EReadTransaction = 1,
1.114 + /** Pessimistic locking transaction intended for writing values. Can only be
1.115 + started if no EReadTransaction or EReadWriteTransactions are in progress.
1.116 + Use ONLY if all clients can agree not to use EConcurrentReadWriteTransaction,
1.117 + and only make changes in an EReadWriteTransaction.
1.118 + */
1.119 + EReadWriteTransaction = 3
1.120 + };
1.121 +
1.122 + /** Buffer type for aKeyInfo parameter to asynchronous CommitTransaction.
1.123 + @see CRepository::CommitTransaction(TDes8& aKeyInfo, TRequestStatus& aStatus)
1.124 + */
1.125 + typedef TPckgBuf<TUint32> TTransactionKeyInfoBuf;
1.126 +
1.127 + IMPORT_C static CRepository* NewL(TUid aRepositoryUid);
1.128 + IMPORT_C static CRepository* NewLC(TUid aRepositoryUid);
1.129 +
1.130 + IMPORT_C virtual ~CRepository();
1.131 + IMPORT_C TInt Create(TUint32 aKey, TInt aValue);
1.132 + IMPORT_C TInt Create(TUint32 aKey, const TReal& aValue);
1.133 + IMPORT_C TInt Create(TUint32 aKey, const TDesC8& aValue);
1.134 + IMPORT_C TInt Create(TUint32 aKey, const TDesC16& aValue);
1.135 +
1.136 + IMPORT_C TInt Delete(TUint32 aKey);
1.137 + IMPORT_C TInt Delete(TUint32 aPartialKey, TUint32 aMask, TUint32 &aErrorKey) ;
1.138 +
1.139 + IMPORT_C TInt Get(TUint32 aKey, TInt& aValue);
1.140 + IMPORT_C TInt Set(TUint32 aKey, TInt aValue);
1.141 +
1.142 + IMPORT_C TInt Get(TUint32 aKey, TReal& aValue);
1.143 + IMPORT_C TInt Set(TUint32 aKey, const TReal& aValue);
1.144 +
1.145 + IMPORT_C TInt Get(TUint32 aKey, TDes8& aValue);
1.146 + IMPORT_C TInt Get(TUint32 aId, TDes8& aValue, TInt& aActualLength);
1.147 + IMPORT_C TInt Set(TUint32 aKey, const TDesC8& aValue);
1.148 +
1.149 + IMPORT_C TInt Get(TUint32 aKey, TDes16& aValue);
1.150 + IMPORT_C TInt Get(TUint32 aId, TDes16& aValue, TInt& aActualLength);
1.151 + IMPORT_C TInt Set(TUint32 aKey, const TDesC16& aValue);
1.152 +
1.153 + IMPORT_C TInt GetMeta(TUint32 aKey, TUint32& aMeta);
1.154 +
1.155 + IMPORT_C TInt Move (TUint32 aSourcePartialKey, TUint32 aTargetPartialKey,
1.156 + TUint32 aMask, TUint32 &aErrorKey) ;
1.157 +
1.158 + IMPORT_C TInt FindL(TUint32 aPartialKey, TUint32 aMask,
1.159 + RArray<TUint32>& aFoundKeys);
1.160 +
1.161 + IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask,
1.162 + TInt aValue, RArray<TUint32>& aFoundKeys);
1.163 + IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask,
1.164 + const TReal& aValue, RArray<TUint32>& aFoundKeys);
1.165 + IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask,
1.166 + const TDesC8& aValue, RArray<TUint32>& aFoundKeys);
1.167 + IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask,
1.168 + const TDesC16& aValue, RArray<TUint32>& aFoundKeys);
1.169 +
1.170 + IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask,
1.171 + TInt aValue, RArray<TUint32>& aFoundKeys);
1.172 + IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask,
1.173 + const TReal& aValue, RArray<TUint32>& aFoundKeys);
1.174 + IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask,
1.175 + const TDesC8& aValue, RArray<TUint32>& aFoundKeys);
1.176 + IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask,
1.177 + const TDesC16& aValue, RArray<TUint32>& aFoundKeys);
1.178 +
1.179 + IMPORT_C TInt NotifyRequest(TUint32 aKey, TRequestStatus& aStatus);
1.180 + IMPORT_C TInt NotifyRequest(TUint32 aPartialKey, TUint32 aMask,
1.181 + TRequestStatus& aStatus);
1.182 +
1.183 + IMPORT_C TInt NotifyCancel(TUint32 aKey);
1.184 + IMPORT_C TInt NotifyCancel(TUint32 aPartialKey, TUint32 aMask);
1.185 + IMPORT_C TInt NotifyCancelAll();
1.186 +
1.187 + IMPORT_C TInt Reset();
1.188 + IMPORT_C TInt Reset(TUint32 aKey);
1.189 +
1.190 + IMPORT_C TInt StartTransaction(TTransactionMode aMode);
1.191 + IMPORT_C void StartTransaction(TTransactionMode aMode, TRequestStatus& aStatus);
1.192 + IMPORT_C TInt CommitTransaction(TUint32& aKeyInfo);
1.193 + IMPORT_C void CommitTransaction(TDes8& aKeyInfo, TRequestStatus& aStatus);
1.194 + IMPORT_C void CancelTransaction();
1.195 + IMPORT_C void CleanupCancelTransactionPushL();
1.196 + IMPORT_C void FailTransaction();
1.197 + IMPORT_C void CleanupFailTransactionPushL();
1.198 +
1.199 + /** Same as CancelTransaction.
1.200 + @see CancelTransaction
1.201 + */
1.202 + inline void RollbackTransaction()
1.203 + {
1.204 + CancelTransaction();
1.205 + }
1.206 +
1.207 + /** Same as CleanupCancelTransactionPushL.
1.208 + @see CleanupCancelTransactionPushL
1.209 + */
1.210 + inline void CleanupRollbackTransactionPushL()
1.211 + {
1.212 + CleanupCancelTransactionPushL();
1.213 + }
1.214 + };
1.215 +
1.216 +#endif // __CENTRALREPOSITORY_H__