epoc32/include/agentdialog.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
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
* Generic Connection Dialog Client
williamr@2
    16
* 
williamr@2
    17
*
williamr@2
    18
*/
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
 @file AGENTDIALOG.H
williamr@2
    26
 @internalTechnology
williamr@2
    27
*/
williamr@2
    28
williamr@2
    29
#ifndef __AGENTDIALOG_H__
williamr@2
    30
#define __AGENTDIALOG_H__
williamr@2
    31
williamr@2
    32
#include <e32std.h>
williamr@2
    33
#include <cdbcols.h>
williamr@2
    34
#include <cdblen.h>
williamr@2
    35
//#include <comms-infras/commsdebugutility.h> Cannot be included because it conflicts with flogger
williamr@2
    36
williamr@2
    37
williamr@2
    38
/**
williamr@2
    39
Server name in EKA2 case
williamr@2
    40
@internalTechnology
williamr@2
    41
*/
williamr@2
    42
_LIT(KCommsDialogServerName, "!NetDialDialogServer");
williamr@2
    43
williamr@2
    44
//__FLOG_STMT(_LIT8(KDlgSvrLogSubsys, "agentdialog");)
williamr@2
    45
//__FLOG_STMT(_LIT8(KDlgSvrLogComponent, "server");)
williamr@2
    46
//__FLOG_STMT(_LIT8(KDlgCliLogComponent, "client");)
williamr@2
    47
williamr@2
    48
class TConnectionPrefs
williamr@2
    49
/**
williamr@2
    50
Specifies the rank and desired direction of the connection and bearer.
williamr@2
    51
williamr@2
    52
@internalTechnology
williamr@2
    53
*/
williamr@2
    54
	{
williamr@2
    55
public:
williamr@2
    56
	TUint32 iRank;
williamr@2
    57
	TCommDbConnectionDirection iDirection;
williamr@2
    58
	TUint32 iBearerSet;
williamr@2
    59
	};
williamr@2
    60
williamr@2
    61
class TIspConnectionNames
williamr@2
    62
/**
williamr@2
    63
Specifies the Connection Names for ISP.
williamr@2
    64
williamr@2
    65
@internalTechnology
williamr@2
    66
*/
williamr@2
    67
	{
williamr@2
    68
public:
williamr@2
    69
	TBuf<KCommsDbSvrDefaultTextFieldLength> iServiceName;
williamr@2
    70
	TBuf<KCommsDbSvrMaxColumnNameLength> iServiceTable;
williamr@2
    71
	TBuf<KCommsDbSvrDefaultTextFieldLength> iModemName;
williamr@2
    72
	TBuf<KCommsDbSvrDefaultTextFieldLength> iLocationName;
williamr@2
    73
	TBuf<KCommsDbSvrDefaultTextFieldLength> iChargecardName;
williamr@2
    74
	};
williamr@2
    75
williamr@2
    76
class TAuthenticationPair
williamr@2
    77
/**
williamr@2
    78
Specifies the Authentication for the User Name and Password.
williamr@2
    79
williamr@2
    80
@internalTechnology
williamr@2
    81
*/
williamr@2
    82
	{
williamr@2
    83
public:
williamr@2
    84
	TDes* iUsername;
williamr@2
    85
	TDes* iPassword;
williamr@2
    86
	};
williamr@2
    87
williamr@2
    88
class TPctResponse
williamr@2
    89
/**
williamr@2
    90
Allows the user to see the login script running, see what is sent and received, and allows the user to type responses.
williamr@2
    91
williamr@2
    92
@internalTechnology
williamr@2
    93
*/
williamr@2
    94
	{
williamr@2
    95
public:
williamr@2
    96
	TDes* iBuffer;
williamr@2
    97
	};
williamr@2
    98
williamr@2
    99
class TNewIapConnectionPrefs
williamr@2
   100
/**
williamr@2
   101
Specifies Connection Preference for the New IAP.
williamr@2
   102
williamr@2
   103
@internalTechnology
williamr@2
   104
*/
williamr@2
   105
	{
williamr@2
   106
public:
williamr@2
   107
	TConnectionPrefs iPrefs;
williamr@2
   108
	TInt iLastError;
williamr@2
   109
	TBuf<KCommsDbSvrDefaultTextFieldLength> iName;
williamr@2
   110
	};
williamr@2
   111
williamr@2
   112
class RDialogNotifier : public RNotifier
williamr@2
   113
/**
williamr@2
   114
Client interface to allow engines or other low level components to communicate with the UI.
williamr@2
   115
williamr@2
   116
Real implementations need three asynchronous message slots instead of RNotifiers default one slot
williamr@2
   117
in order to implement the PCT functionality.  This is not used at all by the test dialog server
williamr@2
   118
implementation.
williamr@2
   119
 
williamr@2
   120
@internalTechnology
williamr@2
   121
*/
williamr@2
   122
	{
williamr@2
   123
public :
williamr@2
   124
	TInt Connect();
williamr@2
   125
	};
williamr@2
   126
williamr@2
   127
class RGenConAgentDialogServer : public RSessionBase
williamr@2
   128
/**
williamr@2
   129
RGenConAgentDialogServer. This components needs to be written as a 
williamr@2
   130
proper polymorphic DLL in JetStream.
williamr@2
   131
williamr@2
   132
NOTE! Although the class inherits from RSessionBase this does not mean you 
williamr@2
   133
have to implement the API as a client server mechanism.
williamr@2
   134
williamr@2
   135
@internalTechnology
williamr@2
   136
*/
williamr@2
   137
	{
williamr@2
   138
public:
williamr@2
   139
	IMPORT_C RGenConAgentDialogServer();
williamr@2
   140
	IMPORT_C ~RGenConAgentDialogServer();
williamr@2
   141
	IMPORT_C TVersion Version() const;
williamr@2
   142
	IMPORT_C TInt Connect();
williamr@2
   143
	IMPORT_C void Close();
williamr@2
   144
	IMPORT_C void ModemAndLocationSelection(TUint32& aModemId,TUint32& aLocationId,TRequestStatus& aStatus);
williamr@2
   145
	IMPORT_C void IapConnection(TUint32& aIAP, const TConnectionPrefs& aPrefs, TRequestStatus& aStatus);
williamr@2
   146
	IMPORT_C void IapConnection(TUint32& aIAP, const TConnectionPrefs& aPrefs, TInt aLastError, TRequestStatus& aStatus);
williamr@2
   147
	IMPORT_C void WarnNewIapConnection(const TConnectionPrefs& aPrefs, TInt aLastError, const TDesC& aNewIapName, TBool& aResponse, TRequestStatus& aStatus);
williamr@2
   148
	IMPORT_C void Login(TDes& aUsername, TDes& aPassword, TBool aIsReconnect, TRequestStatus& aStatus);
williamr@2
   149
	IMPORT_C void Authenticate(TDes& aUsername, TDes& aPassword, TBool aIsReconnect, TRequestStatus& aStatus);
williamr@2
   150
	IMPORT_C void Reconnect(TBool& aResponse, TRequestStatus& aStatus);
williamr@2
   151
	IMPORT_C TInt OpenPct();
williamr@2
   152
	IMPORT_C TInt WritePct(const TDesC& aData);
williamr@2
   153
	IMPORT_C void ReadPct(TDes& aData, TRequestStatus& aStatus);
williamr@2
   154
	IMPORT_C void DestroyPctNotification(TRequestStatus& aStatus);
williamr@2
   155
	IMPORT_C void ClosePct();
williamr@2
   156
	IMPORT_C void QoSWarning(TBool& aResponse, TRequestStatus& aStatus);
williamr@2
   157
	IMPORT_C void CancelModemAndLocationSelection();
williamr@2
   158
	IMPORT_C void CancelIapConnection();
williamr@2
   159
	IMPORT_C void CancelWarnNewIapConnection();
williamr@2
   160
	IMPORT_C void CancelLogin();
williamr@2
   161
	IMPORT_C void CancelAuthenticate();
williamr@2
   162
	IMPORT_C void CancelReconnect();
williamr@2
   163
	IMPORT_C void CancelReadPct();
williamr@2
   164
	IMPORT_C void CancelDestroyPctNotification();
williamr@2
   165
	IMPORT_C void CancelQoSWarning();
williamr@2
   166
	IMPORT_C void AccessPointConnection(TUint32& aAccessPoint, TInt aAccessPointGroup, TRequestStatus& aStatus);
williamr@2
   167
	IMPORT_C void CancelAccessPointConnection();
williamr@2
   168
	IMPORT_C void AccessPointConnection(TUint32& aAP, TUint32 aAPType, TUint32& aBearerAPInd, TUint32 aBearerAPType, TRequestStatus& aStatus);
williamr@2
   169
williamr@2
   170
private:
williamr@2
   171
	RDialogNotifier* iNotifier;
williamr@2
   172
	TPckg<TUint32> iIAP;
williamr@2
   173
	TPckg<TUint32> iModemId;
williamr@2
   174
	TPckg<TUint32> iLocationId;
williamr@2
   175
	TPckgBuf<TIspConnectionNames> iConNames;
williamr@2
   176
	TPckgBuf<TConnectionPrefs> iPrefs;
williamr@2
   177
	TPckg<TBool> iBool;
williamr@2
   178
	TPckgBuf<TUint32> iPctBuffer;
williamr@2
   179
	TPckgBuf<TPctResponse> iPctResponse;
williamr@2
   180
	TPckgBuf<TAuthenticationPair> iAuthenticationPair;
williamr@2
   181
	TPckgBuf<TNewIapConnectionPrefs> iNewIapPrefsBuffer;
williamr@2
   182
	TPckgBuf<TUint32> iNotUsed;		// Parameters not used by plugin
williamr@2
   183
	TRequestStatus iStatus;
williamr@2
   184
	TPckg<TUint32> iAccessPoint;
williamr@2
   185
//	__FLOG_DECLARATION_MEMBER;
williamr@2
   186
	};
williamr@2
   187
williamr@2
   188
IMPORT_C TInt StartDialogThread();
williamr@2
   189
williamr@2
   190
#endif