epoc32/include/mw/cmplugindialcommondefs.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 cmplugindialcommondefs.h
     1 /*
       
     2 * Copyright (c) 2006 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:  Resource headers for Dial Plugins.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CMPLUGINDIALCOMMONDEFS_H
       
    19 #define CMPLUGINDIALCOMMONDEFS_H
       
    20 
       
    21 namespace CMManager
       
    22     {
       
    23     /// callback timeout in microseconds
       
    24     const TUint32 KCallBackTimeOut  = 60000000;
       
    25 
       
    26     enum TCmCallType                /// These enums are used to represent
       
    27                                     ///< the conn. type Analogue/ISDNv110/ISDNv120
       
    28         {
       
    29         ECmCallTypeAnalogue,          ///< Analogue
       
    30         ECmCallTypeISDNv110,          ///< ISDN v. 110
       
    31         ECmCallTypeISDNv120           ///< ISDN v. 120
       
    32         };
       
    33 
       
    34 
       
    35     enum TCmCallSpeed                       /// These enums are used to represent
       
    36                                             ///< the connection speed.
       
    37         {
       
    38         ECmSpeedAutobaud=0x00000000,          ///< Autodetect
       
    39         ECmSpeed9600=0x00000001,              ///< 9600
       
    40         ECmSpeed14400=0x00000002,             ///< 14400
       
    41         ECmSpeed19200=0x00000003,             ///< 19200
       
    42         ECmSpeed28800=0x00000004,             ///< 28800
       
    43         ECmSpeed38400=0x00000005,             ///< 38400
       
    44         ECmSpeed43200=0x00000006,             ///< 43200
       
    45         ECmSpeed56000=0x00000007              ///< 56000
       
    46         };
       
    47 
       
    48     /// indicated the end of the array in the following max speed array sets
       
    49     const TInt KEndOfArray = -1;
       
    50 
       
    51     /// the set of max speeds available for CSD analogue
       
    52     const TInt KCsdAnalogue[]       = { ECmSpeedAutobaud, ECmSpeed9600, 
       
    53                                         ECmSpeed14400, 
       
    54                                         KEndOfArray };
       
    55 
       
    56     /// the set of speeds available for CSD wcdma analogue
       
    57     const TInt KCsdAnalogueWcdma[]  = { ECmSpeedAutobaud, ECmSpeed9600, 
       
    58                                         ECmSpeed14400, ECmSpeed28800, 
       
    59                                         KEndOfArray};
       
    60 
       
    61     /// the set of speeds available for CSD idsn 110
       
    62     const TInt KCsdIsdn110[]        = { ECmSpeed9600, ECmSpeed14400, 
       
    63                                         KEndOfArray};
       
    64 
       
    65     /// the set of speeds available for CSD isdn 110 wcdma
       
    66     const TInt KCsdIsdn110Wcdma[]   = { ECmSpeed9600, ECmSpeed14400, 
       
    67                                         ECmSpeed28800, ECmSpeed38400, 
       
    68                                         KEndOfArray};
       
    69     
       
    70     /// the set of speeds available for CSD isdn 120
       
    71     const TInt KCsdIsdn120[]        = { ECmSpeed9600, ECmSpeed14400, 
       
    72                                         KEndOfArray};
       
    73 
       
    74     /// the set of speeds available for CSD isdn 120 wcdma
       
    75     const TInt KCsdIsdn120Wcdma[]   = { ECmSpeed9600, ECmSpeed14400, 
       
    76                                         ECmSpeed28800, ECmSpeed56000,
       
    77                                         KEndOfArray};
       
    78 
       
    79     /// the set of speeds available for HSCSD analogue
       
    80     const TInt KHcsdAnal[]          = { ECmSpeedAutobaud, ECmSpeed9600, 
       
    81                                         ECmSpeed14400, ECmSpeed19200, 
       
    82                                         ECmSpeed28800, KEndOfArray };
       
    83 
       
    84     /// the set of speeds available for HSCSD isdn 110
       
    85     const TInt KHcsdIsdn110[]       = { ECmSpeed9600, ECmSpeed14400, 
       
    86                                         ECmSpeed19200, ECmSpeed28800, 
       
    87                                         ECmSpeed38400, KEndOfArray};
       
    88 
       
    89     /// the set of speeds available for HSCSD isdn 120
       
    90     const TInt KHcsdIsdn120[]       = { ECmSpeed9600, ECmSpeed14400, 
       
    91                                         ECmSpeed19200, ECmSpeed28800,
       
    92                                         ECmSpeed43200, KEndOfArray};
       
    93 
       
    94     /**
       
    95     * These are the common attribute of every dial in/out
       
    96     * bearer types.
       
    97     */
       
    98     enum TConnectionMethodCsdHscsdCommonAttributes
       
    99         {
       
   100         EPluginDialAttribStart = 10000,     /**<
       
   101                                             * Marks the beginning of common dial
       
   102                                             * in/out attributes.
       
   103                                             */
       
   104         
       
   105         EDialOut = 10001,                   /**<
       
   106                                             * Dial out or in. ETrue means dial out.
       
   107                                             * (TBool - default: ETrue)
       
   108                                             */
       
   109                                             
       
   110         EDialCallType = 10002,              /**<
       
   111                                             * Call type. See acceptable values 
       
   112                                             * in TCmCallType.
       
   113                                             * (TUint32 - default: ECmCallTypeAnalogue )
       
   114                                             */
       
   115                                             
       
   116         EDialMaxConnSpeed = 10003,          /**<
       
   117                                             * Maximum speed. See acceptable values
       
   118                                             * in TCmCallSpeed.
       
   119                                             * (TUint32 - default: ECmSpeedAutobaud )
       
   120                                             */
       
   121         
       
   122         EDialDescription = 10100,           /**<
       
   123                                             * Application's description of ISP.
       
   124                                             * (String - default: none)
       
   125                                             */
       
   126 
       
   127         EDialType = 10101,                  /**<
       
   128                                             * Enum value indicating ISP type, 
       
   129                                             * e.g. Internet ISP, WAP ISP. 
       
   130                                             * Selected from TCommsDbIspType
       
   131                                             * (TUint32 - default: EIspTypeInternetAndWap)
       
   132                                             */
       
   133                                             
       
   134         EDialDefaultTelNum = 10102,         /**<
       
   135                                             * Default phone number.
       
   136                                             * (Only for dial out)
       
   137                                             * (String - default: none)
       
   138                                             */
       
   139                                             
       
   140         EDialDialResolution = 10103,        /**<
       
   141                                             * Perform dialling resolution for 
       
   142                                             * default phone number?
       
   143                                             * (Only for dial out)
       
   144                                             * (TBool - default: none)
       
   145                                             */
       
   146 
       
   147         EDialChargeCard = 10104,            /**<
       
   148                                             * Identifier of the chargecard in 
       
   149                                             * this ISP.
       
   150                                             * (Only for dial out)
       
   151                                             * (TUint32 - default: none)
       
   152                                             */
       
   153                                             
       
   154         EDialUseLoginScript = 10105,        /**<
       
   155                                             * Use login script?
       
   156                                             * (TBool - default: EFalse)
       
   157                                             */
       
   158                                             
       
   159         EDialLoginScript = 10106,           /**<
       
   160                                             * Login script (used if Use Login 
       
   161                                             * Script is ETrue)
       
   162                                             * (String - default: none)
       
   163                                             */
       
   164 
       
   165         EDialAuthentication = 10107,        /**<
       
   166                                             * UNUSED (will eventually point to 
       
   167                                             * some authentication table/group)
       
   168                                             * (Only for dial in)
       
   169                                             * (TUint32 - default: none)
       
   170                                             */
       
   171 
       
   172         EDialPromptForLogin = 10108,        /**<
       
   173                                             * Prompt user for username and password?
       
   174                                             * (Only for dial out)
       
   175                                             * (TBool - default: EFalse)
       
   176                                             */
       
   177                                             
       
   178         EDialLoginName = 10109,             /**<
       
   179                                             * Login name.
       
   180                                             * (Only for dial out)
       
   181                                             * (String - default: none)
       
   182                                             */
       
   183                                             
       
   184         EDialLoginPassword = 10110,         /**<
       
   185                                             * Login password.
       
   186                                             * (Only for dial out)
       
   187                                             * (String - default: none)
       
   188                                             */
       
   189                                             
       
   190         EDialDisplayPCT = 10111,            /**<
       
   191                                             * Display PCT (without scanning 
       
   192                                             * script for READ command)?
       
   193                                             * (Only for dial out)
       
   194                                             * (TBool - default: none)
       
   195                                             */
       
   196                                             
       
   197         EDialIFParams = 10112,              /**<
       
   198                                             * Interface parameter string.
       
   199                                             * (String - default: none)
       
   200                                             */
       
   201                                             
       
   202         EDialIFNetworks = 10113,            /**<
       
   203                                             * Comma separated list of network 
       
   204                                             * protocols, e.g. "PPP"
       
   205                                             * (String - default: none)
       
   206                                             */
       
   207                                             
       
   208         EDialIFPromptForAuth = 10114,       /**<
       
   209                                             * Prompt user for authentication 
       
   210                                             * username and password?
       
   211                                             * (Only for dial out)
       
   212                                             * (TBool - default: EFalse)
       
   213                                             */
       
   214                                             
       
   215         EDialIFAuthName = 10115,            /**<
       
   216                                             * Authentication username used by PPP
       
   217                                             * (Only for dial out)
       
   218                                             * (String - default: none)
       
   219                                             */
       
   220                                             
       
   221         EDialIFAuthPass = 10116,            /**<
       
   222                                             * Authentication password used by PPP
       
   223                                             * (Only for dial out)
       
   224                                             * (String - default: none)
       
   225                                             */
       
   226                                             
       
   227         EDialIFAuthRetries = 10117,         /**<
       
   228                                             * Number of times to retry 
       
   229                                             * authentication if it fails.
       
   230                                             * (TUint32 - default: none)
       
   231                                             */
       
   232                                             
       
   233         EDialIFCallbackEnabled = 10118,     /**<
       
   234                                             * Callback enabled?
       
   235                                             * (Only for dial out)
       
   236                                             * (TBool - default: none)
       
   237                                             */
       
   238                                             
       
   239         EDialIFCallbackType = 10119,        /**<
       
   240                                             * Enum value indicating type of 
       
   241                                             * callback (if enabled). 
       
   242                                             * Selected from TCallbackAction.
       
   243                                             * (Only for dial out)
       
   244                                             * (TUint32 - default: none)
       
   245                                             */
       
   246                                             
       
   247         EDialIFCallbackInfo = 10120,        /**<
       
   248                                             * Info for callback request (if enabled)
       
   249                                             * This is an 8-bit string!
       
   250                                             * (Only for dial out)
       
   251                                             * (String - default: none)
       
   252                                             */
       
   253                                             
       
   254         EDialCallbackTimeout = 10121,       /**<
       
   255                                             * Time to wait for callback in 
       
   256                                             * microseconds (if enabled)
       
   257                                             * (Only for dial out)
       
   258                                             * (TUint32 - default: none)
       
   259                                             */
       
   260 
       
   261         EDialIFServerMode = 10122,          /**<
       
   262                                             * When PPP is configured as a server.
       
   263                                             * (Only for dial out)
       
   264                                             * (TBool - default: none)
       
   265                                             */
       
   266                                             
       
   267         EDialIPAddressFromServer = 10123,   /**<
       
   268                                             * Get IP address from server?
       
   269                                             * (TBool - default: none)
       
   270                                             */
       
   271                                             
       
   272         EDialIPAddress = 10124,             /**<
       
   273                                             * IP address of interface
       
   274                                             * (String - default: none)
       
   275                                             */
       
   276                                             
       
   277         EDialIPNetmask = 10125,             /**<
       
   278                                             * IP net mask of interface
       
   279                                             * (String - default: none)
       
   280                                             */
       
   281                                             
       
   282         EDialIPGateway = 10126,             /**<
       
   283                                             * IP address of gateway.
       
   284                                             * (String - default: none)
       
   285                                             */
       
   286                                             
       
   287         EDialIPDNSAddressFromServer = 10127,/**<
       
   288                                             * Get DNS addresses from server?
       
   289                                             * (TBool - default: none)
       
   290                                             */
       
   291                                             
       
   292         EDialIPNameServer1 = 10128,         /**<
       
   293                                             * IP Address of primary name server.
       
   294                                             * (String - default: none)
       
   295                                             */
       
   296                                             
       
   297         EDialIPNameServer2 = 10129,         /**<
       
   298                                             * IP Address of secondary name server.
       
   299                                             * (String - default: none)
       
   300                                             */
       
   301                                             
       
   302         EDialIP6DNSAddressFromServer = 10130,/**<
       
   303                                             * Get IP6 DNS addresses from server?
       
   304                                             * (TBool - default: none)
       
   305                                             */
       
   306                                             
       
   307         EDialIP6NameServer1 = 10131,        /**<
       
   308                                             * IP6 Address of primary name server
       
   309                                             * (String - default: none)
       
   310                                             */
       
   311                                             
       
   312         EDialIP6NameServer2 = 10132,        /**<
       
   313                                             * IP6 Address of secondary name server
       
   314                                             * (String - default: none)
       
   315                                             */
       
   316                                             
       
   317         EDialIPAddressLeaseValidFrom = 10133,/**<
       
   318                                             * IP address valid from this time, 
       
   319                                             * used to store dynamically assigned 
       
   320                                             * address lease info.
       
   321                                             * (Only for dial out)
       
   322                                             * (String - default: none)
       
   323                                             */
       
   324                                             
       
   325         EDialIPAddressLeaseValidTo = 10134, /**<
       
   326                                             * IP address valid for use until 
       
   327                                             * this time, used to store dynamically 
       
   328                                             * assigned address lease info.
       
   329                                             * (Only for dial out)
       
   330                                             * (String - default: none)
       
   331                                             */
       
   332                                             
       
   333         EDialConfigDaemonManagerName = 10135,/**<
       
   334                                             * Name of the ECOM configuration daemon 
       
   335                                             * manager component. This component 
       
   336                                             * interfaces with the server identified 
       
   337                                             * in ISP_CONFIG_DAEMON_NAME. 
       
   338                                             * If specified, ISP_CONFIG_DAEMON_NAME 
       
   339                                             * should also be specified.
       
   340                                             * (Only for dial out)
       
   341                                             * (String - default: none)
       
   342                                             */
       
   343                                             
       
   344         EDialConfigDaemonName = 10136,      /**<
       
   345                                             * Name of the configuration daemon 
       
   346                                             * server. This server is used to 
       
   347                                             * provide further configuration for 
       
   348                                             * a connection, e.g. dynamic IP address 
       
   349                                             * assignment. If specified, 
       
   350                                             * ISP_CONFIG_DAEMON_MANAGER_NAME 
       
   351                                             * should also be specified.
       
   352                                             * (Only for dial out)
       
   353                                             * (String - default: none)
       
   354                                             */
       
   355                                             
       
   356         EDialEnableIPHeaderComp = 10137,    /**<
       
   357                                             * Enable IP header compression?
       
   358                                             * (TBool - default: none)
       
   359                                             */
       
   360                                             
       
   361         EDialEnableLCPExtension = 10138,    /**<
       
   362                                             * Enable LCP extension?
       
   363                                             * (TBool - default: none)
       
   364                                             */
       
   365                                             
       
   366         EDialDisablePlainTextAuth = 10139,  /**<
       
   367                                             * Disable plain text authentication?
       
   368                                             * (TBool - default: none)
       
   369                                             */
       
   370 
       
   371         EDialEnableSWComp = 10140,          /**<
       
   372                                             * Enable software compression 
       
   373                                             * (e.g. Microsoft, STAC or Predictor 
       
   374                                             * compression)?
       
   375                                             * (TBool - default: none)
       
   376                                             */
       
   377 
       
   378         EDialBearerName = 10141,            /**<
       
   379                                             * Enum value specifying the name of the 
       
   380                                             * bearer, e.g. Asynchronous Modem.
       
   381                                             * Selected from 
       
   382                                             * RBasicGsmCall::TBearerName
       
   383                                             * (TUint32 - default: none)
       
   384                                             */
       
   385 
       
   386         EDialBearerSpeed = 10142,           /**<
       
   387                                             * Enum value specifying the bearer speed 
       
   388                                             * from RBasicGsmCall::TBearerSpeed
       
   389                                             * (TUint32 - default: none)
       
   390                                             */
       
   391 
       
   392         EDialBearerCE = 10143,              /**<
       
   393                                             * Enum value specifying the bearer CE, 
       
   394                                             * e.g. non-transparent. 
       
   395                                             * Selected from RbasicGsmCall::TBearerCE
       
   396                                             * (TUint32 - default: none)
       
   397                                             */
       
   398 
       
   399         EDialInitString = 10144,            /**<
       
   400                                             * Modem initialisation string to be used 
       
   401                                             * when this ISP is in use. 
       
   402                                             * This string is copied into the 
       
   403                                             * MODEM_ISP_INIT_STRING 
       
   404                                             * field by NetDial.
       
   405                                             * 8bit string!
       
   406                                             * (String- default: none)
       
   407                                             */
       
   408 
       
   409         EDialBearerService = 10145,         /**<
       
   410                                             * Enum of type 
       
   411                                             * RMobileCall::TMobileCallDataService.
       
   412                                             * (Only for dial out)
       
   413                                             * (TUint32 - default: none)
       
   414                                             */
       
   415 
       
   416         EDialBearerProtocol = 10146,        /**<
       
   417                                             * Enum of type 
       
   418                                             * RMobileCall::TMobileCallDataProtocol.
       
   419                                             * (Only for dial out)
       
   420                                             * (TUint32 - default: none)
       
   421                                             */
       
   422 
       
   423         EDialRLPVersion = 10147,            /**<
       
   424                                             * Enum of type 
       
   425                                             * RMobileCall::TMobileCallDataRLPVersion.
       
   426                                             * (Only for dial out)
       
   427                                             * (TUint32 - default: none)
       
   428                                             */
       
   429 
       
   430         EDialIWFtoMS = 10148,               /**<
       
   431                                             * Integer specifying network to 
       
   432                                             * MS window size.
       
   433                                             * (Only for dial out)
       
   434                                             * (TUint32 - default: none)
       
   435                                             */
       
   436 
       
   437         EDialMStoIWF = 10149,               /**<
       
   438                                             * Integer specifying MS to network 
       
   439                                             * window size.
       
   440                                             * (Only for dial out)
       
   441                                             * (TUint32 - default: none)
       
   442                                             */
       
   443 
       
   444         EDialAckTimer = 10150,              /**<
       
   445                                             * Integer specifying rlp ack timeout in 
       
   446                                             * microseconds.
       
   447                                             * (Only for dial out)
       
   448                                             * (TUint32 - default: none)
       
   449                                             */
       
   450 
       
   451         EDialRetransmissionAttempts = 10151,/**<
       
   452                                             * Integer specifying rlp retransmission 
       
   453                                             * attempts.
       
   454                                             * (Only for dial out)
       
   455                                             * (TUint32 - default: none)
       
   456                                             */
       
   457 
       
   458         EDialResequencePeriod = 10152,      /**<
       
   459                                             * Integer specifying resequencing 
       
   460                                             * period.
       
   461                                             * (Only for dial out)
       
   462                                             * (TUint32 - default: none)
       
   463                                             */
       
   464 
       
   465         EDialV42Compression = 10153,        /**<
       
   466                                             * Enum of type TMobileCallDataV42bis.
       
   467                                             * (Only for dial out)
       
   468                                             * (TUint32 - default: none)
       
   469                                             */
       
   470 
       
   471         EDialV42CodeWords = 10154,          /**<
       
   472                                             * Integer specifying V42bis codewords.
       
   473                                             * (Only for dial out)
       
   474                                             * (TUint32 - default: none)
       
   475                                             */
       
   476 
       
   477         EDialV42MaxLength = 10155,          /**<
       
   478                                             * Integer specifying V42bis maximum 
       
   479                                             * string length.
       
   480                                             * (Only for dial out)
       
   481                                             * (TUint32 - default: none)
       
   482                                             */
       
   483 
       
   484         EDialUseEdge = 10156,               /**<
       
   485                                             * EDGE parameter used by GSM.
       
   486                                             * (TBool - default: none)
       
   487                                             */
       
   488                                             
       
   489         EPluginDialAttribRangeMax = 19999   /**<
       
   490                                             * Marks the end of common dial
       
   491                                             * in/out attributes.
       
   492                                             */
       
   493         };
       
   494 
       
   495 
       
   496 
       
   497     } // namespace CMManager
       
   498 
       
   499 #endif // CMPLUGINDIALCOMMONDEFS_H