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