epoc32/include/mw/apengineconsts.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Used constants of the ApEngine.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef APENGINE_CONSTS_H
williamr@2
    20
#define APENGINE_CONSTS_H
williamr@2
    21
williamr@2
    22
// Deprecation warning
williamr@2
    23
#warning This header file has been deprecated. Will be removed in one of the next SDK releases.
williamr@2
    24
 
williamr@2
    25
 
williamr@2
    26
#include <ApEngineVer.h>
williamr@2
    27
williamr@2
    28
williamr@2
    29
// ERROR CODES
williamr@2
    30
// Used either as return values or leave codes. Apart from these, system error
williamr@2
    31
// codes can also be returned or leaved with.
williamr@2
    32
williamr@2
    33
/// Attempting to read or write a column which does not exists.
williamr@2
    34
const TInt  KErrInvalidColumn       = -300;
williamr@2
    35
williamr@2
    36
/// The given bearer is not valid.
williamr@2
    37
const TInt  KErrInvalidBearer       = -301;
williamr@2
    38
williamr@2
    39
/// The type of the database is not valid
williamr@2
    40
const TInt  KErrInvalidDatabaseType = -302;
williamr@2
    41
williamr@2
    42
/// The name of the AP is not valid (length = 0)
williamr@2
    43
const TInt  KErrInvalidName         = -303;
williamr@2
    44
williamr@2
    45
const TInt  KErrDescOverflow        = -304;
williamr@2
    46
williamr@2
    47
/// The passed pointer was invalid = NULL
williamr@2
    48
const TInt  KErrNullPointerPassed   = -305;
williamr@2
    49
williamr@2
    50
/// The filter is not valid
williamr@2
    51
const TInt  KErrInvalidFilterType   = -310;
williamr@2
    52
williamr@2
    53
/// The bearer is not valid
williamr@2
    54
const TInt  KErrInvalidBearerType   = -311;
williamr@2
    55
williamr@2
    56
/// The ISP type given is invalid
williamr@2
    57
const TInt  KErrInvalidIspRequest   = -312;
williamr@2
    58
williamr@2
    59
/// Used when the requested value was not specified in the database
williamr@2
    60
const TInt  KErrValueUnspecified    = -323;
williamr@2
    61
williamr@2
    62
const TInt  KApEngineMaxSql              = 255;
williamr@2
    63
williamr@2
    64
williamr@2
    65
williamr@2
    66
/// These constants are used to represent the sorting order used in CApSelect.
williamr@2
    67
const TInt  KEApSortUidAscending         = 0x00000001;  ///< The sorting is
williamr@2
    68
                                                        ///< done according to
williamr@2
    69
                                                        ///< the ID of the
williamr@2
    70
                                                        ///< access points in
williamr@2
    71
                                                        ///< ascending order.
williamr@2
    72
const TInt  KEApSortUidDescending        = 0x00000002;  ///< The sorting is
williamr@2
    73
                                                        ///< done according to
williamr@2
    74
                                                        ///< the ID of the
williamr@2
    75
                                                        ///< access points in
williamr@2
    76
                                                        ///< descending order.
williamr@2
    77
const TInt  KEApSortNameAscending        = 0x00000003;  ///< The sorting is
williamr@2
    78
                                                        ///< done according to
williamr@2
    79
                                                        ///< the name of the
williamr@2
    80
                                                        ///< access points in
williamr@2
    81
                                                        ///< ascending order.
williamr@2
    82
const TInt  KEApSortNameDescending       = 0x00000004;  ///< The sorting is
williamr@2
    83
                                                        ///< done according to
williamr@2
    84
                                                        ///< the name of the
williamr@2
    85
                                                        ///< access points in
williamr@2
    86
                                                        ///< descending order.
williamr@2
    87
williamr@2
    88
williamr@2
    89
/// These enums are used to represent one the filtering criterias in CApSelect.
williamr@2
    90
const TInt  KEApIspTypeInternetOnly     = 0x00000001;   ///< Filter allows only
williamr@2
    91
                                                        ///< access points that
williamr@2
    92
                                                        ///< are capable of
williamr@2
    93
                                                        ///< only internet
williamr@2
    94
                                                        ///< access.
williamr@2
    95
const TInt  KEApIspTypeWAPOnly          = 0x00000002;   ///< Filter allows only
williamr@2
    96
                                                        ///< access points that
williamr@2
    97
                                                        ///< are capable of
williamr@2
    98
                                                        ///< only WAP access.
williamr@2
    99
const TInt  KEApIspTypeInternetAndWAP   = 0x00000004;   ///< Filter allows only
williamr@2
   100
                                                        ///< access points that
williamr@2
   101
                                                        ///< are capable of
williamr@2
   102
                                                        ///< internet AND
williamr@2
   103
                                                        ///< WAP access.
williamr@2
   104
const TInt  KEApIspTypeWAPMandatory     = 0x00000008;   ///< Filter allows only
williamr@2
   105
                                                        ///< access points that
williamr@2
   106
                                                        ///< are capable of
williamr@2
   107
                                                        ///< WAP access AND
williamr@2
   108
                                                        ///< contain mandatory
williamr@2
   109
                                                        ///< WAP settings.
williamr@2
   110
const TInt  KEApIspTypeAll              = 0x00000010;   ///< No filtering is
williamr@2
   111
                                                        ///< done, all access
williamr@2
   112
                                                        ///< points are shown.
williamr@2
   113
const TInt  KEApIspTypeMMSMandatory     = 0x00000020;   ///< Filter allows only
williamr@2
   114
                                                        ///< access points that
williamr@2
   115
                                                        ///< are capable of MMS
williamr@2
   116
                                                        ///< and contain MMS
williamr@2
   117
                                                        ///< mandatory settings
williamr@2
   118
                                                        ///< Starting Page
williamr@2
   119
williamr@2
   120
williamr@2
   121
williamr@2
   122
williamr@2
   123
const TInt KModifiableTextLength        = 100;
williamr@2
   124
const TInt KModifiableLongTextLength    = 1000;
williamr@2
   125
williamr@2
   126
williamr@2
   127
// typedef
williamr@2
   128
enum TApBearerType      /// These enums are used to represent the possible
williamr@2
   129
                        /// bearer types and the filtering criteria
williamr@2
   130
                        /// in CApSelect.
williamr@2
   131
    {
williamr@2
   132
    EApBearerTypeCSD        = 0x00000001,   ///< Filter allows only access
williamr@2
   133
                                            ///< points that has CSD as bearer.
williamr@2
   134
    EApBearerTypeGPRS       = 0x00000002,   ///< Filter allows only access
williamr@2
   135
                                            ///< points that has GPRS as bearer
williamr@2
   136
    EApBearerTypeHSCSD      = 0x00000004,   ///< Filter allows only access
williamr@2
   137
                                            ///< points that has HSCSD
williamr@2
   138
                                            ///< as bearer.
williamr@2
   139
williamr@2
   140
// Will be deprecated, use EApBearerTypeAllBearers instead !
williamr@2
   141
    EApBearerTypeAll        = 0x00000008,   ///< No filtering is done,
williamr@2
   142
                                            ///< all access points are shown.
williamr@2
   143
                                            
williamr@2
   144
    EApBearerTypeCDMA       = 0x00000010,   ///< Filter allows only access
williamr@2
   145
                                            ///< points that has CDMA as bearer
williamr@2
   146
    EApBearerTypeWLAN       = 0x00000020,   ///< Filter allows only access
williamr@2
   147
                                            ///< points that has WLAN as bearer
williamr@2
   148
    EApBearerTypeLAN        = 0x00000040,   ///< Filter allows only access
williamr@2
   149
                                            ///< points that has LAN as bearer
williamr@2
   150
    EApBearerTypeLANModem   = 0x00000080,   ///< Filter allows only access
williamr@2
   151
                                            ///< points with LAN modem bearer
williamr@2
   152
    EApBearerTypeAllBearers = 0xffffffff    ///< No filtering is done,
williamr@2
   153
                                            ///< all access points are shown.
williamr@2
   154
    };
williamr@2
   155
williamr@2
   156
williamr@2
   157
enum TApCallSpeed       /// These enums are used to represent
williamr@2
   158
                        /// the connection speed.
williamr@2
   159
    {
williamr@2
   160
    KSpeedAutobaud=0x00000000,          ///< Autodetect
williamr@2
   161
    KSpeed9600=0x00000001,              ///< 9600
williamr@2
   162
    KSpeed14400=0x00000002,             ///< 14400
williamr@2
   163
    KSpeed19200=0x00000003,             ///< 19200
williamr@2
   164
    KSpeed28800=0x00000004,             ///< 28800
williamr@2
   165
    KSpeed38400=0x00000005,             ///< 38400
williamr@2
   166
    KSpeed43200=0x00000006,             ///< 43200
williamr@2
   167
    KSpeed56000=0x00000007              ///< 56000
williamr@2
   168
    };
williamr@2
   169
williamr@2
   170
williamr@2
   171
enum TApCallType        /// These enums are used to represent
williamr@2
   172
                        /// the conn. type Analogue/ISDNv110/ISDNv120
williamr@2
   173
    {
williamr@2
   174
    ECallTypeAnalogue,          ///< Analogue
williamr@2
   175
    ECallTypeISDNv110,          ///< ISDN v. 110
williamr@2
   176
    ECallTypeISDNv120           ///< ISDN v. 120
williamr@2
   177
    };
williamr@2
   178
williamr@2
   179
const TUint32 KMaxAnalogueSpeed    = KSpeed28800;
williamr@2
   180
const TUint32 KMaxIsdnSpeed        = KSpeed43200;
williamr@2
   181
williamr@2
   182
//if WCDMA is enabled, then the max speed are :
williamr@2
   183
const TUint32 KMaxAnalogueSpeedWcdma    = KSpeed28800;
williamr@2
   184
const TUint32 KMaxIsdnSpeedWdma         = KSpeed56000;
williamr@2
   185
williamr@2
   186
williamr@2
   187
enum TIPvType
williamr@2
   188
    {
williamr@2
   189
    EIPv4       = 1,
williamr@2
   190
    EIPv6       = 2
williamr@2
   191
    };
williamr@2
   192
williamr@2
   193
williamr@2
   194
enum TWlanNetMode
williamr@2
   195
    {
williamr@2
   196
    EAdhoc       = 0,
williamr@2
   197
    EInfra       = 1
williamr@2
   198
    };
williamr@2
   199
williamr@2
   200
williamr@2
   201
enum TWlanSecMode
williamr@2
   202
    {
williamr@2
   203
    EOpen       = 1,
williamr@2
   204
    EWep        = 2,
williamr@2
   205
    E802_1x     = 4,
williamr@2
   206
    EWpa        = 8,
williamr@2
   207
    EWpa2       = 16
williamr@2
   208
    };
williamr@2
   209
williamr@2
   210
williamr@2
   211
#define KApMaxConnNameLength            30
williamr@2
   212
williamr@2
   213
// The following constants are deprecated, DO NOT USE THEM!
williamr@2
   214
// DO NOT USE STARTS
williamr@2
   215
#define KApMaxGprsApNameLength          100
williamr@2
   216
#define KApMaxLoginNameLength           32
williamr@2
   217
#define KApMaxStartPageLength           1000
williamr@2
   218
#define KApMaxAccessNumLength           21
williamr@2
   219
#define KApCBInfoLength                 21
williamr@2
   220
#define KApMaxServiceCentreAddrLength   21
williamr@2
   221
#define KApMaxIpAddressLength           100
williamr@2
   222
#define KApMaxLoginScriptLength         1000
williamr@2
   223
#define KApMaxLoginPasswordLength       20
williamr@2
   224
// DO NOT USE ENDS
williamr@2
   225
williamr@2
   226
williamr@2
   227
_LIT( KSqlSelectNum, "SELECT %s from %s WHERE %s=%d" );
williamr@2
   228
_LIT( KSqlSelectBaseNum, "SELECT * from %s WHERE %s=%d" );
williamr@2
   229
williamr@2
   230
/// 'Dynamic' IP address to use in comparisons
williamr@2
   231
_LIT( KDynIpAddress, "0.0.0.0" );
williamr@2
   232
williamr@2
   233
/// A start page, which have to be considered as invalid.
williamr@2
   234
_LIT( KInvStartPage, "http://" );
williamr@2
   235
williamr@2
   236
/// A name for the 'location' to use
williamr@2
   237
_LIT( KLocation, "Mobile" );
williamr@2
   238
williamr@2
   239
williamr@2
   240
/// Modem bearer names for (HS)CSD Access Points
williamr@2
   241
_LIT( KModemBearerCSD, "CSD Modem" ); 
williamr@2
   242
williamr@2
   243
/// Modem bearer names for GPRS/WCDMA Access Points
williamr@2
   244
_LIT( KModemBearerGPRS, "GPRS Modem" );
williamr@2
   245
williamr@2
   246
/// Modem bearer names for CDMA Access Points
williamr@2
   247
_LIT( KModemBearerCDMA, "CDMA Modem" );
williamr@2
   248
williamr@2
   249
/// Modem bearer names for WLAN Access Points
williamr@2
   250
_LIT( KModemBearerWLAN, "WLANBearer" );
williamr@2
   251
williamr@2
   252
/// Modem bearer names for LAN Access Points
williamr@2
   253
_LIT( KModemBearerLAN, "LANBearer" );
williamr@2
   254
williamr@2
   255
/// Modem bearer names for LAN Modem Access Points
williamr@2
   256
_LIT( KModemBearerLANModem, "LANModem" );
williamr@2
   257
williamr@2
   258
williamr@2
   259
/// Number of retries that are used in database operations
williamr@2
   260
const TInt KRetryCount              = 5;
williamr@2
   261
williamr@2
   262
williamr@2
   263
/// Time to wait before retry database operation 
williamr@2
   264
// (==0.10 secs = 100000microsec.)
williamr@2
   265
#define KRetryWait  100000 /* in TTimeIntervalMicroSeconds32 */
williamr@2
   266
williamr@2
   267
// callback timeout in microseconds
williamr@2
   268
const TUint32 KCallBackTimeOut  = 60000000;
williamr@2
   269
williamr@2
   270
_LIT( KDynIpv6Address, "0:0:0:0:0:0:0:0" );
williamr@2
   271
williamr@2
   272
williamr@2
   273
_LIT( KDaemonManagerName, "NetCfgExtnDhcp" );
williamr@2
   274
_LIT( KConfigDaemonName, "!DhcpServ" );
williamr@2
   275
williamr@2
   276
williamr@2
   277
#endif
williamr@2
   278
williamr@2
   279
// End of File