sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // sl@0: sl@0: #ifndef __CENTRALREPOSITORY_H__ sl@0: #define __CENTRALREPOSITORY_H__ sl@0: sl@0: #include sl@0: sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS sl@0: #include sl@0: #endif sl@0: sl@0: namespace NCentralRepositoryConstants sl@0: /** Namespace encapsulating the CentralRepository constants. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: { sl@0: sl@0: /** The maximum number of unicode characters that can be stored in a setting sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: const TInt KMaxUnicodeStringLength = 1024; sl@0: sl@0: /** The maximum number of bytes that can be stored in a setting sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: const TInt KMaxBinaryLength = KMaxUnicodeStringLength*2; sl@0: sl@0: /** Error key returned by CommitTransaction in case of an error that cannot be sl@0: attributed to any single or partial key. Also notify value for spurious sl@0: notifications (eg when a notification is cancelled or several values change at once ) sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: const TUint32 KUnspecifiedKey = 0xffffffffUL; sl@0: sl@0: /** Use KUnspecifiedKey instead of this value. sl@0: @publishedAll sl@0: @deprecated sl@0: */ sl@0: const TUint32 KInvalidNotificationId = KUnspecifiedKey; sl@0: sl@0: /** The 8 most significant bits of a setting's meta-data are reserved for internal use. sl@0: Clients should not make use of the reserved bits (unless it is specifically stated sl@0: otherwise in Symbian developer documentation). Clients should not rely on the value sl@0: of the reserved bits. Reserved bits are not guaranteed to be 0 or 1 and are not sl@0: guaranteed to stay constant from one GetMeta call to the next. sl@0: @released sl@0: @see CRepository::GetMeta sl@0: @see KMetaUnreserved sl@0: */ sl@0: const TUint32 KMetaSymbianReserved = 0xFF000000; sl@0: sl@0: /** The 24 least significant bits of a setting's meta-data are available for use. Clients sl@0: should make use of KMetaUnreserved to mask out the reserved bits following a call sl@0: to GetMeta. Clients should not rely on the value of the reserved bits. Reserved bits sl@0: are not guaranteed to be 0 or 1 and are not guaranteed to stay constant from one sl@0: GetMeta call to the next. sl@0: @released sl@0: @see CRepository::GetMeta sl@0: @see KMetaSymbianReserved sl@0: */ sl@0: const TUint32 KMetaUnreserved = 0x00FFFFFF; sl@0: sl@0: } // namespace NCentralRepositoryConstants sl@0: sl@0: /** Provides access to a repository. sl@0: sl@0: There are potentially 2^32 repositories, each identified by a UID. Within each sl@0: repository up to 2^32 settings can be stored. Settings within a repository are sl@0: identified by a 32-bit key and may be of the types integer, real or descriptor. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class CRepository : public CBase sl@0: { sl@0: public: sl@0: sl@0: /** Transaction mode chosen with StartTransaction. sl@0: */ sl@0: enum TTransactionMode sl@0: { sl@0: /** Standard optimistic non-serialised transaction. Can be started at any time sl@0: Commit fails with KErrLocked if another client interrupts it by first committing sl@0: changes: transaction should be repeated until KErrLocked is not returned. sl@0: */ sl@0: EConcurrentReadWriteTransaction = 2, sl@0: /** Pessimistic locking transaction intended for reading consistent values. sl@0: Can only be started if EReadWriteTransaction is not in progress. sl@0: Automatically promoted to EReadWriteTransaction on first write operation sl@0: if no other read transaction is in progress (or fails if not attainable). sl@0: Use ONLY if all clients can agree not to use EConcurrentReadWriteTransaction, sl@0: and only make changes in an EReadWriteTransaction. sl@0: */ sl@0: EReadTransaction = 1, sl@0: /** Pessimistic locking transaction intended for writing values. Can only be sl@0: started if no EReadTransaction or EReadWriteTransactions are in progress. sl@0: Use ONLY if all clients can agree not to use EConcurrentReadWriteTransaction, sl@0: and only make changes in an EReadWriteTransaction. sl@0: */ sl@0: EReadWriteTransaction = 3 sl@0: }; sl@0: sl@0: /** Buffer type for aKeyInfo parameter to asynchronous CommitTransaction. sl@0: @see CRepository::CommitTransaction(TDes8& aKeyInfo, TRequestStatus& aStatus) sl@0: */ sl@0: typedef TPckgBuf TTransactionKeyInfoBuf; sl@0: sl@0: IMPORT_C static CRepository* NewL(TUid aRepositoryUid); sl@0: IMPORT_C static CRepository* NewLC(TUid aRepositoryUid); sl@0: sl@0: IMPORT_C virtual ~CRepository(); sl@0: IMPORT_C TInt Create(TUint32 aKey, TInt aValue); sl@0: IMPORT_C TInt Create(TUint32 aKey, const TReal& aValue); sl@0: IMPORT_C TInt Create(TUint32 aKey, const TDesC8& aValue); sl@0: IMPORT_C TInt Create(TUint32 aKey, const TDesC16& aValue); sl@0: sl@0: IMPORT_C TInt Delete(TUint32 aKey); sl@0: IMPORT_C TInt Delete(TUint32 aPartialKey, TUint32 aMask, TUint32 &aErrorKey) ; sl@0: sl@0: IMPORT_C TInt Get(TUint32 aKey, TInt& aValue); sl@0: IMPORT_C TInt Set(TUint32 aKey, TInt aValue); sl@0: sl@0: IMPORT_C TInt Get(TUint32 aKey, TReal& aValue); sl@0: IMPORT_C TInt Set(TUint32 aKey, const TReal& aValue); sl@0: sl@0: IMPORT_C TInt Get(TUint32 aKey, TDes8& aValue); sl@0: IMPORT_C TInt Get(TUint32 aId, TDes8& aValue, TInt& aActualLength); sl@0: IMPORT_C TInt Set(TUint32 aKey, const TDesC8& aValue); sl@0: sl@0: IMPORT_C TInt Get(TUint32 aKey, TDes16& aValue); sl@0: IMPORT_C TInt Get(TUint32 aId, TDes16& aValue, TInt& aActualLength); sl@0: IMPORT_C TInt Set(TUint32 aKey, const TDesC16& aValue); sl@0: sl@0: IMPORT_C TInt GetMeta(TUint32 aKey, TUint32& aMeta); sl@0: sl@0: IMPORT_C TInt Move (TUint32 aSourcePartialKey, TUint32 aTargetPartialKey, sl@0: TUint32 aMask, TUint32 &aErrorKey) ; sl@0: sl@0: IMPORT_C TInt FindL(TUint32 aPartialKey, TUint32 aMask, sl@0: RArray& aFoundKeys); sl@0: sl@0: IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask, sl@0: TInt aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TReal& aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TDesC8& aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindEqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TDesC16& aValue, RArray& aFoundKeys); sl@0: sl@0: IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask, sl@0: TInt aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TReal& aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TDesC8& aValue, RArray& aFoundKeys); sl@0: IMPORT_C TInt FindNeqL(TUint32 aPartialKey, TUint32 aMask, sl@0: const TDesC16& aValue, RArray& aFoundKeys); sl@0: sl@0: IMPORT_C TInt NotifyRequest(TUint32 aKey, TRequestStatus& aStatus); sl@0: IMPORT_C TInt NotifyRequest(TUint32 aPartialKey, TUint32 aMask, sl@0: TRequestStatus& aStatus); sl@0: sl@0: IMPORT_C TInt NotifyCancel(TUint32 aKey); sl@0: IMPORT_C TInt NotifyCancel(TUint32 aPartialKey, TUint32 aMask); sl@0: IMPORT_C TInt NotifyCancelAll(); sl@0: sl@0: IMPORT_C TInt Reset(); sl@0: IMPORT_C TInt Reset(TUint32 aKey); sl@0: sl@0: IMPORT_C TInt StartTransaction(TTransactionMode aMode); sl@0: IMPORT_C void StartTransaction(TTransactionMode aMode, TRequestStatus& aStatus); sl@0: IMPORT_C TInt CommitTransaction(TUint32& aKeyInfo); sl@0: IMPORT_C void CommitTransaction(TDes8& aKeyInfo, TRequestStatus& aStatus); sl@0: IMPORT_C void CancelTransaction(); sl@0: IMPORT_C void CleanupCancelTransactionPushL(); sl@0: IMPORT_C void FailTransaction(); sl@0: IMPORT_C void CleanupFailTransactionPushL(); sl@0: sl@0: /** Same as CancelTransaction. sl@0: @see CancelTransaction sl@0: */ sl@0: inline void RollbackTransaction() sl@0: { sl@0: CancelTransaction(); sl@0: } sl@0: sl@0: /** Same as CleanupCancelTransactionPushL. sl@0: @see CleanupCancelTransactionPushL sl@0: */ sl@0: inline void CleanupRollbackTransactionPushL() sl@0: { sl@0: CleanupCancelTransactionPushL(); sl@0: } sl@0: }; sl@0: sl@0: #endif // __CENTRALREPOSITORY_H__