|
1 /* |
|
2 * Copyright (c) 2007-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 * Name : CSipRefreshBase.h |
|
16 * Part of : SIPRefreshes |
|
17 * Version : SIP/6.0 |
|
18 * |
|
19 */ |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 /** |
|
25 @internalComponent |
|
26 */ |
|
27 |
|
28 |
|
29 #ifndef CSIPREFRESHBASE_H |
|
30 #define CSIPREFRESHBASE_H |
|
31 |
|
32 #include <e32base.h> |
|
33 #include "SipStackServerDefs.h" |
|
34 #include "MTransactionOwner.h" |
|
35 #include "Lwtimer.h" |
|
36 #include "MSIPSecUser.h" |
|
37 #include "_sipcodecdefs.h" |
|
38 |
|
39 class MTransactionUser; |
|
40 class CSipRefreshMgr; |
|
41 class MRefreshOwner; |
|
42 class CSIPRequest; |
|
43 class CSIPResponse; |
|
44 class CURIContainer; |
|
45 class CSIPHeaderBase; |
|
46 class CSIPRouteHeader; |
|
47 class MTransactionHeaders; |
|
48 class CSIPSec; |
|
49 |
|
50 |
|
51 class CSipRefreshBase : public CBase, |
|
52 public MTransactionOwner, |
|
53 public MExpirationHandler, |
|
54 public MSIPSecUser |
|
55 { |
|
56 public: |
|
57 |
|
58 virtual ~CSipRefreshBase (); |
|
59 |
|
60 void ClearTransactionOwner (); |
|
61 |
|
62 MRefreshOwner* Owner(); |
|
63 |
|
64 const TRefreshId& Id () const; |
|
65 |
|
66 TTransactionId CurrentTransactionId() const; |
|
67 |
|
68 CSIPRequest* Request(); |
|
69 |
|
70 void SetIntervalL(TInt aInterval); |
|
71 |
|
72 TInt Interval() const; |
|
73 |
|
74 void SetRequest(CSIPRequest* aRequest, TBool aDeleteRequest); |
|
75 |
|
76 void SendL (TTransactionId& aTransactionId, |
|
77 CSIPRequest* aRequest); |
|
78 |
|
79 MTransactionHeaders* SendAndGetHeadersL (TTransactionId& aTransactionId, |
|
80 CSIPRequest* aRequest); |
|
81 |
|
82 void UpdateRemoteTargetL(CURIContainer& aRemoteTarget); |
|
83 |
|
84 void SetUpdatedHeader(CSIPHeaderBase* aHeader); |
|
85 |
|
86 void SetUpdatedRouteHeadersL(const RPointerArray<CSIPRouteHeader>& |
|
87 aHeaderArray); |
|
88 |
|
89 void RemoveRouteHeaders(); |
|
90 |
|
91 void UpdateRequestL (TTransactionId& aTransactionId, |
|
92 CSIPRequest* aRequest); |
|
93 |
|
94 void TerminateRequestL (TTransactionId& aTransactionId, |
|
95 CSIPRequest* aRequest); |
|
96 |
|
97 TUint IAPId () const; |
|
98 |
|
99 void ResetRegistrationId(); |
|
100 |
|
101 void UpdateCSeqValueL(CSIPRequest& aRequest); |
|
102 |
|
103 void StopTimer(); |
|
104 |
|
105 public: // From MTransactionOwner |
|
106 |
|
107 void ReceiveL(TUint32 aIapId, |
|
108 TTransactionId aTransactionId, |
|
109 CSIPRequest* aRequest); |
|
110 |
|
111 void ReceiveL(TTransactionId aTransactionId, |
|
112 CSIPResponse* aResponse); |
|
113 |
|
114 TInt TransactionEnded(TUint32 aIapId, |
|
115 TTransactionId aTransactionId, |
|
116 TInt aReason); |
|
117 |
|
118 TInt NextCSeq(TUint& aCSeq); |
|
119 |
|
120 virtual const MSIPSecUser* SIPSecUser() const; |
|
121 |
|
122 public: // From MExpirationHandler |
|
123 |
|
124 void TimerExpiredL (TTimerId aTimerId, TAny* aTimerParam); |
|
125 |
|
126 public: // From MSIPSecUser |
|
127 |
|
128 TBool PassOnlyRealmsToUser() const; |
|
129 |
|
130 void RequestCredentialsL(const TDesC8& aRealm); |
|
131 |
|
132 void RequestCredentialsL(CSIPResponse& aResponse, |
|
133 TTransactionId aTransactionId, |
|
134 TRefreshId aRefreshId); |
|
135 |
|
136 const MSIPSecUser* TrustedUser(TRegistrationId aRegistrationId); |
|
137 |
|
138 TBool ByPassSIPSec() const; |
|
139 |
|
140 protected: |
|
141 |
|
142 CSipRefreshBase (MTransactionUser& aTU, |
|
143 MTimerManager& aTimerMgr, |
|
144 CSIPSec& aSIPSec, |
|
145 CSipRefreshMgr& aRefreshMgr, |
|
146 TRegistrationId aRegistrationId, |
|
147 MRefreshOwner* aOwner, |
|
148 MSIPSecUser& aSIPSecUser); |
|
149 |
|
150 void BaseConstructL(CURIContainer& aRemoteTarget, |
|
151 CSIPRequest& aRequest); |
|
152 |
|
153 virtual void Forward2xxResponseToCallerL(CSIPResponse* aResponse) = 0; |
|
154 |
|
155 |
|
156 |
|
157 virtual void SetExpirationTimeToRequestL(CSIPRequest& aRequest, |
|
158 TUint aExpirationTimeInSeconds) = 0; |
|
159 |
|
160 virtual void SetExpirationTimeToResponseL(CSIPResponse& |
|
161 aResponse, |
|
162 TUint |
|
163 aExpirationTimeInSeconds) = 0; |
|
164 |
|
165 virtual void CheckUpdateRequestExpiresValueL(CSIPRequest& aRequest) = 0; |
|
166 |
|
167 virtual void CheckTerminateRequestExpiresValueL(CSIPRequest& aRequest) = 0; |
|
168 |
|
169 virtual TInt ExpirationTimeFromResponse(CSIPResponse& aResponse) = 0; |
|
170 |
|
171 virtual TInt ExpirationTimeFromRequestL(CSIPRequest& aRequest) = 0; |
|
172 |
|
173 void Received200ClassResponseL(CSIPResponse* aResponse); |
|
174 void ReceivedProvisonalResponseL(CSIPResponse* aResponse); |
|
175 void ReceivedErrorResponseL(CSIPResponse* aResponse); |
|
176 |
|
177 TInt ExpireTimeFromResponseExpiresHeader(CSIPResponse& aResponse); |
|
178 void SetExpireTimeToResponseExpiresHeaderL(CSIPResponse& |
|
179 aResponse, |
|
180 TUint |
|
181 aExpirationTimeInSeconds); |
|
182 |
|
183 void UpdateHeaderForL(CSIPRequest& aRequest); |
|
184 |
|
185 void UpdateRouteHeadersForL(CSIPRequest& aRequest); |
|
186 |
|
187 void RemoveRouteHeadersFor(CSIPRequest& aRequest); |
|
188 |
|
189 void SetToFromOriginalRequestL(CSIPRequest& aRequest); |
|
190 |
|
191 void SetFromFromOriginalRequestL(CSIPRequest& aRequest); |
|
192 |
|
193 void SetCallIdFromOriginalRequestL(CSIPRequest& aRequest); |
|
194 |
|
195 void SetCSeqFromOriginalRequestL(CSIPRequest& aRequest); |
|
196 |
|
197 void RefreshReceivedL(TTransactionId aTransactionId, |
|
198 CSIPResponse* aResponse); |
|
199 |
|
200 void CheckUpdateRequestMethodL(CSIPRequest& aRequest); |
|
201 |
|
202 void CheckUpdateRequestHeadersL(CSIPRequest& aRequest); |
|
203 |
|
204 private: |
|
205 |
|
206 void SendUpdateRequestL (TTransactionId& aTransactionId, |
|
207 CSIPRequest* aRequest); |
|
208 |
|
209 void StartTimerL(TInt aMilliSeconds); |
|
210 |
|
211 TInt CalculateInterval(TInt aValueInSeconds) const; |
|
212 |
|
213 TInt RefreshErrorOccured(TTransactionId aTransactionId, TInt aError); |
|
214 |
|
215 protected: // Data |
|
216 |
|
217 CSipRefreshMgr& iRefreshMgr; |
|
218 TRefreshId iRefreshId; |
|
219 CSIPRequest* iRequest; |
|
220 CURIContainer* iRemoteTarget; |
|
221 TTransactionId iCurrentTransactionId; |
|
222 TBool iFirstRequest; |
|
223 MSIPSecUser& iSIPSecUser; |
|
224 MRefreshOwner* iOwner; |
|
225 |
|
226 private: // Data |
|
227 |
|
228 MTransactionUser& iTU; |
|
229 MTimerManager& iTimerMgr; |
|
230 CSIPSec& iSIPSec; |
|
231 TBool iTransactionOwnerCleared; |
|
232 TInt iIntervalInMilliSeconds; |
|
233 TBool iIntervalUpdated; |
|
234 TRegistrationId iRegistrationId; |
|
235 TTimerId iTimerId; |
|
236 CSIPHeaderBase* iUpdatedHeader; |
|
237 RPointerArray<CSIPHeaderBase> iUpdatedRouteHeaders; |
|
238 TBool iOwnRequest; |
|
239 TBool iRemoveRouteHeaders; |
|
240 |
|
241 private: // For testing purposes |
|
242 |
|
243 UNIT_TEST(CSipRefreshMgrTest) |
|
244 UNIT_TEST(CSipRegisterRefreshTest) |
|
245 }; |
|
246 |
|
247 #endif // CSIPREFRESHBASE_H |
|
248 |
|
249 // End of File |