messagingfw/msgsrvnstore/server/inc/MSERVER.H
changeset 62 db3f5fa34ec7
equal deleted inserted replaced
60:9f5ae1728557 62:db3f5fa34ec7
       
     1 // Copyright (c) 1998-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 //
       
    15 
       
    16 #ifndef __MSERVER_H__
       
    17 #define __MSERVER_H__
       
    18 
       
    19 #if !defined(__E32BASE_H__)
       
    20 #include <e32base.h>
       
    21 #endif
       
    22 
       
    23 #if !defined(__MSVSTD_H__)
       
    24 #include <msvstd.h>
       
    25 #endif
       
    26 
       
    27 
       
    28 
       
    29 // Server name, semaphore, and startup exe
       
    30 _LIT(KMsvServerSemaphore, "MsvStartupSemaphore");
       
    31 
       
    32 // A version must be specifyed when creating a session with the server
       
    33 const TUint KMsvServerMajorVersionNumber=1;
       
    34 const TUint KMsvServerMinorVersionNumber=4;
       
    35 const TUint KMsvServerBuildVersionNumber=0;
       
    36 
       
    37 
       
    38 // server request slots
       
    39 const TInt KMsvNumberOfSlots=14;
       
    40 const TInt KMsvMaxSlotsAvailable=KMsvNumberOfSlots-1; // reserved for change notification
       
    41 
       
    42 // Opcodes used in message passing between client and server
       
    43 /**
       
    44 @internalComponent
       
    45 @released
       
    46 */
       
    47 enum TMsvServerRqst 
       
    48 	{
       
    49 	// Entry related (Sync)
       
    50 	EMsvGetEntry=0,
       
    51 	EMsvGetChildren=1,
       
    52 	EMsvGetRemainingChildren=2,
       
    53 	EMsvLockEntry=3, 
       
    54 	EMsvReleaseEntry=4,
       
    55 //	EMsvMakeFileDirectory=5,  // Not used
       
    56 	// Entry related (Async)
       
    57 	EMsvChangeEntry=6,
       
    58 	EMsvCreateEntry=7,
       
    59 	// Entry/Entries related (Async)
       
    60 	EMsvDeleteEntries=8,
       
    61 	EMsvMoveEntries=9,
       
    62 	EMsvCopyEntries=10,
       
    63 	// Observer related (Async)
       
    64 	EMsvNotifySessionEvent=11,
       
    65 	// Observer related (Sync)
       
    66 	EMsvCancelSessionEventNotification=12,
       
    67 	// Store related (Sync)
       
    68 	EMsvReadStore=13,
       
    69 	EMsvLockStore=14,
       
    70 	EMsvReleaseStore=15,
       
    71 //	EMsvCommittedStore=16, // Not used
       
    72 	// Operation related (Sync)
       
    73 	EMsvOperationData=18,
       
    74 	EMsvCommandData=19,
       
    75 	EMsvCancelOperation=20,
       
    76 	EMsvOperationProgress=21,
       
    77 	EMsvOperationCompletion=22,
       
    78 	EMsvOperationMtm=23,
       
    79 	EMsvMtmCommand=24,
       
    80 	// MTM related
       
    81 	EMsvFillRegisteredMtmDllArray=25,
       
    82 	EMsvInstallMtmGroup=26,
       
    83 	EMsvDeInstallMtmGroup=27,
       
    84 	EMsvUseMtmGroup=28,
       
    85 	EMsvReleaseMtmGroup=29,
       
    86 	EMsvGetMtmGroupData=30,
       
    87 	// closes the server
       
    88 	EMsvCloseServer=31,
       
    89 	// service related
       
    90 	EMsvStopService=32,
       
    91 	EMsvServiceActive=33,
       
    92 	EMsvServiceProgress=34,
       
    93 	// misc
       
    94 	EMsvRemoveEntry=35,
       
    95 	// added after functional freeze
       
    96 //	EMsvCreatedStore=36, // Not used
       
    97 	EMsvGetMessageDirectory=37,
       
    98 	EMsvSlotAvailable=38,
       
    99 	// ER5U+
       
   100 	EMsvSetSessionAsObserver=39,
       
   101 	EMsvSetFailure=40,
       
   102 	EMsvChangeAttributes=41,
       
   103 	EMsvGetChildIds=42,
       
   104 	EMsvChangeDrive=43,
       
   105 	EMsvOutstandingOperations=44,
       
   106 	EMsvGetNotifySequence=45,
       
   107 	// added in 6.1, allows client to say that it does/doesn't want entry events
       
   108 	EMsvSetReceiveEntyEvents=49,
       
   109 	EMsvDecStoreReaderCount=50,
       
   110 	EMsvGetMessageDrive=51,
       
   111 	EMsvGetMtmRequiredCapabilities=52,
       
   112 	EMsvCreateAttachmentForWrite=53,
       
   113 	EMsvOpenAttachment=54,
       
   114 	EMsvOpenAttachmentForWrite=55,
       
   115 	EMsvDeleteAttachment=56,
       
   116 	EMsvOpenFileStoreForRead=57,
       
   117 	EMsvOpenTempStoreFile=58,
       
   118 	EMsvReplaceFileStore=59,
       
   119 	EMsvDeleteFileStore=60,
       
   120 	EMsvFileStoreExists=61,
       
   121 	EMsvGetAndClearIndexCorruptFlag=62,
       
   122 	EMsvCopyStore=63,
       
   123 	EMsvDeleteStore=64,
       
   124 	EMsvDriveContainsStore=65,
       
   125 	EMsvMessageStoreDrivePresent=66,
       
   126 	EMsvFileExists=67,
       
   127 	EMsvRenameAttachment=68,
       
   128 	EMsvReplaceAttachmentForWrite=69,
       
   129 	EMsvGetAttachmentFilePath=70,
       
   130 	EMsvOperationSystemProgress=71,
       
   131 	EMsvGetBodyTextFilePath=72,
       
   132 	EMsvOpenTextFileForRead=73,
       
   133 	EMsvCreatePlainTextFile=74,
       
   134 	EMsvDeletePlainTextFile=75,
       
   135 	EMsvReplacePlainTextFile=76,
       
   136 	EMsvGetNonOperationMtmData=77,
       
   137 	EMsvSearchSortOperation=78,
       
   138 	EMsvQueryData=79,
       
   139 	EMsvGetResult=80,
       
   140 	EMsvSearchSortOnIndexEntry=81,
       
   141 	EMsvGetQueryId=82,
       
   142 	EMsvUnmarQueryId=83,
       
   143 	EMsvSearchSortQueryId=84,
       
   144 	EMsvGetIdsOrResult=85,
       
   145 	EMsvGetResultCount=86,
       
   146 	EMsvGetNextId=87,
       
   147 	EMsvGetNextEntry=88,
       
   148 	EMsvIdWithSortFiled=89,
       
   149 	EMsvGetSearchSortProgress=90,
       
   150 	EMsvCancelSearchSortOp=91,
       
   151 	EMsvUpdateAndSort=92,
       
   152 	// Code added for PREQ 557.
       
   153 	// Macros for preferred drive list APIs.
       
   154 #if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)
       
   155     ,EMsvGetCurrentDriveInfo=94,
       
   156     EMsvGetDriveList=95,
       
   157     EMsvGetAvailableDriveList=96,
       
   158     EMsvAddDriveToDriveList=97,
       
   159     EMsvRemoveDriveFromDriveList=98,
       
   160     EMsvUpdateDrivePriority=99,
       
   161     EMsvGetChildrenALL=100,
       
   162     EMsvGetChildIdsALL=101
       
   163 #if (defined SYMBIAN_MESSAGESTORE_UNIT_TESTCODE)
       
   164 	,EMsvResetRepository=102,
       
   165 	EMsvPrintCache=103,
       
   166 #endif
       
   167 #endif		// #if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)
       
   168 
       
   169 #if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)
       
   170 	,EMsvCreateStore=104,
       
   171 	EMsvCheckStoreExists=105,
       
   172 	EMsvLastErrorMessage=106,
       
   173 	EMsvCreateHeaderEntry=107,
       
   174 	EMsvLoadHeaderEntry=108,
       
   175 	EMsvUpdateHeaderEntry=109,
       
   176 	EMsvDeleteHeaderEntry=110,
       
   177 	EMsvCheckAnyStoreExists=111,
       
   178 	EMsvCheckHeaderTableExist=112,
       
   179 
       
   180 	EMsvConvertMessageStore=113,
       
   181 	EMsvCancelConversionRequest=114,
       
   182 	EMsvGetConvertibleDriveList=115,
       
   183 	EMsvGetConversionStatus=116,
       
   184 #endif
       
   185 	EMsvChangeEntries = 117
       
   186 	};
       
   187 
       
   188 
       
   189 #endif
       
   190