|
1 /* |
|
2 * Copyright (c) 2005 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 #ifndef CMCENATSIPSESSION_H |
|
21 #define CMCENATSIPSESSION_H |
|
22 |
|
23 #include "nspsessionobserver.h" |
|
24 #include "mcenatactions.h" |
|
25 #include "mcenatevents.h" |
|
26 #include "mcesrv.h" |
|
27 #include "mcesipsession.h" |
|
28 #include <e32base.h> |
|
29 |
|
30 // FORWARD DECLARATION |
|
31 class CMceNatSipStateMachine; |
|
32 class CMceComSession; |
|
33 class CDesC8Array; |
|
34 class TMceNatStateTransitionEvent; |
|
35 class CSIPProfile; |
|
36 |
|
37 /** |
|
38 * This class represents NAT SIP session |
|
39 * |
|
40 * Class provides methods to handle SIP session |
|
41 * specifig ITC functions and to receive SIP requests and |
|
42 * responses. |
|
43 |
|
44 * @lib |
|
45 * @since |
|
46 */ |
|
47 class CMceNatSipSession : public CMceSipSession, |
|
48 public MNSPSessionObserver, |
|
49 public MMceNatActions |
|
50 { |
|
51 public: // Enumerations |
|
52 |
|
53 /* Nat session entry point */ |
|
54 enum TMceNatEntryPoint |
|
55 { |
|
56 ENatEntryNone, |
|
57 ENatEntryUpdated, |
|
58 ENatEntryHandleSIPEvent |
|
59 }; |
|
60 |
|
61 public: // Constructors and destructor |
|
62 |
|
63 /** |
|
64 * Two-phased constructor. |
|
65 * @param aClientSession client |
|
66 * @param aSIPConnection SIP connection |
|
67 * @param aStateMachine SIP session state machine |
|
68 * @param aParams session parameters, ownership is not transferred |
|
69 * @return SIP session |
|
70 */ |
|
71 static CMceNatSipSession* NewL( CMceCsSession& aClientSession, |
|
72 CMceSipConnection& aSIPConnection, |
|
73 CMceSipStateMachine& aStateMachine, |
|
74 CSIPProfile& aProfile, |
|
75 const CDesC8Array* aParams = NULL ); |
|
76 |
|
77 /** |
|
78 * Two-phased constructor. |
|
79 * @param aClientSession client |
|
80 * @param aSIPConnection SIP connection |
|
81 * @param aStateMachine SIP session state machine |
|
82 * @param aParams session parameters, ownership is not transferred |
|
83 * @return SIP session |
|
84 */ |
|
85 static CMceNatSipSession* NewLC( CMceCsSession& aClientSession, |
|
86 CMceSipConnection& aSIPConnection, |
|
87 CMceSipStateMachine& aStateMachine, |
|
88 CSIPProfile& aProfile, |
|
89 const CDesC8Array* aParams = NULL ); |
|
90 |
|
91 |
|
92 /** |
|
93 * Two-phased constructor. |
|
94 * @param aClientSession client |
|
95 * @param aSIPConnection SIP connection |
|
96 * @param aStateMachine SIP session state machine |
|
97 * @param aParams session parameters, ownership is not transferred |
|
98 * @return SIP session |
|
99 */ |
|
100 static CMceNatSipSession* NewL( CMceCsSession& aClientSession, |
|
101 CMceSipConnection& aSIPConnection, |
|
102 CMceSipStateMachine& aStateMachine, |
|
103 const CDesC8Array* aParams = NULL ); |
|
104 |
|
105 /** |
|
106 * Two-phased constructor. |
|
107 * @param aClientSession client |
|
108 * @param aSIPConnection SIP connection |
|
109 * @param aStateMachine SIP session state machine |
|
110 * @param aParams session parameters, ownership is not transferred |
|
111 * @return SIP session |
|
112 */ |
|
113 static CMceNatSipSession* NewLC( CMceCsSession& aClientSession, |
|
114 CMceSipConnection& aSIPConnection, |
|
115 CMceSipStateMachine& aStateMachine, |
|
116 const CDesC8Array* aParams = NULL ); |
|
117 |
|
118 /** |
|
119 * Destructor. |
|
120 */ |
|
121 ~CMceNatSipSession(); |
|
122 |
|
123 |
|
124 public: // from CMceSipSession |
|
125 |
|
126 /** |
|
127 * Updates media |
|
128 * @return return status: |
|
129 * -System error < 0: error situation |
|
130 * -KMceReady: update was synchronous |
|
131 * -KMceAsync: updating asynchronously |
|
132 */ |
|
133 TMceReturnStatus UpdateMediaL(); |
|
134 |
|
135 /** |
|
136 * Callback function to indicate MCC session is updated. |
|
137 * |
|
138 * @param aSession session body |
|
139 */ |
|
140 void Updated( CMceComSession& aSession ); |
|
141 |
|
142 CSdpDocument* Offer(); |
|
143 |
|
144 TBool NatSession() const; |
|
145 |
|
146 TInt NatState() const; |
|
147 |
|
148 TBool IsNatDisabled() const; |
|
149 |
|
150 /** |
|
151 * Method used to check Resource Reservation Status |
|
152 * |
|
153 * @return status TMceReturnStatus |
|
154 * -KMceAsync (Reservation in-progress) |
|
155 * -KMceReady (Resource Reserved) |
|
156 */ |
|
157 TMceReturnStatus ReserveL(); |
|
158 |
|
159 |
|
160 public: // from MNSPSessionObserver |
|
161 |
|
162 /** |
|
163 * see base class |
|
164 */ |
|
165 void Initialized( TUint aSessionId ); |
|
166 |
|
167 /** |
|
168 * see base class |
|
169 */ |
|
170 void OfferReady( TUint aSessionId, CSdpDocument* aOffer ); |
|
171 |
|
172 /** |
|
173 * see base class |
|
174 */ |
|
175 void AnswerReady( TUint aSessionId, CSdpDocument* aAnswer ); |
|
176 |
|
177 /** |
|
178 * see base class |
|
179 */ |
|
180 void UpdateSdp( TUint aSessionId, CSdpDocument* aOffer ); |
|
181 |
|
182 /** |
|
183 * see base class |
|
184 */ |
|
185 void ErrorOccurred( TUint aSessionId, TInt aError ); |
|
186 |
|
187 |
|
188 /** |
|
189 * see base class |
|
190 */ |
|
191 void IcmpErrorOccurred( TUint aSessionId, TInt aError ); |
|
192 |
|
193 |
|
194 |
|
195 public: // from MMceNatActions |
|
196 |
|
197 /** |
|
198 * see base class |
|
199 */ |
|
200 TInt CreateOfferL(); |
|
201 |
|
202 /** |
|
203 * see base class |
|
204 */ |
|
205 TInt ResolveL(); |
|
206 |
|
207 /** |
|
208 * see base class |
|
209 */ |
|
210 TInt DecodeAnswerL(); |
|
211 |
|
212 /** |
|
213 * see base class |
|
214 */ |
|
215 void UpdateL(); |
|
216 |
|
217 /** |
|
218 * see base class |
|
219 */ |
|
220 void UpdateRemoteAddressL(); |
|
221 |
|
222 /** |
|
223 * see base class |
|
224 */ |
|
225 void SetOffered( TMceNatOfferedSdp aOffered ); |
|
226 |
|
227 /** |
|
228 * see base class |
|
229 */ |
|
230 void SdpCleanup( CSdpDocument* aPrev, CSdpDocument* aRep ); |
|
231 |
|
232 /** |
|
233 * see base class |
|
234 */ |
|
235 void Continue(); |
|
236 |
|
237 /** |
|
238 * see base class |
|
239 */ |
|
240 void StateChangedL( TMceNatStateTransitionEvent& aEvent, |
|
241 TUint aNewState ); |
|
242 |
|
243 void SetNeedtoReceive(); |
|
244 |
|
245 /** |
|
246 * Get Resource Reservation Status |
|
247 */ |
|
248 TInt GetResourceReservationStatus(); |
|
249 |
|
250 TMceReturnStatus GetReservationStatus(); |
|
251 |
|
252 void SetReservationStatus(TMceReturnStatus aStatus); |
|
253 |
|
254 void ResumeNatUpdated(); |
|
255 |
|
256 private: // Constructors |
|
257 |
|
258 CMceNatSipSession( CMceCsSession& aClientSession, |
|
259 CMceSipConnection& aSIPConnection, |
|
260 CMceSipStateMachine& aStateMachine, |
|
261 CSIPProfile& aProfile ); |
|
262 |
|
263 CMceNatSipSession( CMceCsSession& aClientSession, |
|
264 CMceSipConnection& aSIPConnection, |
|
265 CMceSipStateMachine& aStateMachine ); |
|
266 |
|
267 void ConstructL( CMceCsSession& aClientSession, |
|
268 CMceSipConnection& aSIPConnection, |
|
269 const CDesC8Array* aParams ); |
|
270 |
|
271 void TryNatSessionL( CMceSipConnection& aSIPConnection, |
|
272 const CDesC8Array* aParams ); |
|
273 |
|
274 |
|
275 private: // from CMceSipSession |
|
276 |
|
277 void HandleSIPEvent( TMceSipEventCode aEventCode, CSIPDialog& aDialog ); |
|
278 |
|
279 |
|
280 private: // New functions |
|
281 |
|
282 void SafeDelete( CSdpDocument* aDocument ); |
|
283 |
|
284 void NatErrorOccurred( TInt aError ); |
|
285 |
|
286 void PrepareNatSessionUpdate(); |
|
287 |
|
288 void SetMediaQosL(); |
|
289 |
|
290 private: // Own Data |
|
291 |
|
292 TMceReturnStatus iReserveStatus; |
|
293 |
|
294 // Entry point from base class, stored for later use. |
|
295 TMceNatEntryPoint iEntryPoint; |
|
296 |
|
297 // Sip event code stored here for later use. |
|
298 TMceSipEventCode iSipEvent; |
|
299 |
|
300 // Session identifier from NAT FW |
|
301 TUint iSessionId; |
|
302 |
|
303 // Flag indicating which Sdp document is valid. |
|
304 TUint iOfferedSdp; |
|
305 |
|
306 // Flag indicating local failure in NAT FW |
|
307 TBool iNatDisabled; |
|
308 |
|
309 // NAT state machine, own. |
|
310 CMceNatSipStateMachine* iNatStateMachine; |
|
311 |
|
312 MCESRV_UT_DEFINITIONS |
|
313 |
|
314 }; |
|
315 |
|
316 #endif // CMCENATSIPSESSION_H |
|
317 |
|
318 // End of File |