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 "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:    vcxconnectionutility definitions and enums*

    15 */

    16 

    17 

    18 

    19 #ifndef __VCX_CONNECTIOUTILITY_HRH__

    20 #define __VCX_CONNECTIOUTILITY_HRH__

    21 

    22 /**

    23  * P&S key id enums:

    24  * 

    25  * EVCxPSConnectionStatus - Master saves current connection status here. Possible values are:

    26  *	- EVCxNotConnected: there is no active connection in the connectionutility scope

    27  *  - EVCxConnected: connection exists and is active

    28  *  - EVCxRoamingRequest: connectiontuility is in roaming mode

    29  *

    30  * EVCxPSIapId - Current active iap id

    31  *

    32  * EVCxPSSnapId - Current active Destination id

    33  *

    34  * EVCxPSMasterExists - This value is used to notify slaves wether master exists or not.

    35  *  When active master disconnects it changes this value to 0. Slaves notify

    36  *  this and first slave which gets the notifications changes itself to be new master

    37  *

    38  * EVCxPSNbrConnInstances- Number of processes that use connectionutility and have active connection.

    39  *

    40  * EVCxPSRoamingRequestStatus - Value is used internally by the master when it waits slaves to request 

    41  *                              roaming state.

    42  * Possible values are:

    43  * - EVCxRoamingNotInit: when master has requested roaming from it's own clients it sets this value. 

    44  *                       Same value is resetted if roaming is not allowed

    45  * - EVCxRoamingAllowed: When master's and all slaves' clients have been accepted roaming this value is 

    46  *                       setted to notify that roaming is allowed

    47  *

    48  * EVCxPSNbrRoamResp - Number of responses received from different connectionutility processes.

    49  *

    50  * EVCxPSNbRoamAccepted - Number of accepted responses from the roaming request from different 

    51  *                        connectionutility processes.

    52  */

    53 enum TVCxPSConUtilKeyId

    54     {

    55     EVCxPSConnectionStatus = 0x00000001, // TVCxConnectionStatus

    56     EVCxPSIapId,                         // TInt

    57     EVCxPSSnapId,                        // TInt

    58     EVCxPSMasterExists,                  // TInt

    59     EVCxPSNbrConnInstances,              // TInt 

    60     EVCxPSRoamingRequestStatus,          // TVCxPSConUtilRoamingRequest 

    61     EVCxPSNbrRoamResp,                   // TInt

    62     EVCxPSNbRoamAccepted                 // TInt

    63     };

    64 

    65 /**

    66  * enums for roaming state to be used in

    67  * EVCxPSRoamingRequestStatus when EVCxPSConnectionStatus

    68  * is EVCxRoamingRequest

    69  */

    70 enum TVCxPSConUtilRoamingRequest

    71     {

    72     EVCxRoamingNotInit = 50,

    73     EVCxRoamingAllowed

    74     };

    75 

    76 /**

    77  * connection utility's connection state enums

    78  * EVCxNotConnected

    79  * current instance is not connected to network and does not maintain any active connection.

    80  *

    81  * EVCxConnecting

    82  * current instance is waiting for networkingmiddleware to initialize connection

    83  * 

    84  * EVCxConnected

    85  * current instance is connected and it maintains active connection

    86  * 

    87  * EVCxDisconnecting

    88  * current instance is disconnecting

    89  * 

    90  * EVCxRoamingRequest

    91  * current master instance is requesting it's client's about roaming. 

    92  * If instance is slave, this state notifies that slave does not accept roaming.

    93  * 

    94  * EVCxPendingClientRequest

    95  * Operation path is in the client side during roaming.

    96  *

    97  * EVCxRoamingAccepted

    98  * Slave: current instance's client's are all accepted roaming. 

    99  * Master: every local client and all slaves have been accepted roaming.  

   100  * 

   101  * EVCxError

   102  * unresolved error received from the networking middleware. In this case clients are notified by the IapChanged in which

   103  * case client can try to resolve connection by recalling GetIap, or disconnecting connection

   104  * 

   105  */

   106 enum TVCxConnectionStatus

   107     {

   108     EVCxNotConnected = 10,

   109     EVCxConnecting,

   110     EVCxConnected,

   111     EVCxDisconnecting,

   112     EVCxRoamingRequest,

   113     EVCxPendingClientRequest,

   114     EVCxRoamingAccepted,

   115     EVCxError

   116     };

   117     

   118 #endif // __VCX_CONNECTIOUTILITY_HRH__

   119 // end of file