0
|
1 |
/*
|
|
2 |
* Copyright (c) 2007-2008 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 "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 |
#ifndef CMMDTMFMESSHANDLER_H
|
|
21 |
#define CMMDTMFMESSHANDLER_H
|
|
22 |
|
|
23 |
// INCLUDES
|
|
24 |
#include <e32base.h> // Symbian base types
|
|
25 |
|
|
26 |
#include <tisi.h>
|
|
27 |
#include "mmmmesshandlerbase.h"
|
|
28 |
#include "cmmphonetreceiver.h"
|
|
29 |
|
|
30 |
// CONSTANTS
|
|
31 |
const TUint16 KMaxDataBufferSize( 256 );
|
|
32 |
|
|
33 |
// MACROS
|
|
34 |
//none
|
|
35 |
|
|
36 |
// DATA TYPES
|
|
37 |
//none
|
|
38 |
|
|
39 |
// EXTERNAL DATA STRUCTURES
|
|
40 |
//none
|
|
41 |
|
|
42 |
// FUNCTION PROTOTYPES
|
|
43 |
//none
|
|
44 |
|
|
45 |
// FORWARD DECLARATIONS
|
|
46 |
class CMmPhoNetSender;
|
|
47 |
class CMmDataPackage;
|
|
48 |
class TIsiReceiveC;
|
|
49 |
class CMmMessageRouter;
|
|
50 |
|
|
51 |
// CLASS DECLARATION
|
|
52 |
|
|
53 |
/**
|
|
54 |
* Used for creating and sending DTMF ISI messages to
|
|
55 |
* PhoNet via PhoNetSender. It also receives DTMF
|
|
56 |
* ISI messages from PhoNetReceiver.
|
|
57 |
* @lib nokiatsy.lib
|
|
58 |
* @since Series60_2.6
|
|
59 |
*/
|
|
60 |
class CMmDtmfMessHandler
|
|
61 |
: public CBase, public MMmMessHandlerBase, public MMmMessageReceiver
|
|
62 |
{
|
|
63 |
public: // types
|
|
64 |
|
|
65 |
/**
|
|
66 |
* DTMF types used in Nokia OS
|
|
67 |
*/
|
|
68 |
enum TNOSDtmfType
|
|
69 |
{
|
|
70 |
EDtmfTypeUnknown = 0, // unknown DTMF type
|
|
71 |
EDtmfTypeDigit, // the currently processed DTMF is one digit
|
|
72 |
EDtmfTypeString // the currently processed DTMF is a string
|
|
73 |
};
|
|
74 |
|
|
75 |
public: // Constructors and destructor
|
|
76 |
|
|
77 |
/**
|
|
78 |
* Two-phased constructor.
|
|
79 |
* @param aPhoNetSender pointer to the Phonet sender
|
|
80 |
* @param aPhoNetReceiver pointer to thephonet receiver
|
|
81 |
* @param aMessageRouter pointer to the message router
|
|
82 |
* @return created message handler object
|
|
83 |
*/
|
|
84 |
static CMmDtmfMessHandler* NewL(
|
|
85 |
CMmPhoNetSender* aPhoNetSender,
|
|
86 |
CMmPhoNetReceiver* aPhoNetReceiver,
|
|
87 |
CMmMessageRouter* aMessageRouter );
|
|
88 |
|
|
89 |
/**
|
|
90 |
* Destructor.
|
|
91 |
*/
|
|
92 |
~CMmDtmfMessHandler();
|
|
93 |
|
|
94 |
public: // Functions from base classes
|
|
95 |
|
|
96 |
/**
|
|
97 |
* From MMmMessHandlerBase. This method is the single entry point for
|
|
98 |
* requests coming from the Symbian OS layer to this message handler
|
|
99 |
* @param aIpc IPC number of the request
|
|
100 |
* @return TInt KErrNone or error code
|
|
101 |
*/
|
|
102 |
TInt ExtFuncL( TInt aIpc, const CMmDataPackage* aDataPackage );
|
|
103 |
|
|
104 |
public: // New functions
|
|
105 |
|
|
106 |
/**
|
|
107 |
* Handles a received message by calling the specific
|
|
108 |
* message handling method.
|
|
109 |
* @param TIsiReceiveC, reference to the received message.
|
|
110 |
* @return void
|
|
111 |
*/
|
|
112 |
void ReceiveMessageL( const TIsiReceiveC &aIsiMessage );
|
|
113 |
|
|
114 |
/**
|
|
115 |
* Handles errors comes from PhoNetReceiver RunError
|
|
116 |
* @param const TIsiReceiveC &aIsiMessage: The received ISI message
|
|
117 |
* @param TInt aError: Error code
|
|
118 |
*/
|
|
119 |
void HandleError( const TIsiReceiveC &aIsiMessage, TInt aError );
|
|
120 |
|
|
121 |
/**
|
|
122 |
* Creates CallDtmfSendReq ISI message and sends it to Phonet.
|
|
123 |
* @param TUint8 aTransactionId: unique TransactionId number
|
|
124 |
* @param const TDesC* aDtmfDigit: DTMF digit or string to be sent
|
|
125 |
* @param TNOSDtmfType aDtmfType: string/digit
|
|
126 |
* @return TInt, success/failure value
|
|
127 |
*/
|
|
128 |
TInt CallDtmfSendReqL( TUint8 aTransactionId,
|
|
129 |
const TDesC* aDtmfDigit, TNOSDtmfType aDtmfType );
|
|
130 |
|
|
131 |
/**
|
|
132 |
* CMmDtmfMessHandler::SendPostAddressL
|
|
133 |
* @param const TDesC* aDtmfString: DTMF character(s) to be sent
|
|
134 |
*/
|
|
135 |
void CMmDtmfMessHandler::SendPostAddressL(
|
|
136 |
const TDesC* aDtmfString //dtmf character(s) to be sent
|
|
137 |
);
|
|
138 |
|
|
139 |
private:
|
|
140 |
|
|
141 |
/**
|
|
142 |
* C++ default constructor.
|
|
143 |
*/
|
|
144 |
CMmDtmfMessHandler();
|
|
145 |
|
|
146 |
/**
|
|
147 |
* 2nd phase constructor
|
|
148 |
*/
|
|
149 |
void ConstructL();
|
|
150 |
|
|
151 |
/**
|
|
152 |
* Breaks received CallDtmfSendResp ISI message.
|
|
153 |
* @param TIsiReceiveC, reference to the received message.
|
|
154 |
* @return None
|
|
155 |
*/
|
|
156 |
void CallDtmfSendResp( const TIsiReceiveC &aIsiMessage );
|
|
157 |
|
|
158 |
/**
|
|
159 |
* Creates CallDtmfStopReq ISI message and sends it to Phonet.
|
|
160 |
* @param TUint8 aTransactionId: unique TransactionId number
|
|
161 |
* @return TInt, success/failure value
|
|
162 |
*/
|
|
163 |
TInt CallDtmfStopReq( TUint8 aTransactionId );
|
|
164 |
|
|
165 |
/**
|
|
166 |
* Breaks received CallDtmfStopResp ISI message.
|
|
167 |
* @param TIsiReceiveC, reference to the received message.
|
|
168 |
* @return None
|
|
169 |
*/
|
|
170 |
void CallDtmfStopResp( const TIsiReceiveC &aIsiMessage );
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Breaks received CallDtmfStatusInd ISI message.
|
|
174 |
* @param CIsiMsg, reference to the received message.
|
|
175 |
* @return None
|
|
176 |
*/
|
|
177 |
void CallDtmfStatusInd( const TIsiReceiveC &aIsiMessage );
|
|
178 |
|
|
179 |
/**
|
|
180 |
* Creates dtmf send request sub block
|
|
181 |
* @param const TDesC* aDtmfString: DTMF string
|
|
182 |
* @param const TIsiSendC &aIsiMessage: IsiMsg to be build
|
|
183 |
* @param TInt aCurrentMsgOffset
|
|
184 |
* @param TUint8 aNumOfSbInMessage
|
|
185 |
* @return Indicates should the request be sent or not
|
|
186 |
*/
|
|
187 |
TBool GetCallDtmfSendReqSubBlockL( const TDesC* aDtmfString,
|
|
188 |
TIsiSend &aIsiMessage,
|
|
189 |
TUint &aCurrentMsgOffset,
|
|
190 |
TUint8 &aNumOfSbInMessage );
|
|
191 |
|
|
192 |
/**
|
|
193 |
* Handles the dtmf status indication message
|
|
194 |
* CIsiMsg* aIsiMsg: The received ISI message
|
|
195 |
* @param CIsiMsg* aIsiMsg , the received message.
|
|
196 |
* @return None
|
|
197 |
*/
|
|
198 |
void CallDtmfToneInd( const TIsiReceiveC &aIsiMessage );
|
|
199 |
|
|
200 |
|
|
201 |
private: // Data
|
|
202 |
|
|
203 |
//Pointer to the PhonetSender
|
|
204 |
CMmPhoNetSender* iPhoNetSender;
|
|
205 |
|
|
206 |
//Pointer to the Message Router
|
|
207 |
CMmMessageRouter* iMessageRouter;
|
|
208 |
|
|
209 |
//To distinguish between string and digit
|
|
210 |
TNOSDtmfType iDtmfType;
|
|
211 |
|
|
212 |
//The Dtmf digit that is active at the moment
|
|
213 |
TUint16 iDtmfDigitSent;
|
|
214 |
|
|
215 |
//buffer for storing DTMF string after 'w' mark in the DTMF string
|
|
216 |
TBuf<KMaxDataBufferSize> iDTMFStringAfterW;
|
|
217 |
|
|
218 |
// Set if DTMF string includes character 'W'
|
|
219 |
TBool iCharWFound;
|
|
220 |
|
|
221 |
// True if DTMF send is already started
|
|
222 |
TBool iDtmfSendOngoing;
|
|
223 |
|
|
224 |
};
|
|
225 |
|
|
226 |
#endif // CMMDTMFMESSHANDLER_H
|
|
227 |
|
|
228 |
// End of File
|