26
|
1 |
/*
|
|
2 |
* Copyright (c) 2010 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: Main handler for incoming requests
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef ATMISCCMDPLUGIN_H
|
|
19 |
#define ATMISCCMDPLUGIN_H
|
|
20 |
|
|
21 |
#include <atextpluginbase.h>
|
|
22 |
#include <etelmm.h>
|
|
23 |
|
|
24 |
#include "atcommandparser.h"
|
|
25 |
|
32
|
26 |
class MATCmdBase;
|
|
27 |
class CATCmdAsyncBase;
|
|
28 |
class CATCmdSyncBase;
|
|
29 |
|
26
|
30 |
/** Character types: carriage return, line feed or backspace */
|
|
31 |
enum TCharacterTypes
|
|
32 |
{
|
|
33 |
ECharTypeCR, // Carriage return
|
|
34 |
ECharTypeLF, // Line feed
|
|
35 |
ECharTypeBS // Backspace
|
|
36 |
};
|
|
37 |
|
|
38 |
/** Type of modes (quiet, verbose) */
|
|
39 |
enum TModeTypes
|
|
40 |
{
|
|
41 |
EModeTypeQuiet, // Quiet mode
|
|
42 |
EModeTypeVerbose // Verbose mode
|
|
43 |
};
|
|
44 |
|
|
45 |
|
|
46 |
/**
|
|
47 |
* Class for accessing plugin information and common functionality
|
|
48 |
*/
|
|
49 |
NONSHARABLE_CLASS( MATMiscCmdPlugin )
|
|
50 |
{
|
|
51 |
public:
|
|
52 |
/**
|
|
53 |
* Creates an AT command reply based on the reply type and completes the
|
|
54 |
* request to ATEXT.
|
|
55 |
*
|
|
56 |
* @param aReplyType Type of reply
|
|
57 |
* @param aSrcBuffer Source buffer; used only if aReplyType is EReplyTypeOther
|
|
58 |
* @param aError Completion code. If not KErrNone then other arguments are
|
|
59 |
* ignored and the request is completed to ATEXT with
|
|
60 |
* EReplyTypeUndefined.
|
|
61 |
* @return Symbian error code on error, KErrNone otherwise
|
|
62 |
*/
|
|
63 |
virtual TInt CreateReplyAndComplete( TATExtensionReplyType aReplyType,
|
|
64 |
const TDesC8& aSrcBuffer=KNullDesC8,
|
|
65 |
TInt aError=KErrNone ) = 0;
|
|
66 |
|
|
67 |
/**
|
|
68 |
* Creates a buffer for "OK" or "ERROR" reply based on the line settings
|
|
69 |
*
|
|
70 |
* @param aReplyBuffer Destination buffer for the created reply
|
|
71 |
* @param aOkReply ETrue if "OK" reply needed,
|
|
72 |
* EFalse if "ERROR" reply needed
|
|
73 |
* @return Symbian error code on error, KErrNone otherwise
|
|
74 |
*/
|
|
75 |
virtual TInt CreateOkOrErrorReply( RBuf8& aReplyBuffer,
|
|
76 |
TBool aOkReply ) = 0;
|
|
77 |
|
|
78 |
/*
|
|
79 |
* Complete the AT command request with AT CME error code according to given Symbian error code
|
|
80 |
* @param aError Symbian error code
|
|
81 |
*/
|
|
82 |
virtual void CreateCMEReplyAndComplete(TInt aError) = 0;
|
|
83 |
|
45
|
84 |
/*
|
|
85 |
* Complete the AT command request with AT CMS error code according to given Symbian error code
|
|
86 |
* @param aError Symbian error code
|
|
87 |
*/
|
|
88 |
|
|
89 |
virtual void CreateCMSReplyAndComplete(TInt aError) = 0;
|
|
90 |
|
26
|
91 |
/**
|
|
92 |
* Returns plugin's character value settings (from CATExtPluginBase)
|
|
93 |
*
|
|
94 |
* @param aCharType Character's type
|
|
95 |
* @param aChar Character's value matching aCharType
|
|
96 |
* @return Symbian error code on error, KErrNone otherwise
|
|
97 |
*/
|
|
98 |
virtual TInt GetCharacterValue( TCharacterTypes aCharType, TChar& aChar ) = 0;
|
|
99 |
|
|
100 |
/**
|
|
101 |
* Returns plugin's mode value settings (from CATExtPluginBase)
|
|
102 |
*
|
|
103 |
* @param aModeType Mode type
|
|
104 |
* @param aMode Mode value matching aModeType
|
|
105 |
* @return Symbian error code on error, KErrNone otherwise
|
|
106 |
*/
|
|
107 |
virtual TInt GetModeValue( TModeTypes aModeType, TBool& aMode ) = 0;
|
|
108 |
|
|
109 |
/**
|
|
110 |
* Returns plugin's response to an unsolicited request
|
|
111 |
*
|
|
112 |
* @param aAT the response to display to the user from unsolicited event
|
|
113 |
* @return Symbian error code on error, KErrNone otherwise
|
|
114 |
*/
|
|
115 |
virtual TInt HandleUnsolicitedRequest(const TDesC8& aAT ) = 0;
|
|
116 |
};
|
|
117 |
|
|
118 |
/**
|
|
119 |
* Class for selecting handlers for different AT commands
|
|
120 |
*/
|
|
121 |
NONSHARABLE_CLASS( CATMiscCmdPlugin ) : public CATExtPluginBase,
|
|
122 |
public MATMiscCmdPlugin
|
|
123 |
{
|
|
124 |
public:
|
|
125 |
static CATMiscCmdPlugin* NewL();
|
|
126 |
virtual ~CATMiscCmdPlugin();
|
|
127 |
|
|
128 |
private: // methods from base class CATExtPluginBase
|
|
129 |
void ReportConnectionName( const TDesC8& aName );
|
|
130 |
TBool IsCommandSupported( const TDesC8& aCmd );
|
|
131 |
void HandleCommand( const TDesC8& aCmd, RBuf8& aReply, TBool aReplyNeeded );
|
|
132 |
void HandleCommandCancel();
|
|
133 |
TInt NextReplyPartLength();
|
|
134 |
TInt GetNextPartOfReply( RBuf8& aNextReply );
|
|
135 |
void ReceiveUnsolicitedResult();
|
|
136 |
void ReceiveUnsolicitedResultCancel();
|
|
137 |
void ReportNvramStatusChange( const TDesC8& aNvram );
|
|
138 |
void ReportExternalHandleCommandError();
|
|
139 |
|
|
140 |
private: // methods from base class MATMiscCmdPlugin
|
|
141 |
virtual TInt CreateReplyAndComplete( TATExtensionReplyType aReplyType,
|
|
142 |
const TDesC8& aSrcBuffer=KNullDesC8,
|
|
143 |
TInt aError=KErrNone );
|
|
144 |
|
|
145 |
virtual TInt CreateOkOrErrorReply( RBuf8& aReplyBuffer,
|
|
146 |
TBool aOkReply );
|
45
|
147 |
|
|
148 |
virtual TInt CreateEditModeBuffer( RBuf8& aReplyBuffer );
|
|
149 |
virtual void CreateCMSReplyAndComplete(TInt aError);
|
|
150 |
|
26
|
151 |
virtual void CreateCMEReplyAndComplete(TInt aError);
|
|
152 |
virtual TInt GetCharacterValue( TCharacterTypes aCharType, TChar& aChar );
|
|
153 |
virtual TInt GetModeValue( TModeTypes aModeType, TBool& aMode );
|
|
154 |
virtual TInt HandleUnsolicitedRequest(const TDesC8& aAT );
|
|
155 |
|
|
156 |
private:
|
|
157 |
CATMiscCmdPlugin();
|
|
158 |
void ConstructL();
|
|
159 |
|
|
160 |
TInt CreatePartOfReply( RBuf8& aBuffer );
|
32
|
161 |
void HandleCMEECommand();
|
45
|
162 |
void HandleCMGFCommand();
|
|
163 |
|
26
|
164 |
/*
|
|
165 |
* Utility function that connect to Etel server and establish a subsession to RMobilePhone
|
|
166 |
* Caller must close session and subsession after use.
|
|
167 |
* @param aTelServer returns session to ETel
|
|
168 |
* @param aPhone returns RMobilePhone subsession
|
|
169 |
*/
|
|
170 |
void ConnectToEtelL(RTelServer& aTelServer, RMobilePhone& aPhone);
|
|
171 |
|
|
172 |
|
|
173 |
private:
|
|
174 |
TAtCommandParser iCommandParser;
|
|
175 |
RTelServer iTelServer;
|
|
176 |
RMobilePhone iPhone;
|
|
177 |
/**
|
|
178 |
* Current AT command handler in.
|
|
179 |
* Used when IsCommandSupported() detects a matching handler class.
|
|
180 |
*/
|
32
|
181 |
MATCmdBase* iCurrentHandler;
|
26
|
182 |
|
|
183 |
CATCmdAsyncBase* iCLCKHandler;
|
|
184 |
CATCmdAsyncBase* iCPWDHandler;
|
|
185 |
CATCmdAsyncBase* iCPINHandler;
|
32
|
186 |
CATCmdSyncBase* iCUSDHandler;
|
26
|
187 |
CATCmdAsyncBase* iCNUMHandler;
|
|
188 |
CATCmdAsyncBase* iCFUNHandler;
|
|
189 |
CATCmdAsyncBase* iCBCHandler;
|
45
|
190 |
|
|
191 |
// TDSCDMA only
|
|
192 |
CATCmdSyncBase* iHVERHandler;
|
|
193 |
CATCmdSyncBase* iCGSNHandler;
|
|
194 |
CATCmdSyncBase* iCGMRHandler;
|
|
195 |
CATCmdSyncBase* iCGMIHandler;
|
|
196 |
CATCmdAsyncBase* iCMGWHandler;
|
|
197 |
CATCmdAsyncBase* iCMGDHandler;
|
|
198 |
|
26
|
199 |
/**
|
|
200 |
* Buffer for handle command's command
|
|
201 |
* Not own.
|
|
202 |
*/
|
|
203 |
const TDesC8* iHcCmd;
|
|
204 |
|
|
205 |
/**
|
|
206 |
* Buffer for handle command reply
|
|
207 |
* Not own.
|
|
208 |
*/
|
|
209 |
RBuf8* iHcReply;
|
|
210 |
|
|
211 |
/**
|
|
212 |
* Global reply buffer for the AT command replies
|
|
213 |
*/
|
|
214 |
RBuf8 iReplyBuffer;
|
32
|
215 |
|
|
216 |
/**
|
|
217 |
* +CME error level
|
|
218 |
*/
|
|
219 |
TInt iErrorLevel;
|
26
|
220 |
};
|
|
221 |
|
|
222 |
#endif // ATMISCCMDPLUGIN_H
|
|
223 |
|