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