epoc32/include/nifvar.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /**
     1 /**
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     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
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    17 *
    17 *
    18 */
    18 */
    19 
    19 
    20 
    20 
    21 
    21 
    22 
       
    23 
       
    24 /**
    22 /**
    25  @file NIFVAR.H
    23  @file NIFVAR.H
    26  @publishedAll
    24  @publishedAll
    27  @released
    25  @released
    28 */
    26 */
    30 
    28 
    31 #if !defined(__NIFVAR_H__)
    29 #if !defined(__NIFVAR_H__)
    32 #define __NIFVAR_H__
    30 #define __NIFVAR_H__
    33 
    31 
    34 #include <e32std.h>
    32 #include <e32std.h>
       
    33 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    34 #include <nifvar_internal.h>
       
    35 #endif
    35 
    36 
    36 /**
    37 /**
    37 Generic Progress Constant
    38 Generic Progress Constant
    38 From NIFMAN
    39 From NIFMAN
    39 @note These ranges must be obeyed by all network adapters
    40 @note These ranges must be obeyed by all network adapters
    51 const TInt KConnectionOpen           = 3500;           // From an Agent
    52 const TInt KConnectionOpen           = 3500;           // From an Agent
    52 const TInt KConnectionClosed         = 4500;           // From an Agent
    53 const TInt KConnectionClosed         = 4500;           // From an Agent
    53 const TInt KMaxAgtProgress           = 5500;
    54 const TInt KMaxAgtProgress           = 5500;
    54 
    55 
    55 const TInt KMinNifProgress           = 6000;
    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 */
    56 const TInt KLinkLayerOpen            = 7000;           // From a NIF
    66 const TInt KLinkLayerOpen            = 7000;           // From a NIF
    57 const TInt KLinkLayerClosed          = 8000;           // From a NIF
    67 const TInt KLinkLayerClosed          = 8000;           // From a NIF
    58 const TInt KMaxNifProgress           = 9000;
       
    59 
    68 
    60 /**
    69 /**
    61 Additional generic progress constantfrom an agent
    70 Additional generic progress constantfrom an agent
    62 @note These values may be implemented by network adapters (nifs/agents) 
    71 @note These values may be implemented by network adapters (nifs/agents) 
    63 @see KPsdStartingConfiguration
    72 @see KPsdStartingConfiguration
    67 @released
    76 @released
    68 */
    77 */
    69 const TInt KStartingConnection = 3000;				// from an agent
    78 const TInt KStartingConnection = 3000;				// from an agent
    70 const TInt KIncomingConnectionInProgress = 3350;	// from an agent
    79 const TInt KIncomingConnectionInProgress = 3350;	// from an agent
    71 const TInt KDataTransferTemporarilyBlocked = 4000;	// eg. suspended (GPRS); 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
    72 const TInt KConnectionStartingClose	= 4250;			// from an agent
    82 const TInt KConnectionStartingClose	= 4250;			// from an agent
    73 
    83 
    74 /**
    84 /**
    75 Additional generic progress constant
    85 Additional generic progress constant
    76 from an agent
    86 from an agent
   139 const TInt KConfigDaemonUnloading = 8800;
   149 const TInt KConfigDaemonUnloading = 8800;
   140 const TInt KConfigDaemonUnloaded = 8900;
   150 const TInt KConfigDaemonUnloaded = 8900;
   141 const TInt KMaxConfigDaemonProgress = 8900;
   151 const TInt KMaxConfigDaemonProgress = 8900;
   142  
   152  
   143 /**
   153 /**
   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
   154 New software should use the progress ranges defined above
   152 
   155 
   153 @publishedAll
   156 @publishedAll
   154 @deprecated 7.0s - maintained for compatibility with 6.1
   157 @deprecated 7.0s - maintained for compatibility with 6.1
   155 */
   158 */
   158 const TInt KMaxAgentProgress = 999;
   161 const TInt KMaxAgentProgress = 999;
   159 const TInt KMinInterfaceProgress = 1000;
   162 const TInt KMinInterfaceProgress = 1000;
   160 const TInt KMaxInterfaceProgress = 1999;
   163 const TInt KMaxInterfaceProgress = 1999;
   161 
   164 
   162 /**
   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 /**
   163 Callback actions
   216 Callback actions
   164 @internalComponent
   217 @publishedAll
       
   218 @released
   165 */
   219 */
   166 enum TCallbackAction
   220 enum TCallbackAction
   167 	{
   221 	{
   168 	ECallbackActionIETFType0	=0,
   222 	ECallbackActionIETFType0	=0,
   169 	ECallbackActionIETFType1	=1,
   223 	ECallbackActionIETFType1	=1,
   175 	ECallbackActionMSCBCPRequireClientSpecifiedNumber	= 1001,
   229 	ECallbackActionMSCBCPRequireClientSpecifiedNumber	= 1001,
   176 	ECallbackActionMSCBCPAcceptServerSpecifiedNumber	= 1002,
   230 	ECallbackActionMSCBCPAcceptServerSpecifiedNumber	= 1002,
   177 	ECallbackActionMSCBCPOverrideServerSpecifiedNumber	= 1003
   231 	ECallbackActionMSCBCPOverrideServerSpecifiedNumber	= 1003
   178 	};
   232 	};
   179 
   233 
   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
   234 #endif