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