cbs/cbsserver/ServerInc/CbsServerConstants.h
author hgs
Fri, 06 Aug 2010 13:08:23 +0300
changeset 36 7c428525956b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Contains constants (version number, request codes) used by the server.*
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef CBSSERVERCONSTANTS_H
hgs
parents:
diff changeset
    19
#define CBSSERVERCONSTANTS_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
//  INCLUDES
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
#include "CbsCommon.h"
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
//  CONSTANTS
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// How long to wait if the server was locked by backup. Time in microseconds. 
hgs
parents:
diff changeset
    29
const TInt KTimeToWaitForBackup = 100000;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// How many times to retry if the server is locked.
hgs
parents:
diff changeset
    32
const TInt KMaxRetryTimes = 50;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
// Name of CbsServer thread
hgs
parents:
diff changeset
    35
_LIT( KCbsServerName, "CbsServer" );
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
// Server major version number
hgs
parents:
diff changeset
    38
const TInt KCbsServerVersionMajor  =   1;
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
// Server minor version number
hgs
parents:
diff changeset
    41
const TInt KCbsServerVersionMinor  =   2;
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
// Server build number
hgs
parents:
diff changeset
    44
const TInt KCbsServerVersionBuild  =   0;
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
/**
hgs
parents:
diff changeset
    47
*   Enumeration of client requests.
hgs
parents:
diff changeset
    48
*/
hgs
parents:
diff changeset
    49
enum TCbsServerRequest
hgs
parents:
diff changeset
    50
    {
hgs
parents:
diff changeset
    51
    // RCbs requests
hgs
parents:
diff changeset
    52
    ECbsCloseSession,
hgs
parents:
diff changeset
    53
    ECbsCreateSettingsSubsession,
hgs
parents:
diff changeset
    54
    ECbsCreateTopicListSubsession,
hgs
parents:
diff changeset
    55
    ECbsCreateTopicMessagesSubsession,
hgs
parents:
diff changeset
    56
    ECbsCreateTopicCollectionSubsession,
hgs
parents:
diff changeset
    57
    ECbsShutdown,
hgs
parents:
diff changeset
    58
    
hgs
parents:
diff changeset
    59
    // RCbsSettings subsession requests
hgs
parents:
diff changeset
    60
    ECbsCloseSettingsSubsession,
hgs
parents:
diff changeset
    61
    ECbsSetReceptionStatus,
hgs
parents:
diff changeset
    62
    ECbsGetReceptionStatus,
hgs
parents:
diff changeset
    63
    ECbsSetTopicDetectionStatus,
hgs
parents:
diff changeset
    64
    ECbsGetTopicDetectionStatus,
hgs
parents:
diff changeset
    65
    ECbsGetLanguages,
hgs
parents:
diff changeset
    66
    ECbsSetLanguages,
hgs
parents:
diff changeset
    67
    ECbsNotifySettingsChanged,
hgs
parents:
diff changeset
    68
    ECbsNotifySettingsChangedCancel,
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    // RCbsTopicList subsession requests
hgs
parents:
diff changeset
    71
    ECbsCloseTopicListSubsession,
hgs
parents:
diff changeset
    72
    ECbsGetTopicCount,
hgs
parents:
diff changeset
    73
    ECbsGetTopic,
hgs
parents:
diff changeset
    74
    ECbsFindTopicByNumber,
hgs
parents:
diff changeset
    75
    ECbsDeleteTopic,
hgs
parents:
diff changeset
    76
    ECbsAddTopic,
hgs
parents:
diff changeset
    77
    ECbsChangeTopicNameAndNumber,
hgs
parents:
diff changeset
    78
    ECbsChangeTopicSubscriptionStatus,
hgs
parents:
diff changeset
    79
    ECbsChangeTopicHotmarkStatus,
hgs
parents:
diff changeset
    80
    ECbsNotifyOnEvent,
hgs
parents:
diff changeset
    81
    ECbsNotifyOnEventCancel,
hgs
parents:
diff changeset
    82
    ECbsGetNewTopicsCount,
hgs
parents:
diff changeset
    83
    ECbsGetLatestTopicNumber,
hgs
parents:
diff changeset
    84
    ECbsGetUnreadMessageCount,
hgs
parents:
diff changeset
    85
    ECbsGetHotmarkedMessageHandle,
hgs
parents:
diff changeset
    86
    ECbsGetUnreadHotmarkedMessageCount,
hgs
parents:
diff changeset
    87
    ECbsDeleteAll,
hgs
parents:
diff changeset
    88
    ECbsGetNextAndPrevTopicNumber,
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    // RCbsTopicMessages subsession requests
hgs
parents:
diff changeset
    91
    ECbsCloseTopicMessagesSubsession,
hgs
parents:
diff changeset
    92
    ECbsGetMessageCount,
hgs
parents:
diff changeset
    93
    ECbsGetMessage,
hgs
parents:
diff changeset
    94
    ECbsFindMessageByHandle,
hgs
parents:
diff changeset
    95
    ECbsGetMessageIndexByHandle,
hgs
parents:
diff changeset
    96
    ECbsDeleteMessage,
hgs
parents:
diff changeset
    97
    ECbsSaveMessage,
hgs
parents:
diff changeset
    98
    ECbsReadMessage,
hgs
parents:
diff changeset
    99
    ECbsLockMessage,
hgs
parents:
diff changeset
   100
    ECbsGetMessageContents,
hgs
parents:
diff changeset
   101
    ECbsGetNextAndPrevMsgHandle,
hgs
parents:
diff changeset
   102
        
hgs
parents:
diff changeset
   103
    // RCbsTopicCollection subsession requests
hgs
parents:
diff changeset
   104
    ECbsCloseTopicCollectionSubsession,
hgs
parents:
diff changeset
   105
    ECbsGetTopicInfoCount,
hgs
parents:
diff changeset
   106
    ECbsGetTopicInfo,
hgs
parents:
diff changeset
   107
    ECbsGetTopicInfoCountNotListed,
hgs
parents:
diff changeset
   108
    ECbsTopicInList,
hgs
parents:
diff changeset
   109
    ECbsNotifyOnChange,
hgs
parents:
diff changeset
   110
    ECbsNotifyOnChangeCancel,
hgs
parents:
diff changeset
   111
    ECbsGetUnlistedTopicIndexies,
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
    // RCbsMcnSession requests
hgs
parents:
diff changeset
   114
    EMcnCreateSubsession,
hgs
parents:
diff changeset
   115
    EMcnCloseSession,
hgs
parents:
diff changeset
   116
    EMcnNotifyOnChange,
hgs
parents:
diff changeset
   117
    EMcnNotifyOnChangeCancel,
hgs
parents:
diff changeset
   118
    EMcnGetCellInfo,
hgs
parents:
diff changeset
   119
    EMcnSubscribeTopic,
hgs
parents:
diff changeset
   120
    EMcnClearSubscriptions,
hgs
parents:
diff changeset
   121
    EMcnNoMoreSubscriptions,
hgs
parents:
diff changeset
   122
    EMcnCloseSubsession,
hgs
parents:
diff changeset
   123
    EMcnGetInfoMessage
hgs
parents:
diff changeset
   124
    };
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
// Number of message slots used in server-client ITC.
hgs
parents:
diff changeset
   127
const TInt KCbsServerDefaultSlots = 4;
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
// Header size of a CB message page in bytes.
hgs
parents:
diff changeset
   130
const TInt KCbsCbMsgHeaderSize = 6;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
// Maximum characters in page
hgs
parents:
diff changeset
   133
const TInt KCbsMaxCharsInPage = 93;
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
//  DATA TYPES  
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
// Used by RCbs::GetNextAndPrevTopicNumber to transfer request results
hgs
parents:
diff changeset
   138
// from server to client.
hgs
parents:
diff changeset
   139
struct TCbsNextPrevTopicAndPosition
hgs
parents:
diff changeset
   140
    {
hgs
parents:
diff changeset
   141
    TCbsTopicNumber iPrevTopic;
hgs
parents:
diff changeset
   142
    TCbsTopicNumber iNextTopic;
hgs
parents:
diff changeset
   143
    TInt iPosition;
hgs
parents:
diff changeset
   144
    };
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
// Used by RCbs::GetNextAndPrevMsgHandle to transfer request results
hgs
parents:
diff changeset
   147
// from server to client.
hgs
parents:
diff changeset
   148
struct TCbsNextPrevMsgAndPosition
hgs
parents:
diff changeset
   149
    {
hgs
parents:
diff changeset
   150
    TCbsMessageHandle iPrevMsg;
hgs
parents:
diff changeset
   151
    TCbsMessageHandle iNextMsg;
hgs
parents:
diff changeset
   152
    TInt iPosition;
hgs
parents:
diff changeset
   153
    };
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
// Used by active objects to determine the command type.
hgs
parents:
diff changeset
   156
enum TCbsServerEtelCommand
hgs
parents:
diff changeset
   157
    {
hgs
parents:
diff changeset
   158
    ECbsReceiveMessage,
hgs
parents:
diff changeset
   159
    ECbsSetFilterSetting,
hgs
parents:
diff changeset
   160
    ECbsGetLanguageFilter,
hgs
parents:
diff changeset
   161
    ECbsSetLanguageFilter,
hgs
parents:
diff changeset
   162
    ECbsRetrieveBroadcastIdList,
hgs
parents:
diff changeset
   163
    ECbsStoreBroadcastIdList,
hgs
parents:
diff changeset
   164
    ECbsBroadcastListCancelAll,
hgs
parents:
diff changeset
   165
    ECbsCommandTypeNotSet
hgs
parents:
diff changeset
   166
    };
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
// District info message topic.
hgs
parents:
diff changeset
   169
const TInt KCellInfoTopic = 50;
hgs
parents:
diff changeset
   170
hgs
parents:
diff changeset
   171
// HomeZone message topic.
hgs
parents:
diff changeset
   172
const TInt KHomeZoneTopic = 221;
hgs
parents:
diff changeset
   173
hgs
parents:
diff changeset
   174
#endif      //  CBSSERVERCONSTANTS_H   
hgs
parents:
diff changeset
   175
            
hgs
parents:
diff changeset
   176
// End of File
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178