epoc32/include/connectprog.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.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
*
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 CONNECTPROG.H
williamr@2
    24
*/
williamr@2
    25
williamr@2
    26
#ifndef __CONNECTPROG_H__
williamr@2
    27
#define __CONNECTPROG_H__
williamr@2
    28
williamr@2
    29
#include <csdprog.h>
williamr@2
    30
williamr@2
    31
// Stages in establishing a connection with NetDial
williamr@2
    32
williamr@2
    33
 /**
williamr@2
    34
 * Defines the stages in establishing a connection with dial-up networking.
williamr@2
    35
 *
williamr@2
    36
 * The stages which may be reported depend on the type of connection being made. 
williamr@2
    37
 * Stage information is usually read from a TNifProgress::iStage member.
williamr@2
    38
 *
williamr@2
    39
 * @publishedAll
williamr@2
    40
 * @since		v5.0  
williamr@2
    41
 * @deprecated	7.0s - maintained for compatibility with 6.1\n
williamr@2
    42
 *				This enumeration is still used by the new RGenericAgent API.\n\n
williamr@2
    43
 *				New software should use the CSD progress values defined in csdprog.h
williamr@2
    44
 * 
williamr@2
    45
 * \n
williamr@2
    46
 * For a \b Dial \b Up \b Connection (outgoing call), the following stages are reported 
williamr@2
    47
 * in this order \n 
williamr@2
    48
 * (the meaning of each enumerator is defined in the enumeration values / member list, below):
williamr@2
    49
 * -# EStartingSelection 
williamr@2
    50
 * -# EFinishedSelection 
williamr@2
    51
 * -# EStartingDialling 
williamr@2
    52
 * -# EFinishedDialling 
williamr@2
    53
 * -# EScanningScript 
williamr@2
    54
 * -# EScannedScript 
williamr@2
    55
 * -# EGettingLoginInfo 
williamr@2
    56
 * -# EGotLoginInfo 
williamr@2
    57
 * -# EStartingLogIn 
williamr@2
    58
 * -# EFinishedLogIn 
williamr@2
    59
 * -# EConnectionOpen 
williamr@2
    60
 * -# EStartingHangUp 
williamr@2
    61
 * -# EFinishedHangUp 
williamr@2
    62
 *		   
williamr@2
    63
 * For a \b Dial \b In \b Connection (incoming call), the following stages are
williamr@2
    64
 * reported in this order: 
williamr@2
    65
 * -# EStartingAnswer 
williamr@2
    66
 * -# EAnswered 
williamr@2
    67
 * -# EConnectionOpen 
williamr@2
    68
 * -# EStartingHangUp 
williamr@2
    69
 * -# EFinishedHangUp 
williamr@2
    70
 *
williamr@2
    71
 * For a \b Direct \b Connection, the following stages are reported in this order:
williamr@2
    72
 * -# EStartingSelection 
williamr@2
    73
 * -# EFinishedSelection 
williamr@2
    74
 * -# EScanningScript 
williamr@2
    75
 * -# EScannedScript 
williamr@2
    76
 * -# EStartingConnect 
williamr@2
    77
 * -# EFinishedConnect 
williamr@2
    78
 * -# EConnectionOpen 
williamr@2
    79
 * -# EStartingHangUp 
williamr@2
    80
 * -# EFinishedHangUp 	
williamr@2
    81
 */
williamr@2
    82
 
williamr@2
    83
enum TNetDialProgress
williamr@2
    84
	{
williamr@2
    85
	/** Start selection of service and location. */
williamr@2
    86
	EStartingSelection=2,
williamr@2
    87
	/** Selection of service and location is complete. */
williamr@2
    88
	EFinishedSelection,	
williamr@2
    89
	/** Starting the dialling phase. */
williamr@2
    90
	EStartingDialling,
williamr@2
    91
	/** Dialling phase complete. */
williamr@2
    92
	EFinishedDialling,
williamr@2
    93
	/** Start scanning the script. */
williamr@2
    94
	EScanningScript,
williamr@2
    95
	/** Scanning the script is complete. */
williamr@2
    96
	EScannedScript,
williamr@2
    97
	/** Get login information from database or user */
williamr@2
    98
	EGettingLoginInfo,
williamr@2
    99
	/** The fetching of login information is complete. */
williamr@2
   100
	EGotLoginInfo,
williamr@2
   101
	/** Start the connection process; executes the script, if there is one */
williamr@2
   102
	EStartingConnect,				// 10
williamr@2
   103
	/** Connection process is complete */
williamr@2
   104
	EFinishedConnect,
williamr@2
   105
	/** Start the login process; executes the script, if there is one. */
williamr@2
   106
	EStartingLogIn,
williamr@2
   107
	/** Login process is complete */
williamr@2
   108
	EFinishedLogIn,
williamr@2
   109
	/** The connection is now open */
williamr@2
   110
	EConnectionOpen,
williamr@2
   111
	/** Starting the hang-up process */
williamr@2
   112
	EStartingHangUp,
williamr@2
   113
	/** Hang up process is complete */
williamr@2
   114
	EFinishedHangUp,
williamr@2
   115
	/** Start the answering phase. */
williamr@2
   116
	EStartingAnswer,
williamr@2
   117
	/** Answering is complete */
williamr@2
   118
	EAnswered,						// 18
williamr@2
   119
	/** Error setting overrides (note that this is reported only if an
williamr@2
   120
	* error occurs, in which case it will be the first stage of the connection). */
williamr@2
   121
	ESettingOverrides
williamr@2
   122
	};
williamr@2
   123
williamr@2
   124
williamr@2
   125
williamr@2
   126
#endif