1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // Header file for Phonebook Synchroniser common code. Contains definitions

    15 // of classes, methods and types used by both the client side and

    16 // server/engine side code.

    17 // 

    18 //

    19 

    20 /**

    21  @file

    22  @internalComponent

    23 */

    24 

    25 #ifndef __COMMON_H__

    26 #define __COMMON_H__

    27 

    28 

    29 /**

    30  *  Phonebook Sync Server and Background Sync Engine IPC requests.

    31  *

    32  *  @note When adding IPC Requests please update

    33  *        KPhonebookSyncRequestNames as well in the session files.

    34  */

    35 enum TPhonebookSyncRequest

    36 	{

    37 	ESyncDoSynchronisation,

    38 	ESyncGetContactFormat,

    39 	ESyncGetSyncMode,

    40 	ESyncSetSyncMode,

    41 	ESyncDeleteCntFromICC,

    42 	ESyncWriteCntToICC,

    43 	ESyncValidateContact,

    44 	ESyncUpdateLookupTable,

    45 	ESyncGetPhoneBookId,

    46 	ESyncGetCacheState,

    47 	ESyncDbgMarkHeap,

    48 	ESyncDbgCheckHeap,

    49 	ESyncDbgMarkEnd,

    50 	ESyncDbgFailNext,

    51 	ESyncDoSynchronisationCancel,

    52 	ESyncDeleteCntFromICCCancel,

    53 	ESyncWriteCntToICCCancel,

    54 	ESyncNotifyCacheStateChange,

    55 	ESyncNotifyCacheStateChangeCancel,

    56 	ESyncGetLastSyncError,

    57 	ESyncGetNumSlots,

    58 	ESyncGetNumFreeSlots,

    59 	ESyncGetFreeSlots,

    60 	ESyncGetSlotId,

    61 	ESyncFlushInterfaceQueue,

    62 	ESyncShutdownServer

    63 	};

    64 

    65 

    66 /**

    67  *  Panic codes.

    68  */

    69 enum TPhBkSyncPanic

    70 	{

    71 	EPhBkSyncPanicUnexpectedLeave = 0,

    72 	EPhBkSyncPanicCreateTrapCleanup = 1,

    73 	EPhBkSyncPanicSvrCreateServer = 2,

    74 	EPhBkSyncPanicSvrStartServer = 3,

    75 	EPhBkSyncPanicDoMultipleReadError = 4,

    76 	EPhBkSyncPanicDoIccWriteError = 5,

    77 	EPhBkSyncPanicDoIccDeleteError = 6,

    78 	EPhBkSyncPanicUpdateEntryInTableError = 7,

    79 	EPhBkSyncPanicGetPhoneStoreInfoError = 8,

    80 	EPhBkSyncPanicNotifySecurityEventError = 9,

    81 	EPhBkSyncPanicNotifySATUpdatesError = 10,

    82 	EPhBkSyncPanicNotifyAppInfoChangeError = 11,

    83 	EPhBkSyncPanicEnumerateUSimAppsError = 12,

    84 	EPhBkSyncPanicCancelSyncReqError = 13,

    85 	EPhBkSyncPanicConnecttoFileServerError = 14,

    86 	EPhBkSyncPanicIccUidError = 15,

    87 	EPhBkSyncPanicInvalidIniValue = 16,

    88  	EPhBkSyncPanicGroupIdAlreadySet = 17,

    89  	EPhBkSyncPanicGroupIdNotSet = 18,

    90  	EPhBkSyncPanicTemplateIdAlreadySet = 19,

    91  	EPhBkSyncPanicTemplateIdNotSet = 20,

    92  	EPhBkSyncPanicInvalidContactId = 21,

    93  	EPhBkSyncPanicContactIdNotNull = 22,

    94 	EPhBkSyncPanicNotifyLockInfoChangeError = 23,

    95 	EPhBkSyncPanicTooManyPhonebooks = 24,

    96 	EPhBkSyncPanicInvalidEngineRequest = 25,

    97 	EPhBkSyncPanicIllegalFunction = 26,

    98 	EPhBkSyncPanicBadDescriptor = 27,

    99 	EPhBkSyncPanicNullHandle = 28,

   100 	EPhBkSyncPanicHandleNotClosed = 29,

   101 	EPhBkSyncPanicNotificationAlreadyPending

   102 	};

   103 

   104 

   105 /**

   106  *  Panic function. Can be used to panic the server or client.

   107  */

   108 void PhBkSyncPanic(TPhBkSyncPanic aPanicCode);

   109 

   110 

   111 #endif // __COMMON_H__