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