1.1 --- a/epoc32/include/nifvar.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/nifvar.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,256 @@
1.4 -nifvar.h
1.5 +/**
1.6 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* 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
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description:
1.19 +* Interface Manager Standard Variable Names
1.20 +*
1.21 +*
1.22 +*/
1.23 +
1.24 +
1.25 +
1.26 +
1.27 +
1.28 +/**
1.29 + @file NIFVAR.H
1.30 + @publishedAll
1.31 + @released
1.32 +*/
1.33 +
1.34 +
1.35 +#if !defined(__NIFVAR_H__)
1.36 +#define __NIFVAR_H__
1.37 +
1.38 +#include <e32std.h>
1.39 +
1.40 +/**
1.41 +Generic Progress Constant
1.42 +From NIFMAN
1.43 +@note These ranges must be obeyed by all network adapters
1.44 +@note These are augmented by the PSD and CSD constants below
1.45 +
1.46 +@publishedAll
1.47 +@released
1.48 +*/
1.49 +const TInt KConnectionUninitialised = 0; // From NIFMAN
1.50 +const TInt KStartingSelection = 1000; // From NIFMAN
1.51 +const TInt KFinishedSelection = 2000; // From NIFMAN
1.52 +const TInt KConnectionFailure = 2001; // From NIFMAN
1.53 +
1.54 +const TInt KMinAgtProgress = 2500;
1.55 +const TInt KConnectionOpen = 3500; // From an Agent
1.56 +const TInt KConnectionClosed = 4500; // From an Agent
1.57 +const TInt KMaxAgtProgress = 5500;
1.58 +
1.59 +const TInt KMinNifProgress = 6000;
1.60 +const TInt KLinkLayerOpen = 7000; // From a NIF
1.61 +const TInt KLinkLayerClosed = 8000; // From a NIF
1.62 +const TInt KMaxNifProgress = 9000;
1.63 +
1.64 +/**
1.65 +Additional generic progress constantfrom an agent
1.66 +@note These values may be implemented by network adapters (nifs/agents)
1.67 +@see KPsdStartingConfiguration
1.68 +@see KCsdStartingDialling
1.69 +
1.70 +@publishedAll
1.71 +@released
1.72 +*/
1.73 +const TInt KStartingConnection = 3000; // from an agent
1.74 +const TInt KIncomingConnectionInProgress = 3350; // from an agent
1.75 +const TInt KDataTransferTemporarilyBlocked = 4000; // eg. suspended (GPRS); from an agent
1.76 +const TInt KConnectionStartingClose = 4250; // from an agent
1.77 +
1.78 +/**
1.79 +Additional generic progress constant
1.80 +from an agent
1.81 +@note These values may be implemented by network adapters (nifs/agents)
1.82 +@see KPsdStartingConfiguration
1.83 +@see KCsdStartingDialling
1.84 +
1.85 +@publishedAll
1.86 +@released
1.87 +*/
1.88 +const TInt KPsdStartingConfiguration = KMinAgtProgress; // required
1.89 +const TInt KPsdFinishedConfiguration = 2750; // desirable
1.90 +
1.91 +const TInt KPsdAnsweringIncoming = KIncomingConnectionInProgress; // required if supporting incoming connections
1.92 +
1.93 +const TInt KPsdStartingActivation = KStartingConnection; // required
1.94 +const TInt KPsdFinishedActivation = KConnectionOpen; // required
1.95 +
1.96 +const TInt KPsdSuspended = KDataTransferTemporarilyBlocked; // required if this case can occur
1.97 +
1.98 +const TInt KPsdStartingDeactivation = KConnectionStartingClose; // desirable
1.99 +const TInt KPsdFinishedDeactivation = KConnectionClosed; // required
1.100 +
1.101 +/**
1.102 +Additional generic progress constant
1.103 +eg. suspended (GPRS); from an agent
1.104 +@note These values may be implemented by network adapters (nifs/agents)
1.105 +@see KPsdStartingConfiguration
1.106 +@see KCsdStartingDialling
1.107 +
1.108 +@publishedAll
1.109 +@released
1.110 +*/
1.111 +const TInt KCsdStartingDialling = KMinAgtProgress; // optional
1.112 +const TInt KCsdFinishedDialling = 2600; // desirable
1.113 +const TInt KCsdScanningScript = 2650; // optional
1.114 +const TInt KCsdScannedScript = 2750; // optional
1.115 +const TInt KCsdGettingLoginInfo = 2800; // optional
1.116 +const TInt KCsdGotLoginInfo = 2900; // optional
1.117 +const TInt KCsdStartingConnect = KStartingConnection; // optional
1.118 +const TInt KCsdFinishedConnect = 3100; // desirable
1.119 +const TInt KCsdStartingLogIn = 3200; // optional
1.120 +const TInt KCsdFinishedLogIn = 3250; // optional
1.121 +
1.122 +const TInt KCsdStartingAnswer = KIncomingConnectionInProgress; // required if supporting incoming connections/callback
1.123 +const TInt KCsdAnswered = 3400; // required if supporting incoming connections/callback
1.124 +
1.125 +const TInt KCsdConnectionOpen = KConnectionOpen; // required
1.126 +const TInt KCsdStartingHangUp = KConnectionStartingClose; // desirable
1.127 +const TInt KCsdFinishedHangUp = KConnectionClosed; // required
1.128 +
1.129 +/**
1.130 + Generic progress notifications from the configuration daemon.
1.131 + @publishedAll
1.132 + @released
1.133 +**/
1.134 +const TInt KMinConfigDaemonProgress = 8100;
1.135 +const TInt KConfigDaemonLoading = 8100;
1.136 +const TInt KConfigDaemonLoaded = 8200;
1.137 +const TInt KConfigDaemonStartingRegistration = 8300;
1.138 +const TInt KConfigDaemonFinishedRegistration = 8400;
1.139 +const TInt KConfigDaemonStartingDeregistration = 8600;
1.140 +const TInt KConfigDaemonFinishedDeregistrationStop = 8700;
1.141 +const TInt KConfigDaemonFinishedDeregistrationPreserve = 8701;
1.142 +const TInt KConfigDaemonFinishedDormantMode = 8750;
1.143 +const TInt KConfigDaemonUnloading = 8800;
1.144 +const TInt KConfigDaemonUnloaded = 8900;
1.145 +const TInt KMaxConfigDaemonProgress = 8900;
1.146 +
1.147 +/**
1.148 +Generic progress notifications from the null configuration daemon.
1.149 +@internalComponent
1.150 +@released
1.151 +**/
1.152 +const TInt KNullConfigDaemonConfigureNetwork = 8401;
1.153 +
1.154 +/**
1.155 +New software should use the progress ranges defined above
1.156 +
1.157 +@publishedAll
1.158 +@deprecated 7.0s - maintained for compatibility with 6.1
1.159 +*/
1.160 +const TInt KAgentUninitialised = KConnectionUninitialised;
1.161 +const TInt KAgentUnconnected = 1;
1.162 +const TInt KMaxAgentProgress = 999;
1.163 +const TInt KMinInterfaceProgress = 1000;
1.164 +const TInt KMaxInterfaceProgress = 1999;
1.165 +
1.166 +/**
1.167 +Callback actions
1.168 +@internalComponent
1.169 +*/
1.170 +enum TCallbackAction
1.171 + {
1.172 + ECallbackActionIETFType0 =0,
1.173 + ECallbackActionIETFType1 =1,
1.174 + ECallbackActionIETFType2 =2,
1.175 + ECallbackActionIETFType3 =3,
1.176 + ECallbackActionIETFType4 =4,
1.177 + ECallbackActionIETFType5 =5,
1.178 + //
1.179 + ECallbackActionMSCBCPRequireClientSpecifiedNumber = 1001,
1.180 + ECallbackActionMSCBCPAcceptServerSpecifiedNumber = 1002,
1.181 + ECallbackActionMSCBCPOverrideServerSpecifiedNumber = 1003
1.182 + };
1.183 +
1.184 +/**
1.185 +The type of connection provided by the network interface
1.186 +
1.187 +@publishedAll
1.188 +@released
1.189 +@note It is acceptable for clients to check that a TConnectionType falls within a
1.190 +specified range, and assume that the basic parameters can be obtained. For example,
1.191 +if the returned TConnectionType is between 2000 and 2499, it would be acceptable for
1.192 +a client to assume that it was a GPRS connection, and that TGPRSSubConnectionInfo
1.193 +is an acceptable class to use for GetSubConnectionInfo() calls
1.194 +*/
1.195 +enum TConnectionType
1.196 + {
1.197 + /** Connection values <1000 for generic interface values
1.198 + These are used to indicate an interface does not support extended
1.199 + management functionality, and a limited subset of information is made
1.200 + available through a compatibility layer
1.201 + */
1.202 + EConnectionGeneric,
1.203 +
1.204 + /** Connection values 1000-1999 for CSD connections
1.205 + */
1.206 + EConnectionCSD = 1000,
1.207 +
1.208 + /** Connection values > 2000 for PSD connections
1.209 + Connection values 2000-2499 for subsets of GPRS/UMTS
1.210 + */
1.211 + EConnectionGPRS = 2000,
1.212 +
1.213 + EConnectionGPRSR97,
1.214 + EConnectionGPRSR99,
1.215 + EConnectionGPRSRel4,
1.216 + EConnectionGPRSRel5,
1.217 +
1.218 + /** Connection values 2500-2999 for subsets of CDMA
1.219 + @todo Check these CDMA values to find which ones affect the interface features
1.220 + */
1.221 + EConnectionCDMA = 2500,
1.222 +
1.223 + EConnectionCDMA20001xRTT,
1.224 + EConnectionCDMA20001xRTTDO,
1.225 + EConnectionCDMA20001xRTTDV,
1.226 + EConnectionCDMA20003xRTT,
1.227 + /** Connection values 3000 for IEEE802.3 (Ethernet)
1.228 + */
1.229 + EConnectionEthernet = 3000,
1.230 +
1.231 + /** Connection values 3100 for IEEE802.11 (WLAN)
1.232 + */
1.233 + EConnectionWLAN = 3100,
1.234 +
1.235 + /** Connection values 4000 - 4099 for Bluetooth PAN profile interfaces
1.236 + */
1.237 + EConnectionBTPAN = 4000
1.238 +
1.239 + /** Connection values 4100+ for other PS technologies
1.240 + */
1.241 + };
1.242 +
1.243 +/**
1.244 +The layer to which the call refers
1.245 +@note Used by data sent and received to indicate to which layer the byte count refers
1.246 +@todo Write about this, add appropriate arguments to interfaces
1.247 +@internalTechnology
1.248 +*/
1.249 +enum TConnectionLayer
1.250 + {
1.251 + EPhysicalLayer,
1.252 + EDataLinkLayer = 100,
1.253 + ENetworkLayer = 200,
1.254 + ETransportLayer = 300,
1.255 + ESessionLayer = 400,
1.256 + EPresentationLayer = 500,
1.257 + EApplicationLayer = 600
1.258 + };
1.259 +
1.260 +#endif