1 /*

     2 * Copyright (c) 2007 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:    Interface for querying ICE related software settings.

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 

    22 #ifndef M_MNATFWICESETTINGS_H

    23 #define M_MNATFWICESETTINGS_H

    24 

    25 

    26 #include <e32base.h>

    27 

    28 class CDesC8Array;

    29 

    30 

    31 /**

    32  *  Interface for querying ICE related software settings.

    33  *  

    34  *  Interface is not intended for derivation outside NATFW.

    35  *  

    36  *  @lib natfwnatsettings.dll

    37  *  @since S60 v3.2

    38  */

    39 class MNATFWIceSettings

    40     {

    41 

    42 public:

    43 

    44     /** Special value for the setting indicating that use of that particular

    45     type of candidate is blocked. */

    46     static const TInt KPrefValueDisabled = -1;

    47     

    48     /** Defines available preference settings. */

    49     enum TPrefSetting

    50         {

    51         /** Type preference of host candidate. */

    52         EPrefHostCandidate                  = 1,

    53         

    54         /** Type preference of server reflexive candidate. */

    55         EPrefServerReflexiveCandidate       = 2,

    56         

    57         /** Type preference of relay candidate. */

    58         EPrefRelayCandidate                 = 3,

    59         

    60         /** Type preference of peer reflexive candidate. */

    61         EPrefPeerReflexiveCandidate         = 4,

    62         

    63         /** IPv4 interface preference. */

    64         EPrefIpv4AddrFamily                 = 5,

    65         

    66         /** IPv6 interface preference. */

    67         EPrefIpv6AddrFamily                 = 6,

    68         

    69         /** VPN interface preference. */

    70         EPrefVpnInterface                   = 7,

    71         

    72         /** UDP transport protocol preference. */

    73         EPrefUdpTransport                   = 8,

    74         

    75         /** TCP transport protocol preference. */

    76         EPrefTcpTransport                   = 9,

    77         

    78         /** TCP active direction preference of TCP-based candidate. */

    79         EPrefTcpDirectionActive             = 10,

    80         

    81         /** TCP passive direction preference of TCP-based candidate. */

    82         EPrefTcpDirectionPassive            = 11,

    83         

    84         /** TCP simultaneous open direction preference of TCP-based

    85         candidate. */

    86         EPrefTcpDirectionSimultaneousOpen   = 12

    87         };

    88 

    89     /**

    90      * Returns preference value for a specifed setting.

    91      *

    92      * @since   S60 v3.2

    93      * @param   aSetting    Setting for which to return preference value

    94      * @param   aValue      Preference value if query was valid

    95      * @return  KErrNotSupported if setting is not known, KErrNone otherwise

    96      */

    97     virtual TInt GetPrefValue( 

    98         TPrefSetting aSetting, TInt& aValue ) const = 0;

    99     

   100     /**

   101      * Returns array of identifiers of utility plugins available for ICE.

   102      * 

   103      * @since   S60 v3.2

   104      * @return  Utilities available for ICE

   105      */

   106     virtual const CDesC8Array& NatUtilityPlugins() const = 0;

   107     

   108     };

   109 

   110 

   111 #endif // M_MNATFWICESETTINGS_H