linklayercontrol/networkinterfacemgr/inc/NIFVAR.H
changeset 0 af10295192d8
equal deleted inserted replaced
-1:000000000000 0:af10295192d8
       
     1 /**
       
     2 * Copyright (c) 1997-2009 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 * Interface Manager Standard Variable Names
       
    16 * 
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 /**
       
    23  @file NIFVAR.H
       
    24  @publishedAll
       
    25  @released
       
    26 */
       
    27 
       
    28 
       
    29 #if !defined(__NIFVAR_H__)
       
    30 #define __NIFVAR_H__
       
    31 
       
    32 #include <e32std.h>
       
    33 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    34 #include <nifvar_internal.h>
       
    35 #endif
       
    36 
       
    37 /**
       
    38 Generic Progress Constant
       
    39 From NIFMAN
       
    40 @note These ranges must be obeyed by all network adapters
       
    41 @note These are augmented by the PSD and CSD constants below
       
    42 
       
    43 @publishedAll
       
    44 @released
       
    45 */
       
    46 const TInt KConnectionUninitialised  = 0;              // From NIFMAN
       
    47 const TInt KStartingSelection        = 1000;           // From NIFMAN
       
    48 const TInt KFinishedSelection        = 2000;           // From NIFMAN
       
    49 const TInt KConnectionFailure        = 2001;           // From NIFMAN
       
    50 
       
    51 const TInt KMinAgtProgress           = 2500;
       
    52 const TInt KConnectionOpen           = 3500;           // From an Agent
       
    53 const TInt KConnectionClosed         = 4500;           // From an Agent
       
    54 const TInt KMaxAgtProgress           = 5500;
       
    55 
       
    56 const TInt KMinNifProgress           = 6000;
       
    57 const TInt KMaxNifProgress           = 9000;
       
    58 
       
    59 /**
       
    60 Do no use in new code. Use KConnectionUp or KConnectionDown
       
    61 from es_sock.h instead.
       
    62 
       
    63 @publishedAll
       
    64 @deprecated
       
    65 */
       
    66 const TInt KLinkLayerOpen            = 7000;           // From a NIF
       
    67 const TInt KLinkLayerClosed          = 8000;           // From a NIF
       
    68 
       
    69 /**
       
    70 Additional generic progress constantfrom an agent
       
    71 @note These values may be implemented by network adapters (nifs/agents) 
       
    72 @see KPsdStartingConfiguration
       
    73 @see KCsdStartingDialling
       
    74 
       
    75 @publishedAll
       
    76 @released
       
    77 */
       
    78 const TInt KStartingConnection = 3000;				// from an agent
       
    79 const TInt KIncomingConnectionInProgress = 3350;	// from an agent
       
    80 const TInt KDataTransferTemporarilyBlocked = 4000;	// eg. suspended (GPRS); from an agent
       
    81 //const TInt KDataTransferUnblocked = 4001;           // eg. resume (GPRS); from an agent - declared in nifvar_internal.h
       
    82 const TInt KConnectionStartingClose	= 4250;			// from an agent
       
    83 
       
    84 /**
       
    85 Additional generic progress constant
       
    86 from an agent
       
    87 @note These values may be implemented by network adapters (nifs/agents) 
       
    88 @see KPsdStartingConfiguration
       
    89 @see KCsdStartingDialling
       
    90 
       
    91 @publishedAll
       
    92 @released
       
    93 */
       
    94 const TInt KPsdStartingConfiguration = KMinAgtProgress;	// required
       
    95 const TInt KPsdFinishedConfiguration = 2750;			// desirable
       
    96 
       
    97 const TInt KPsdAnsweringIncoming	 = KIncomingConnectionInProgress; // required if supporting incoming connections
       
    98 
       
    99 const TInt KPsdStartingActivation	 = KStartingConnection; // required
       
   100 const TInt KPsdFinishedActivation	 = KConnectionOpen;		// required
       
   101 
       
   102 const TInt KPsdSuspended			 = KDataTransferTemporarilyBlocked;	// required if this case can occur
       
   103 
       
   104 const TInt KPsdStartingDeactivation	 = KConnectionStartingClose;	// desirable
       
   105 const TInt KPsdFinishedDeactivation  = KConnectionClosed;			// required
       
   106 
       
   107 /**
       
   108 Additional generic progress constant
       
   109 eg. suspended (GPRS); from an agent
       
   110 @note These values may be implemented by network adapters (nifs/agents) 
       
   111 @see KPsdStartingConfiguration
       
   112 @see KCsdStartingDialling
       
   113 
       
   114 @publishedAll
       
   115 @released
       
   116 */
       
   117 const TInt KCsdStartingDialling	= KMinAgtProgress;		// optional
       
   118 const TInt KCsdFinishedDialling = 2600;					// desirable
       
   119 const TInt KCsdScanningScript	= 2650;					// optional
       
   120 const TInt KCsdScannedScript	= 2750;					// optional
       
   121 const TInt KCsdGettingLoginInfo	= 2800;					// optional
       
   122 const TInt KCsdGotLoginInfo		= 2900;					// optional
       
   123 const TInt KCsdStartingConnect	= KStartingConnection;	// optional
       
   124 const TInt KCsdFinishedConnect	= 3100;					// desirable
       
   125 const TInt KCsdStartingLogIn	= 3200;					// optional
       
   126 const TInt KCsdFinishedLogIn	= 3250;					// optional
       
   127 
       
   128 const TInt KCsdStartingAnswer	= KIncomingConnectionInProgress; // required if supporting incoming connections/callback
       
   129 const TInt KCsdAnswered			= 3400;					// required if supporting incoming connections/callback
       
   130 
       
   131 const TInt KCsdConnectionOpen	= KConnectionOpen;		// required
       
   132 const TInt KCsdStartingHangUp	= KConnectionStartingClose;	// desirable
       
   133 const TInt KCsdFinishedHangUp	= KConnectionClosed;	// required
       
   134 
       
   135 /**
       
   136  Generic progress notifications from the configuration daemon.
       
   137  @publishedAll
       
   138  @released
       
   139 **/
       
   140 const TInt KMinConfigDaemonProgress = 8100;
       
   141 const TInt KConfigDaemonLoading = 8100;
       
   142 const TInt KConfigDaemonLoaded = 8200;
       
   143 const TInt KConfigDaemonStartingRegistration = 8300;
       
   144 const TInt KConfigDaemonFinishedRegistration = 8400;
       
   145 const TInt KConfigDaemonStartingDeregistration = 8600;
       
   146 const TInt KConfigDaemonFinishedDeregistrationStop = 8700;
       
   147 const TInt KConfigDaemonFinishedDeregistrationPreserve = 8701;
       
   148 const TInt KConfigDaemonFinishedDormantMode = 8750;
       
   149 const TInt KConfigDaemonUnloading = 8800;
       
   150 const TInt KConfigDaemonUnloaded = 8900;
       
   151 const TInt KMaxConfigDaemonProgress = 8900;
       
   152  
       
   153 /**
       
   154 New software should use the progress ranges defined above
       
   155 
       
   156 @publishedAll
       
   157 @deprecated 7.0s - maintained for compatibility with 6.1
       
   158 */
       
   159 const TInt KAgentUninitialised = KConnectionUninitialised;
       
   160 const TInt KAgentUnconnected = 1;
       
   161 const TInt KMaxAgentProgress = 999;
       
   162 const TInt KMinInterfaceProgress = 1000;
       
   163 const TInt KMaxInterfaceProgress = 1999;
       
   164 
       
   165 /**
       
   166 The type of connection provided by the network interface
       
   167 
       
   168 @publishedAll
       
   169 @released
       
   170 @note It is acceptable for clients to check that a TConnectionType falls within a 
       
   171 specified range, and assume that the basic parameters can be obtained.  For example,
       
   172 if the returned TConnectionType is between 2000 and 2499, it would be acceptable for
       
   173 a client to assume that it was a GPRS connection, and that TGPRSSubConnectionInfo 
       
   174 is an acceptable class to use for GetSubConnectionInfo() calls
       
   175 */
       
   176 enum TConnectionType
       
   177 	{
       
   178 	/** Connection values <1000 for generic interface values
       
   179 	These are used to indicate an interface does not support extended 
       
   180 	management functionality, and a limited subset of information is made 
       
   181 	available through a compatibility layer
       
   182 	*/
       
   183 	EConnectionGeneric,
       
   184 
       
   185 	/** Connection values 1000-1999 for CSD connections
       
   186 	 */
       
   187 	EConnectionCSD = 1000,
       
   188 
       
   189 	/** Connection values > 2000 for PSD connections
       
   190 	Connection values 2000-2499 for subsets of GPRS/UMTS
       
   191 	*/
       
   192 	EConnectionGPRS = 2000,
       
   193 
       
   194 	EConnectionGPRSR97,
       
   195 	EConnectionGPRSR99,
       
   196 	EConnectionGPRSRel4,
       
   197 	EConnectionGPRSRel5,
       
   198 
       
   199 	/** Connection values 3000 for IEEE802.3 (Ethernet)
       
   200 	*/
       
   201 	EConnectionEthernet = 3000,
       
   202 
       
   203 	/** Connection values 3100 for IEEE802.11 (WLAN)
       
   204 	*/
       
   205 	EConnectionWLAN = 3100,
       
   206 
       
   207 	/** Connection values 4000 - 4099 for Bluetooth PAN profile interfaces
       
   208 	*/ 
       
   209 	EConnectionBTPAN = 4000
       
   210 
       
   211 	/** Connection values 4100+ for other PS technologies
       
   212 	*/
       
   213 	};
       
   214 
       
   215 /**
       
   216 Callback actions
       
   217 @publishedAll
       
   218 @released
       
   219 */
       
   220 enum TCallbackAction
       
   221 	{
       
   222 	ECallbackActionIETFType0	=0,
       
   223 	ECallbackActionIETFType1	=1,
       
   224 	ECallbackActionIETFType2	=2,
       
   225 	ECallbackActionIETFType3	=3,
       
   226 	ECallbackActionIETFType4	=4,
       
   227 	ECallbackActionIETFType5	=5,
       
   228 	//
       
   229 	ECallbackActionMSCBCPRequireClientSpecifiedNumber	= 1001,
       
   230 	ECallbackActionMSCBCPAcceptServerSpecifiedNumber	= 1002,
       
   231 	ECallbackActionMSCBCPOverrideServerSpecifiedNumber	= 1003
       
   232 	};
       
   233 
       
   234 #endif