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