ipappsrv_plat/nat_settings_api/inc/unsafprotocolscrkeys.h
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     1 /*
       
     2 * Copyright (c) 2008 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 "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 #ifndef UNSAFPROTOCOLSCRKEYS_H
       
    23 #define UNSAFPROTOCOLSCRKEYS_H
       
    24 
       
    25 
       
    26 #include <e32std.h>
       
    27 
       
    28 
       
    29 /**
       
    30  * Defines configuration parameters used by the UNSAF Protocols.
       
    31  */
       
    32 const TUid KCRUidUNSAFProtocols = { 0x102747d2 };
       
    33 
       
    34 
       
    35 /*
       
    36  * Mask for the less significant bits in UNSAF Protocols setting keys.
       
    37  * these bits are reserved for keys which indicates
       
    38  * variable amount of the domain settings  
       
    39  */
       
    40 const TUint32 KUNSAFProtocolsFieldTypeMask = 0xfffff000;
       
    41 
       
    42 
       
    43 /* 
       
    44  * Mask for the subtable field keys
       
    45  * these bits are reserved for keys which indicates variable amount of
       
    46  * server and plug-in settings
       
    47  */
       
    48 const TUint32 KUNSAFProtocolsSubTableFieldTypeMask = 0xfff00fff;
       
    49 
       
    50 
       
    51 /*
       
    52  * Mask for Domain or IAP table field keys.
       
    53  * These bits are reserved for keys that indicate separate fields under
       
    54  * one table.
       
    55  */
       
    56 const TUint32 KUNSAFProtocolsTableMask = 0xf0000fff;
       
    57 
       
    58 
       
    59 /*
       
    60  * Mask for Domain or IAP table field keys.
       
    61  * These bits are reserved for the actual key part
       
    62  */
       
    63 const TUint32 KUNSAFProtocolsKeyMask = 0xff000fff;
       
    64 
       
    65 
       
    66 /*
       
    67  * Mask for subtable field keys.
       
    68  * These bits are reserved for the actual key part.
       
    69  */
       
    70 const TUint32 KUNSAFProtocolsSubKeyMask = 0xff0fffff;
       
    71 
       
    72 
       
    73 // Domain Specific settings keys
       
    74 
       
    75 /** 
       
    76  * Domain table
       
    77  * Mask for domain table in UNSAF Protocols settings
       
    78  */
       
    79 const TUint32 KUNSAFProtocolsDomainTableMask = 0x10000000;
       
    80 
       
    81 
       
    82 /** 
       
    83  * Mask for domain field in UNSAF Protocols domain settings
       
    84  * Field type is TDesC8.
       
    85  * Field is used as the key of the table.
       
    86  */
       
    87 const TUint32 KUNSAFProtocolsDomainMask = 0x10001000;
       
    88 
       
    89 
       
    90 /**
       
    91  * Mask for indicating which NAT protocol should be used and whitch
       
    92  * priority order.
       
    93  * Format is x,x,x,...
       
    94  * example: nokia.stun,nokia.turn,nokia.ice
       
    95  * Field type is TDesC8.
       
    96  */
       
    97 const TUint32 KUNSAFProtocolsUsedNATProtocolMask = 0x10002000;
       
    98 
       
    99 
       
   100 /**
       
   101  * Mask for indicating whether the STUN/TURN server supports TLS and
       
   102  * shared secret. Non-zero value indicates that 
       
   103  * the STUN server does NOT support TLS and shared secret.
       
   104  * Field type is TInt.
       
   105  */
       
   106 const TUint32 KUNSAFProtocolsDomainSharedSecretNotSupported = 0x10003000;
       
   107 
       
   108 
       
   109 /**
       
   110  * Mask for indicating that the latest binding request attempt failed 
       
   111  * Non-zero value indicates fail.
       
   112  * Field type is TInt.
       
   113  */
       
   114 const TUint32 KUNSAFProtocolsDomainBindingRequestFailed = 0x10004000;
       
   115 
       
   116 
       
   117 /**
       
   118  * Mask for indicating start port of the port range 
       
   119  * All instances of the NATFW uses ports of this port range  
       
   120  * Field type is TInt.
       
   121  */
       
   122 const TUint32 KUNSAFProtocolsPortPoolStartPortMask  = 0x10005000;
       
   123 
       
   124 
       
   125 /**
       
   126  * Mask for indicating end port of the NATFW port range
       
   127  * All instances of the NATFW uses ports of this port range  
       
   128  * Field type is TInt.
       
   129  */
       
   130 const TUint32 KUNSAFProtocolsPortPoolEndPortMask = 0x10006000;
       
   131 
       
   132 
       
   133 /**
       
   134  * Mask for Host type preference value in the ICE
       
   135  * Field type is TInt.
       
   136  */
       
   137 const TUint32 KUNSAFProtocolsHostPref = 0x10022000;
       
   138 
       
   139 
       
   140 /**
       
   141  * Mask for Server-reflexive type preference value in the ICE
       
   142  * Field type is TInt.
       
   143  */
       
   144 const TUint32 KUNSAFProtocolsServerRefPref = 0x10023000;
       
   145 
       
   146 
       
   147 /**
       
   148  * Mask for Relay type Preference value in the ICE
       
   149  * Field type is TInt.
       
   150  */
       
   151 const TUint32 KUNSAFProtocolsRelayPref = 0x10024000;
       
   152 
       
   153 
       
   154 /**
       
   155  * Mask for Peer-reflexive type Preference value in the ICE
       
   156  * Field type is TInt.
       
   157  */
       
   158 const TUint32 KUNSAFProtocolsPeerRefPref = 0x10025000;
       
   159 
       
   160 
       
   161 /**
       
   162  * Mask for IPV4 local preference value in the ICE
       
   163  * Field type is TInt.
       
   164  */
       
   165 const TUint32 KUNSAFProtocolsIPV4Pref = 0x10026000;
       
   166 
       
   167 
       
   168 /**
       
   169  * Mask for IPV6 local preference value in the ICE
       
   170  * Field type is TInt.
       
   171  */
       
   172 const TUint32 KUNSAFProtocolsIPV6Pref = 0x10027000;
       
   173 
       
   174 
       
   175 /**
       
   176  * Mask for VPN local preference value in the ICE
       
   177  * Field type is TInt.
       
   178  */
       
   179 const TUint32 KUNSAFProtocolsVPNPref = 0x10028000;
       
   180 
       
   181 
       
   182 /**
       
   183  * Mask for UDP transport preference value in the ICE
       
   184  * Field type is TInt.
       
   185  */
       
   186 const TUint32 KUNSAFProtocolsUDPPref = 0x10029000;
       
   187 
       
   188 
       
   189 /**
       
   190  * Mask for TCP transport preference value in the ICE
       
   191  * Field type is TInt.
       
   192  */
       
   193 const TUint32 KUNSAFProtocolsTCPPref = 0x1002a000;
       
   194 
       
   195 
       
   196 /**
       
   197  * Mask for TCP-active direction preference value in the ICE
       
   198  * Field type is TInt.
       
   199  */
       
   200 const TUint32 KUNSAFProtocolsTCPActivePref = 0x1002b000;
       
   201 
       
   202 
       
   203 /**
       
   204  * Mask for TCP-passive direction preference value in the ICE
       
   205  * Field type is TInt.
       
   206  */
       
   207 const TUint32 KUNSAFProtocolsTCPPassivePref = 0x1002c000;
       
   208 
       
   209 
       
   210 /**
       
   211  * Mask for TCP-simultaneous-open direction preference value in the ICE
       
   212  * Field type is TInt.
       
   213  */
       
   214 const TUint32 KUNSAFProtocolsTCPSimultPref = 0x1002d000;
       
   215 
       
   216 
       
   217 /**
       
   218  * Mask for NAT utilities used by ICE.
       
   219  * Field type is TDesC8.
       
   220  */
       
   221 const TUint32 KUNSAFProtocolsNATUtilities = 0x1002e000;
       
   222 
       
   223 
       
   224 /** 
       
   225  * Mask for latest connected STUN server field in
       
   226  * UNSAF Protocols domain settings
       
   227  * Field type is TDesC8.
       
   228  */
       
   229 const TUint32 KUNSAFProtocolsLatestConnectedSTUNServerAddressMask = 
       
   230     0x10047000;
       
   231 
       
   232 
       
   233 /** 
       
   234  * Mask for latest connected STUN server port field in
       
   235  * UNSAF Protocols domain settings
       
   236  * Field type is TInt.
       
   237  */
       
   238 const TUint32 KUNSAFProtocolsLatestConnectedSTUNServerPortMask = 0x10048000;
       
   239 
       
   240 
       
   241 /** 
       
   242  * Mask for latest connected TURN server field in
       
   243  * UNSAF Protocols domain settings
       
   244  * Field type is TDesC8.
       
   245  */
       
   246 const TUint32 KUNSAFProtocolsLatestConnectedTURNServerAddressMask = 
       
   247     0x10049000;
       
   248 
       
   249 
       
   250 /** 
       
   251  * Mask for latest connected TURN server port field in
       
   252  * UNSAF Protocols domain settings
       
   253  * Field type is TInt.
       
   254  */
       
   255 const TUint32 KUNSAFProtocolsLatestConnectedTURNServerPortMask = 0x1004a000;
       
   256 
       
   257 
       
   258 /*
       
   259 * Mask for STUN server field in UNSAF Protocols domain settings
       
   260 * Field type is TDesC8.
       
   261 * Field is optional.
       
   262 */
       
   263 const TUint32 KUNSAFProtocolsSTUNServerMask = 0x1004b000;
       
   264 
       
   265 
       
   266 /* 
       
   267 * Mask for STUN server port field in UNSAF Protocols domain settings
       
   268 * Field type is TUint.
       
   269 * Field is optional.
       
   270 */
       
   271 const TUint32 KUNSAFProtocolsSTUNServerPortMask = 0x1004c000;
       
   272 
       
   273 
       
   274 /*
       
   275 * Mask for NAT refresh interval for UDP in UNSAF Protocols domain settings
       
   276 * Field type is TInt. The unit of measure is seconds.
       
   277 * Field is optional.
       
   278 */
       
   279 const TUint32 KUNSAFProtocolsDomainIntervalUDPMask = 0x1004d000;
       
   280 
       
   281 
       
   282 /*
       
   283 * Mask for NAT refresh interval for TCP in UNSAF Protocols domain settings
       
   284 * Field type is TInt. The unit of measure is seconds.
       
   285 * Field is optional.
       
   286 */
       
   287 const TUint32 KUNSAFProtocolsDomainIntervalTCPMask = 0x1004e000;
       
   288 
       
   289 
       
   290 /*
       
   291 * Mask for enabling CRLF-based NAT binding refresh over UDP 
       
   292 * to SIP proxy when no STUN server is available or
       
   293 * the STUN server returns the local IP address of the terminal.
       
   294 * Field type is TInt. Non-zero value indicates that the refresh is enabled.
       
   295 * Field is optional.
       
   296 */
       
   297 const TUint32 KUNSAFProtocolsDomainEnableCRLFRefresh = 0x1004f000;
       
   298 
       
   299 
       
   300 /**
       
   301  * Mask for Retransmission Timeout setting for Stun in domain settings
       
   302  * The unit of measure is mseconds.
       
   303  * Field type is TInt. 
       
   304  */
       
   305 const TUint32 KUNSAFProtocolsStunRetransmissionTimeoutMask = 0x10050000;
       
   306 
       
   307 
       
   308 /**
       
   309  * Mask for Retransmission Timeout setting for Turn in domain settings
       
   310  * The unit of measure is mseconds.
       
   311  * Field type is TInt. 
       
   312  */
       
   313 const TUint32 KUNSAFProtocolsTurnRetransmissionTimeoutMask = 0x10051000;
       
   314 
       
   315 
       
   316 
       
   317 // STUN Server Specific settings in the domain
       
   318 
       
   319 /**
       
   320  * STUN Server table
       
   321  */
       
   322 const TUint32 KUNSAFProtocolsSTUNServerTableMask = 0x11000000;
       
   323 
       
   324 
       
   325 /**
       
   326  * Mask for server address field in server settings
       
   327  * Field type is TDesC8.
       
   328  */
       
   329 const TUint32 KUNSAFProtocolsSTUNAddressMask = 0x11100000;
       
   330 
       
   331 
       
   332 /**
       
   333  * Mask for server port field in server settings
       
   334  * Field type is TInt.
       
   335  */
       
   336 const TUint32 KUNSAFProtocolsSTUNPortMask = 0x11200000;
       
   337 
       
   338 
       
   339 /**
       
   340  * Mask for Connectivity Check Timeout setting in server settings
       
   341  * The unit of measure is seconds.
       
   342  * Field type is TInt. 
       
   343  */
       
   344 const TUint32 KUNSAFProtocolsSTUNConnectivityCheckTimeoutMask = 0x11500000;
       
   345 
       
   346 
       
   347 /**
       
   348  * Mask for server username field in server settings
       
   349  * Field type is TDesC8.
       
   350  */
       
   351 const TUint32 KUNSAFProtocolsSTUNUsernameMask = 0x11700000;
       
   352 
       
   353 
       
   354 /**
       
   355  * Mask for server password field in server settings
       
   356  * Field type is TDesC8.
       
   357  */
       
   358 const TUint32 KUNSAFProtocolsSTUNPasswordMask = 0x11800000;
       
   359 
       
   360 
       
   361 // TURN Server specific settings keys in the domain
       
   362 
       
   363 /**
       
   364  * TURN Server table
       
   365  */
       
   366 const TUint32 KUNSAFProtocolsTURNServerTableMask = 0x12000000;
       
   367 
       
   368 
       
   369 /** 
       
   370  * Mask for server address field in server settings
       
   371  * Field type is TDesC8.
       
   372  */
       
   373 const TUint32 KUNSAFProtocolsTURNAddressMask = 0x12100000;
       
   374 
       
   375 
       
   376 /**
       
   377  * Mask for server port field in server settings
       
   378  * Field type is TInt.
       
   379  */
       
   380 const TUint32 KUNSAFProtocolsTURNPortMask = 0x12200000;
       
   381 
       
   382 
       
   383 /**
       
   384  * Mask for Connectivity Check Timeout setting in server settings
       
   385  * The unit of measure is seconds.
       
   386  * Field type is TInt. 
       
   387  */
       
   388 const TUint32 KUNSAFProtocolsTURNConnectivityCheckTimeoutMask = 0x12500000;
       
   389 
       
   390 
       
   391 /**
       
   392  * Mask for server username field in server settings
       
   393  * Field type is TDesC8.
       
   394  */
       
   395 const TUint32 KUNSAFProtocolsTURNUsernameMask= 0x12700000;
       
   396 
       
   397 
       
   398 /**
       
   399  * Mask for server password field in server settings
       
   400  * Field type is TDesC8.
       
   401  */
       
   402 const TUint32 KUNSAFProtocolsTURNPasswordMask = 0x12800000;
       
   403 
       
   404 
       
   405 // IAP specific settings keys
       
   406 
       
   407 /**
       
   408  * IAP table
       
   409  * { IAP ID, IntervalUDP, IntervalTCP, RetransmitInterval }
       
   410  * Mask for IAP table in UNSAF Protocols settings
       
   411  */
       
   412 const TUint32 KUNSAFProtocolsIAPTableMask = 0x20000000;
       
   413 
       
   414 
       
   415 /**
       
   416  * Mask for IAP ID field in UNSAF Protocols IAP settings
       
   417  * Field type is TUint32.
       
   418  * Field is used as the key of the table.
       
   419  */
       
   420 const TUint32 KUNSAFProtocolsIAPIdMask = 0x20001000;
       
   421 
       
   422 
       
   423 /**
       
   424  * Mask for NAT refresh interval for UDP in UNSAF Protocols IAP settings
       
   425  * Field type is TInt. The unit of measure is seconds.
       
   426  */
       
   427 const TUint32 KUNSAFProtocolsIntervalUDPMask = 0x20002000;
       
   428 
       
   429 
       
   430 /**
       
   431  * Mask for NAT refresh interval for TCP in UNSAF Protocols IAP settings
       
   432  * Field type is TInt. The unit of measure is seconds.
       
   433  */
       
   434 const TUint32 KUNSAFProtocolsIntervalTCPMask = 0x20003000;
       
   435 
       
   436 
       
   437 /**
       
   438  * Mask for initial STUN request retransmit timer in UNSAF Protocols
       
   439  * IAP settings
       
   440  * Field type is TInt. The unit of measure is milliseconds.
       
   441  */
       
   442 const TUint32 KUNSAFProtocolsSTUNRetransmitTimerMask = 0x20004000;
       
   443 
       
   444 
       
   445 #endif // UNSAFPROTOCOLSCRKEYS_H