epoc32/include/nifvar.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 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:
    15 * Interface Manager Standard Variable Names
    16 * 
    17 *
    18 */
    19 
    20 
    21 
    22 
    23 
    24 /**
    25  @file NIFVAR.H
    26  @publishedAll
    27  @released
    28 */
    29 
    30 
    31 #if !defined(__NIFVAR_H__)
    32 #define __NIFVAR_H__
    33 
    34 #include <e32std.h>
    35 
    36 /**
    37 Generic Progress Constant
    38 From NIFMAN
    39 @note These ranges must be obeyed by all network adapters
    40 @note These are augmented by the PSD and CSD constants below
    41 
    42 @publishedAll
    43 @released
    44 */
    45 const TInt KConnectionUninitialised  = 0;              // From NIFMAN
    46 const TInt KStartingSelection        = 1000;           // From NIFMAN
    47 const TInt KFinishedSelection        = 2000;           // From NIFMAN
    48 const TInt KConnectionFailure        = 2001;           // From NIFMAN
    49 
    50 const TInt KMinAgtProgress           = 2500;
    51 const TInt KConnectionOpen           = 3500;           // From an Agent
    52 const TInt KConnectionClosed         = 4500;           // From an Agent
    53 const TInt KMaxAgtProgress           = 5500;
    54 
    55 const TInt KMinNifProgress           = 6000;
    56 const TInt KLinkLayerOpen            = 7000;           // From a NIF
    57 const TInt KLinkLayerClosed          = 8000;           // From a NIF
    58 const TInt KMaxNifProgress           = 9000;
    59 
    60 /**
    61 Additional generic progress constantfrom an agent
    62 @note These values may be implemented by network adapters (nifs/agents) 
    63 @see KPsdStartingConfiguration
    64 @see KCsdStartingDialling
    65 
    66 @publishedAll
    67 @released
    68 */
    69 const TInt KStartingConnection = 3000;				// from an agent
    70 const TInt KIncomingConnectionInProgress = 3350;	// from an agent
    71 const TInt KDataTransferTemporarilyBlocked = 4000;	// eg. suspended (GPRS); from an agent
    72 const TInt KConnectionStartingClose	= 4250;			// from an agent
    73 
    74 /**
    75 Additional generic progress constant
    76 from an agent
    77 @note These values may be implemented by network adapters (nifs/agents) 
    78 @see KPsdStartingConfiguration
    79 @see KCsdStartingDialling
    80 
    81 @publishedAll
    82 @released
    83 */
    84 const TInt KPsdStartingConfiguration = KMinAgtProgress;	// required
    85 const TInt KPsdFinishedConfiguration = 2750;			// desirable
    86 
    87 const TInt KPsdAnsweringIncoming	 = KIncomingConnectionInProgress; // required if supporting incoming connections
    88 
    89 const TInt KPsdStartingActivation	 = KStartingConnection; // required
    90 const TInt KPsdFinishedActivation	 = KConnectionOpen;		// required
    91 
    92 const TInt KPsdSuspended			 = KDataTransferTemporarilyBlocked;	// required if this case can occur
    93 
    94 const TInt KPsdStartingDeactivation	 = KConnectionStartingClose;	// desirable
    95 const TInt KPsdFinishedDeactivation  = KConnectionClosed;			// required
    96 
    97 /**
    98 Additional generic progress constant
    99 eg. suspended (GPRS); from an agent
   100 @note These values may be implemented by network adapters (nifs/agents) 
   101 @see KPsdStartingConfiguration
   102 @see KCsdStartingDialling
   103 
   104 @publishedAll
   105 @released
   106 */
   107 const TInt KCsdStartingDialling	= KMinAgtProgress;		// optional
   108 const TInt KCsdFinishedDialling = 2600;					// desirable
   109 const TInt KCsdScanningScript	= 2650;					// optional
   110 const TInt KCsdScannedScript	= 2750;					// optional
   111 const TInt KCsdGettingLoginInfo	= 2800;					// optional
   112 const TInt KCsdGotLoginInfo		= 2900;					// optional
   113 const TInt KCsdStartingConnect	= KStartingConnection;	// optional
   114 const TInt KCsdFinishedConnect	= 3100;					// desirable
   115 const TInt KCsdStartingLogIn	= 3200;					// optional
   116 const TInt KCsdFinishedLogIn	= 3250;					// optional
   117 
   118 const TInt KCsdStartingAnswer	= KIncomingConnectionInProgress; // required if supporting incoming connections/callback
   119 const TInt KCsdAnswered			= 3400;					// required if supporting incoming connections/callback
   120 
   121 const TInt KCsdConnectionOpen	= KConnectionOpen;		// required
   122 const TInt KCsdStartingHangUp	= KConnectionStartingClose;	// desirable
   123 const TInt KCsdFinishedHangUp	= KConnectionClosed;	// required
   124 
   125 /**
   126  Generic progress notifications from the configuration daemon.
   127  @publishedAll
   128  @released
   129 **/
   130 const TInt KMinConfigDaemonProgress = 8100;
   131 const TInt KConfigDaemonLoading = 8100;
   132 const TInt KConfigDaemonLoaded = 8200;
   133 const TInt KConfigDaemonStartingRegistration = 8300;
   134 const TInt KConfigDaemonFinishedRegistration = 8400;
   135 const TInt KConfigDaemonStartingDeregistration = 8600;
   136 const TInt KConfigDaemonFinishedDeregistrationStop = 8700;
   137 const TInt KConfigDaemonFinishedDeregistrationPreserve = 8701;
   138 const TInt KConfigDaemonFinishedDormantMode = 8750;
   139 const TInt KConfigDaemonUnloading = 8800;
   140 const TInt KConfigDaemonUnloaded = 8900;
   141 const TInt KMaxConfigDaemonProgress = 8900;
   142  
   143 /**
   144 Generic progress notifications from the null configuration daemon.
   145 @internalComponent
   146 @released
   147 **/
   148 const TInt KNullConfigDaemonConfigureNetwork = 8401;
   149 
   150 /**
   151 New software should use the progress ranges defined above
   152 
   153 @publishedAll
   154 @deprecated 7.0s - maintained for compatibility with 6.1
   155 */
   156 const TInt KAgentUninitialised = KConnectionUninitialised;
   157 const TInt KAgentUnconnected = 1;
   158 const TInt KMaxAgentProgress = 999;
   159 const TInt KMinInterfaceProgress = 1000;
   160 const TInt KMaxInterfaceProgress = 1999;
   161 
   162 /**
   163 Callback actions
   164 @internalComponent
   165 */
   166 enum TCallbackAction
   167 	{
   168 	ECallbackActionIETFType0	=0,
   169 	ECallbackActionIETFType1	=1,
   170 	ECallbackActionIETFType2	=2,
   171 	ECallbackActionIETFType3	=3,
   172 	ECallbackActionIETFType4	=4,
   173 	ECallbackActionIETFType5	=5,
   174 	//
   175 	ECallbackActionMSCBCPRequireClientSpecifiedNumber	= 1001,
   176 	ECallbackActionMSCBCPAcceptServerSpecifiedNumber	= 1002,
   177 	ECallbackActionMSCBCPOverrideServerSpecifiedNumber	= 1003
   178 	};
   179 
   180 /**
   181 The type of connection provided by the network interface
   182 
   183 @publishedAll
   184 @released
   185 @note It is acceptable for clients to check that a TConnectionType falls within a 
   186 specified range, and assume that the basic parameters can be obtained.  For example,
   187 if the returned TConnectionType is between 2000 and 2499, it would be acceptable for
   188 a client to assume that it was a GPRS connection, and that TGPRSSubConnectionInfo 
   189 is an acceptable class to use for GetSubConnectionInfo() calls
   190 */
   191 enum TConnectionType
   192 	{
   193 	/** Connection values <1000 for generic interface values
   194 	These are used to indicate an interface does not support extended 
   195 	management functionality, and a limited subset of information is made 
   196 	available through a compatibility layer
   197 	*/
   198 	EConnectionGeneric,
   199 
   200 	/** Connection values 1000-1999 for CSD connections
   201 	 */
   202 	EConnectionCSD = 1000,
   203 
   204 	/** Connection values > 2000 for PSD connections
   205 	Connection values 2000-2499 for subsets of GPRS/UMTS
   206 	*/
   207 	EConnectionGPRS = 2000,
   208 
   209 	EConnectionGPRSR97,
   210 	EConnectionGPRSR99,
   211 	EConnectionGPRSRel4,
   212 	EConnectionGPRSRel5,
   213 
   214 	/** Connection values 2500-2999 for subsets of CDMA
   215 	@todo Check these CDMA values to find which ones affect the interface features
   216 	*/
   217 	EConnectionCDMA = 2500,
   218 
   219 	EConnectionCDMA20001xRTT,
   220 	EConnectionCDMA20001xRTTDO,
   221 	EConnectionCDMA20001xRTTDV,
   222 	EConnectionCDMA20003xRTT,
   223 	/** Connection values 3000 for IEEE802.3 (Ethernet)
   224 	*/
   225 	EConnectionEthernet = 3000,
   226 
   227 	/** Connection values 3100 for IEEE802.11 (WLAN)
   228 	*/
   229 	EConnectionWLAN = 3100,
   230 
   231 	/** Connection values 4000 - 4099 for Bluetooth PAN profile interfaces
   232 	*/ 
   233 	EConnectionBTPAN = 4000
   234 
   235 	/** Connection values 4100+ for other PS technologies
   236 	*/
   237 	};
   238 
   239 /**
   240 The layer to which the call refers
   241 @note Used by data sent and received to indicate to which layer the byte count refers
   242 @todo Write about this, add appropriate arguments to interfaces
   243 @internalTechnology
   244 */
   245 enum TConnectionLayer
   246 	{
   247 	EPhysicalLayer,
   248 	EDataLinkLayer = 100,
   249 	ENetworkLayer = 200,
   250 	ETransportLayer = 300,
   251 	ESessionLayer = 400,
   252 	EPresentationLayer = 500,
   253 	EApplicationLayer = 600
   254 	};
   255 
   256 #endif