realtimenetprots/sipfw/SIP/TransactionUser/src/CTransactionUser.cpp
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Name          : CTransactionUser.cpp
       
    15 // Part of       : TransactionUser
       
    16 // Version       : SIP/6.0
       
    17 //
       
    18 
       
    19 
       
    20 
       
    21 #include "siperr.h"
       
    22 #include "SipAssert.h"
       
    23 #include "siprequest.h"
       
    24 #include "sipresponse.h"
       
    25 #include "sipsec.h"
       
    26 #include "sipstrings.h"
       
    27 #include "sipstrconsts.h"
       
    28 #include "TransactionMgr.h"
       
    29 
       
    30 #include "CTransactionUser.h"
       
    31 #include "CTransactionStore.h"
       
    32 #include "DeleteMgr.h"
       
    33 #include "NormalUAC.h"
       
    34 #include "InviteUAC.h"
       
    35 #include "CancelUAC.h"
       
    36 #include "NormalUAS.h"
       
    37 #include "InviteUAS.h"
       
    38 #include "CancelUAS.h"
       
    39 #include "NormalUACStates.h"
       
    40 #include "InviteUACStates.h"
       
    41 #include "CancelUACStates.h"
       
    42 #include "NormalUASStates.h"
       
    43 #include "InviteUASStates.h"
       
    44 #include "CancelUASStates.h"
       
    45 #include "UserAgentCreateParams.h"
       
    46 #include "TimerValueRetriever.h"
       
    47 #include "SIPMessageUtility.h"
       
    48 #include "MTransactionHeaders.h"
       
    49 
       
    50 using namespace CommsDat;
       
    51 
       
    52 // CSeq sequence number is a 32 bit integer, and must be less than 2**31
       
    53 const TUint32 KMaxCSeqValue = 0x7fffffff;
       
    54 
       
    55 
       
    56 // -----------------------------------------------------------------------------
       
    57 // CTransactionUser::NewL
       
    58 // -----------------------------------------------------------------------------
       
    59 //
       
    60 CTransactionUser* CTransactionUser::NewL(MSIPRequestRouter* aRouter,
       
    61 									     MTimerManager* aTimers,
       
    62 									     MConnectionStateObserver& aObserver)
       
    63 	{
       
    64 	__SIP_ASSERT_LEAVE(aRouter && aTimers, KErrArgument);
       
    65 
       
    66 	CTransactionUser* self = new (ELeave) CTransactionUser(aRouter,
       
    67                                                            aTimers,
       
    68                                                            aObserver);
       
    69 	CleanupStack::PushL(self);
       
    70 	self->ConstructL();
       
    71 	CleanupStack::Pop(self);
       
    72 	return self;
       
    73 	}
       
    74 
       
    75 // -----------------------------------------------------------------------------
       
    76 // CTransactionUser::CTransactionUser
       
    77 // -----------------------------------------------------------------------------
       
    78 //
       
    79 CTransactionUser::CTransactionUser(MSIPRequestRouter* aRouter,
       
    80 								   MTimerManager* aTimers,
       
    81                                    MConnectionStateObserver& aStateObserver) :
       
    82 	iRouter(aRouter),
       
    83 	iTimers(aTimers),
       
    84     iStateObserver(aStateObserver)
       
    85 	{
       
    86 	iCSeqCounter = User::TickCount() & KMaxCSeqValue;
       
    87 	}
       
    88 
       
    89 // -----------------------------------------------------------------------------
       
    90 // CTransactionUser::ConstructL
       
    91 // -----------------------------------------------------------------------------
       
    92 //
       
    93 void CTransactionUser::ConstructL()
       
    94 	{
       
    95 	__SIP_ASSERT_LEAVE(iTimers, KErrGeneral);
       
    96 
       
    97 	iTransactionStore = CTransactionStore::NewL();
       
    98 	iTimerValueRetriever = CTimerValueRetriever::NewL();
       
    99 	TUint t1 = iTimerValueRetriever->HighestT1();
       
   100     iConnectionMgr = CSipConnectionMgr::NewL(*iTransactionStore,
       
   101 											 *this,
       
   102 											 *iTimers,
       
   103 											 t1,
       
   104 			                                 *this);
       
   105 	iDeleteMgr = CDeleteMgr::NewL();
       
   106 	iSIPMsgUtility = new (ELeave) CSIPMessageUtility;
       
   107 
       
   108 	ConstructUaStateMachinesL();
       
   109 
       
   110 	iTransactionMgr = CTransactionMgr::NewL(*iTimers, *iTransactionStore);
       
   111 	iSIPSec = CSIPSec::NewL(*iTimers, *iConnectionMgr, t1);
       
   112     }
       
   113 
       
   114 // -----------------------------------------------------------------------------
       
   115 // CTransactionUser::ConstructUaStateMachinesL
       
   116 // -----------------------------------------------------------------------------
       
   117 //
       
   118 void CTransactionUser::ConstructUaStateMachinesL()
       
   119 	{
       
   120 	iInviteUAC_Start = new (ELeave) CInviteUAC_Start;
       
   121 	iInviteUAC_ResolveAddress = new (ELeave) CInviteUAC_ResolveAddress;
       
   122 	iInviteUAC_WaitResponse = new (ELeave) CInviteUAC_WaitResponse;
       
   123 	iInviteUAC_WaitAckFromApp = new (ELeave) CInviteUAC_WaitAckFromApp;
       
   124 	iInviteUAC_ResolveAckAddress = new (ELeave) CInviteUAC_ResolveAckAddress;
       
   125 	iInviteUAC_SendingAck = new (ELeave) CInviteUAC_SendingAck;
       
   126 	iInviteUAC_WaitTransactionToEnd =
       
   127 		new (ELeave) CInviteUAC_WaitTransactionToEnd;
       
   128 	iInviteUAC_WaitAuthentication = new (ELeave) CInviteUAC_WaitAuthentication;
       
   129 
       
   130 	iInviteUAC_Start->SetNeighbourStates(*iInviteUAC_ResolveAddress);
       
   131 	iInviteUAC_ResolveAddress->SetNeighbourStates(*iInviteUAC_WaitResponse);
       
   132 	iInviteUAC_WaitResponse->SetNeighbourStates(
       
   133 										*iInviteUAC_WaitAckFromApp,
       
   134 										*iInviteUAC_WaitTransactionToEnd,
       
   135 										*iInviteUAC_ResolveAddress,
       
   136 										*iInviteUAC_WaitAuthentication);
       
   137 	iInviteUAC_WaitAckFromApp->SetNeighbourStates(
       
   138 										*iInviteUAC_ResolveAckAddress);
       
   139 	iInviteUAC_ResolveAckAddress->SetNeighbourStates(*iInviteUAC_SendingAck);
       
   140 	iInviteUAC_SendingAck->SetNeighbourStates(*iInviteUAC_ResolveAckAddress);
       
   141 	iInviteUAC_WaitAuthentication->SetNeighbourStates(
       
   142 											*iInviteUAC_ResolveAddress,
       
   143 											*iInviteUAC_WaitResponse,
       
   144 											*iInviteUAC_WaitAckFromApp,
       
   145 											*iInviteUAC_WaitTransactionToEnd);
       
   146 
       
   147 
       
   148 	iNormalUAC_Start = new (ELeave) CNormalUAC_Start;
       
   149 	iNormalUAC_ResolveAddress = new (ELeave) CNormalUAC_ResolveAddress;
       
   150 	iNormalUAC_WaitResponse = new (ELeave) CNormalUAC_WaitResponse;
       
   151 	iNormalUAC_WaitAuthentication = new (ELeave) CNormalUAC_WaitAuthentication;
       
   152 
       
   153 	iNormalUAC_Start->SetNeighbourStates(*iNormalUAC_ResolveAddress);
       
   154 	iNormalUAC_ResolveAddress->SetNeighbourStates(*iNormalUAC_WaitResponse);
       
   155 	iNormalUAC_WaitResponse->SetNeighbourStates(*iNormalUAC_ResolveAddress,
       
   156 												*iNormalUAC_WaitAuthentication);
       
   157 	iNormalUAC_WaitAuthentication->SetNeighbourStates(
       
   158 										*iNormalUAC_ResolveAddress,
       
   159 										*iNormalUAC_WaitResponse);
       
   160 
       
   161 
       
   162 	iCancelUAC_Start = new (ELeave) CCancelUAC_Start;
       
   163 	// CancelUAC uses rest of NormalUAC's states
       
   164 	iCancelUAC_Start->SetNeighbourStates(*iNormalUAC_WaitResponse);
       
   165 
       
   166 
       
   167 	iInviteUAS_Start = new (ELeave) CInviteUAS_Start;
       
   168 	iInviteUAS_GetTxOwner = new (ELeave) CInviteUAS_GetTxOwner;
       
   169 	iInviteUAS_WaitRespFromApp = new (ELeave) CInviteUAS_WaitRespFromApp;
       
   170 	iInviteUAS_Accepted = new (ELeave) CInviteUAS_Accepted;
       
   171 	iInviteUAS_Rejected = new (ELeave) CInviteUAS_Rejected;	
       
   172 
       
   173 	iInviteUAS_Start->SetNeighbourStates(*iInviteUAS_GetTxOwner,
       
   174 										 *iInviteUAS_WaitRespFromApp,
       
   175 										 *iInviteUAS_Rejected);
       
   176 	iInviteUAS_GetTxOwner->SetNeighbourStates(*iInviteUAS_WaitRespFromApp,
       
   177 											  *iInviteUAS_Rejected);
       
   178 	iInviteUAS_WaitRespFromApp->SetNeighbourStates(*iInviteUAS_Accepted,
       
   179 												   *iInviteUAS_Rejected);
       
   180 
       
   181 
       
   182 	iNormalUAS_Start = new (ELeave) CNormalUAS_Start;
       
   183 	iNormalUAS_GetTxOwner = new (ELeave) CNormalUAS_GetTxOwner;
       
   184 	iNormalUAS_WaitRespFromApp = new (ELeave) CNormalUAS_WaitRespFromApp;
       
   185 	iNormalUAS_FinalRespSent = new (ELeave) CNormalUAS_FinalRespSent;
       
   186 
       
   187 	iNormalUAS_Start->SetNeighbourStates(*iNormalUAS_GetTxOwner,
       
   188  									     *iNormalUAS_WaitRespFromApp,
       
   189 										 *iNormalUAS_FinalRespSent);
       
   190 	iNormalUAS_GetTxOwner->SetNeighbourStates(*iNormalUAS_WaitRespFromApp,
       
   191 											  *iNormalUAS_FinalRespSent);
       
   192 	iNormalUAS_WaitRespFromApp->SetNeighbourStates(*iNormalUAS_FinalRespSent);
       
   193 
       
   194 
       
   195 	iCancelUAS_Start = new (ELeave) CCancelUAS_Start;
       
   196 	iCancelUAS_FinalRespSent = new (ELeave) CCancelUAS_FinalRespSent;
       
   197 
       
   198 	iCancelUAS_Start->SetNeighbourStates(*iCancelUAS_FinalRespSent);
       
   199 	}
       
   200 
       
   201 // -----------------------------------------------------------------------------
       
   202 // CTransactionUser::~CTransactionUser
       
   203 // Deleting iTransactionStore and iDeleteMgr can lead deleting CTransmitter
       
   204 // (cancels request to iConnectionMgr) and UAC (cancels request to SIPSec).
       
   205 // -----------------------------------------------------------------------------
       
   206 //
       
   207 CTransactionUser::~CTransactionUser()
       
   208 	{
       
   209 	delete iTransactionStore;
       
   210 	delete iDeleteMgr;
       
   211 	delete iTransactionMgr;
       
   212 	delete iTimerValueRetriever;
       
   213 	delete iConnectionMgr;
       
   214 	delete iSIPMsgUtility;
       
   215 	delete iSIPSec;
       
   216 
       
   217 	delete iInviteUAC_Start;
       
   218 	delete iInviteUAC_ResolveAddress;
       
   219 	delete iInviteUAC_WaitResponse;
       
   220 	delete iInviteUAC_WaitAckFromApp;
       
   221 	delete iInviteUAC_ResolveAckAddress;
       
   222 	delete iInviteUAC_SendingAck;
       
   223 	delete iInviteUAC_WaitTransactionToEnd;
       
   224 	delete iInviteUAC_WaitAuthentication;
       
   225 
       
   226 	delete iNormalUAC_Start;
       
   227 	delete iNormalUAC_ResolveAddress;
       
   228 	delete iNormalUAC_WaitResponse;
       
   229 	delete iNormalUAC_WaitAuthentication;
       
   230 
       
   231 	delete iCancelUAC_Start;
       
   232 
       
   233 	delete iInviteUAS_Start;
       
   234 	delete iInviteUAS_GetTxOwner;
       
   235 	delete iInviteUAS_WaitRespFromApp;
       
   236 	delete iInviteUAS_Accepted;
       
   237 	delete iInviteUAS_Rejected;	
       
   238 
       
   239 	delete iNormalUAS_Start;
       
   240 	delete iNormalUAS_GetTxOwner;
       
   241 	delete iNormalUAS_WaitRespFromApp;
       
   242 	delete iNormalUAS_FinalRespSent;
       
   243 
       
   244 	delete iCancelUAS_Start;
       
   245 	delete iCancelUAS_FinalRespSent;
       
   246 	}
       
   247 
       
   248 // -----------------------------------------------------------------------------
       
   249 // CTransactionUser::SIPSec
       
   250 // -----------------------------------------------------------------------------
       
   251 //
       
   252 CSIPSec& CTransactionUser::SIPSec()
       
   253 	{
       
   254 	return *iSIPSec;
       
   255 	}
       
   256 
       
   257 // -----------------------------------------------------------------------------
       
   258 // CTransactionUser::SipConnectionMgr
       
   259 // -----------------------------------------------------------------------------
       
   260 //
       
   261 CSipConnectionMgr& CTransactionUser::SipConnectionMgr()
       
   262 	{
       
   263 	return *iConnectionMgr;
       
   264 	}
       
   265 
       
   266 // -----------------------------------------------------------------------------
       
   267 // CTransactionUser::SetDialogs
       
   268 // No invariant as iDialogs/iRegistrations/iRegistrationContact aren't set yet.
       
   269 // -----------------------------------------------------------------------------
       
   270 //
       
   271 void CTransactionUser::SetDialogs(MSipDialogs* aDialogs)
       
   272 	{
       
   273 	__SIP_ASSERT_RETURN(aDialogs, KErrArgument);
       
   274 
       
   275 	iDialogs = aDialogs;
       
   276 	}
       
   277 
       
   278 // -----------------------------------------------------------------------------
       
   279 // CTransactionUser::SetRegistrations
       
   280 // No invariant as iDialogs/iRegistrations/iRegistrationContact aren't set yet.
       
   281 // -----------------------------------------------------------------------------
       
   282 //
       
   283 void CTransactionUser::SetRegistrations(
       
   284                                 MSipRegistrations* aRegistrations,
       
   285 								MSipRegistrationContact* aRegistrationContact)
       
   286 	{
       
   287 	__SIP_ASSERT_RETURN(aRegistrations && aRegistrationContact, KErrArgument);
       
   288 
       
   289 	iRegistrations = aRegistrations;
       
   290 	iRegistrationContact = aRegistrationContact;
       
   291 	}
       
   292 
       
   293 // -----------------------------------------------------------------------------
       
   294 // CTransactionUser::GetStateL
       
   295 // -----------------------------------------------------------------------------
       
   296 //
       
   297 void CTransactionUser::GetStateL(TTransactionId aTransactionId,
       
   298                             	 CSIPInternalStates::TState& aState) const
       
   299     {
       
   300     __TEST_INVARIANT;
       
   301 
       
   302     CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   303 	__ASSERT_ALWAYS(ua && ua->Transaction(), User::Leave(KErrNotFound));
       
   304     ua->Transaction()->GetState(aState);
       
   305     }
       
   306 
       
   307 // -----------------------------------------------------------------------------
       
   308 // CTransactionUser::NewCSeqValue
       
   309 // -----------------------------------------------------------------------------
       
   310 //
       
   311 TUint32 CTransactionUser::NewCSeqValue()
       
   312 	{
       
   313 	__TEST_INVARIANT;
       
   314 
       
   315 	if (iCSeqCounter >= KMaxCSeqValue)
       
   316 		{
       
   317 		iCSeqCounter = 0;
       
   318 		}
       
   319 
       
   320 	return ++iCSeqCounter;
       
   321 	}
       
   322 
       
   323 // -----------------------------------------------------------------------------
       
   324 // CTransactionUser::SendL
       
   325 // Send ACK using an existing INVITE-UAC.
       
   326 // -----------------------------------------------------------------------------
       
   327 //
       
   328 void CTransactionUser::SendL(TTransactionId& aTransactionId,
       
   329 							 TRegistrationId aRegistrationId,
       
   330 							 CSIPRequest* aRequest,
       
   331 							 MTransactionOwner* aObserver,
       
   332                              CURIContainer& aRemoteTarget,
       
   333                              const TSIPTransportParams& aTransportParams,
       
   334 							 TBool aDeleteRequest)
       
   335 	{
       
   336 	__TEST_INVARIANT;
       
   337 	__SIP_ASSERT_LEAVE(aRequest && aObserver, KErrArgument);
       
   338 	__SIP_MESSAGE_LOG("TransactionUser", *aRequest)
       
   339 
       
   340 	if (CSIPMessageUtility::IsAck(*aRequest))
       
   341 		{
       
   342 		CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   343 		__ASSERT_ALWAYS(ua && ua->IsInviteUAC(),
       
   344 					    User::Leave(KErrSIPInvalidTransactionState));
       
   345 		CInviteUAC::Ptr(*ua).SendAckL(aRequest,
       
   346 								*aObserver,
       
   347 								aTransportParams,
       
   348 								aRegistrationId,
       
   349 								aRemoteTarget,
       
   350 								aDeleteRequest,
       
   351 								SIPStrings::StringF(SipStrConsts::EEmpty));
       
   352 		}
       
   353 	else
       
   354 		{
       
   355 		CTransactionBase::TTransactionType type =
       
   356             CTransactionBase::KClientTransaction;
       
   357         if (aRequest->Method() == SIPStrings::StringF(SipStrConsts::EInvite))
       
   358 			{
       
   359 			type = CTransactionBase::KClientInviteTransaction;
       
   360 			}
       
   361 
       
   362 		aTransactionId = iTransactionStore->NewTransactionId();
       
   363 		CUserAgent* ua = CreateUacL(aTransactionId,
       
   364 									aRequest->Method(),
       
   365 									*aObserver,
       
   366 									aDeleteRequest,
       
   367 									NewCSeqValue(),
       
   368                                     aTransportParams);
       
   369         TCleanupItem cleanupItem(CUserAgent::CleanupSilently, ua);
       
   370         CleanupStack::PushL(cleanupItem);
       
   371 		iTransactionStore->AddL(aTransactionId, ua, NULL, NULL, type);
       
   372 		ua->SendRequestL(aRequest, aRegistrationId, aRemoteTarget);
       
   373 		CleanupStack::Pop(); // cleanupItem
       
   374 		}
       
   375 
       
   376 	__TEST_INVARIANT;
       
   377 	}
       
   378 
       
   379 // -----------------------------------------------------------------------------
       
   380 // CTransactionUser::SendAndGetHeadersL
       
   381 // -----------------------------------------------------------------------------
       
   382 //
       
   383 MTransactionHeaders*
       
   384 CTransactionUser::SendAndGetHeadersL(TTransactionId& aTransactionId,
       
   385 								 TRegistrationId aRegistrationId,
       
   386 								 CSIPRequest* aRequest,
       
   387 								 MTransactionOwner* aObserver,
       
   388                                  CURIContainer& aRemoteTarget,
       
   389                                  const TSIPTransportParams& aTransportParams,
       
   390 								 TBool aDeleteRequest)
       
   391 	{
       
   392 	__TEST_INVARIANT;
       
   393 	__SIP_ASSERT_LEAVE(aRequest && aObserver, KErrArgument);
       
   394 
       
   395 	SendL(aTransactionId,
       
   396 		  aRegistrationId,
       
   397 		  aRequest,
       
   398 		  aObserver,
       
   399 		  aRemoteTarget,
       
   400           aTransportParams,
       
   401 		  EFalse); // Don't take aRequest's ownership yet as leave can occur
       
   402 
       
   403 	CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   404 	__SIP_ASSERT_LEAVE(ua, KErrNotFound);
       
   405 
       
   406     TCleanupItem cleanupItem(CUserAgent::CleanupSilently, ua);
       
   407     CleanupStack::PushL(cleanupItem);
       
   408 	MTransactionHeaders* headers =
       
   409         iTransactionStore->TransactionHeadersL(aTransactionId);
       
   410 	CleanupStack::Pop(); // cleanupItem
       
   411 
       
   412 	static_cast<CUserAgentClient*>(ua)->SetRequestOwnership(aDeleteRequest);
       
   413 
       
   414 	__TEST_INVARIANT;
       
   415 	return headers;
       
   416 	}
       
   417 
       
   418 // -----------------------------------------------------------------------------
       
   419 // CTransactionUser::SendL
       
   420 // -----------------------------------------------------------------------------
       
   421 //
       
   422 void CTransactionUser::SendL(TTransactionId aTransactionId,
       
   423 							 CSIPResponse* aResp,
       
   424 							 const TSIPTransportParams& aTransportParams) const
       
   425 	{
       
   426 	__TEST_INVARIANT;
       
   427 
       
   428 	SendL(aTransactionId, aResp, NULL, aTransportParams);
       
   429 	}
       
   430 
       
   431 // -----------------------------------------------------------------------------
       
   432 // CTransactionUser::SendL
       
   433 // -----------------------------------------------------------------------------
       
   434 //
       
   435 void CTransactionUser::SendL(TTransactionId aTransactionId,
       
   436 							 CSIPResponse* aResp,
       
   437 							 MTransactionOwner* aNewObserver,
       
   438 							 const TSIPTransportParams& aTransportParams) const
       
   439 	{
       
   440 	__TEST_INVARIANT;
       
   441 	__SIP_ASSERT_LEAVE(aTransactionId != KEmptyTransactionId, KErrArgument);
       
   442 	__SIP_ASSERT_LEAVE(aResp, KErrArgument);
       
   443 	__SIP_MESSAGE_LOG("TransactionUser", *aResp)
       
   444 
       
   445 	CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   446 	__ASSERT_ALWAYS(ua && ua->IsUAS(),
       
   447 					User::Leave(KErrSIPInvalidTransactionState));
       
   448 	if (aNewObserver)
       
   449 		{
       
   450 		ua->UpdateTransactionOwner(aNewObserver);
       
   451 		}
       
   452 
       
   453 	ua->SendResponseL(aResp, aTransportParams);
       
   454 	}
       
   455 
       
   456 // -----------------------------------------------------------------------------
       
   457 // CTransactionUser::SendCancelL
       
   458 // CANCEL uses INVITE's TransportParams.
       
   459 // -----------------------------------------------------------------------------
       
   460 //
       
   461 void CTransactionUser::SendCancelL(TTransactionId aInviteTaId,
       
   462 								   TTransactionId& aCancelTaId,
       
   463 								   MTransactionOwner* aObserver)
       
   464 	{
       
   465 	__TEST_INVARIANT;
       
   466 	__SIP_ASSERT_LEAVE(aObserver, KErrArgument);
       
   467 
       
   468 	CUserAgent* ua = iTransactionStore->SearchById(aInviteTaId);
       
   469 	__ASSERT_ALWAYS(ua &&
       
   470 					ua->Transaction() &&
       
   471 					iTransactionMgr->IsPossibleToSendCancel(*ua->Transaction()),
       
   472 					User::Leave(KErrSIPInvalidTransactionState));
       
   473     aCancelTaId = iTransactionStore->NewTransactionId();
       
   474 	CCancelUAC* cancelUa = CreateCancelUacL(aCancelTaId,
       
   475 									        *aObserver,
       
   476                                             NewCSeqValue(),
       
   477                                             ua->TransportParams());
       
   478     TCleanupItem cleanupItem(CUserAgent::CleanupSilently, cancelUa);
       
   479     CleanupStack::PushL(cleanupItem);
       
   480 	iTransactionStore->AddL(aCancelTaId,
       
   481                             cancelUa,
       
   482                             NULL,
       
   483                             NULL,
       
   484 							CTransactionBase::KClientTransaction);
       
   485 	cancelUa->SendCancelL(aInviteTaId);
       
   486 	CleanupStack::Pop(); // cleanupItem
       
   487 
       
   488 	__TEST_INVARIANT;
       
   489 	}
       
   490 
       
   491 // -----------------------------------------------------------------------------
       
   492 // CTransactionUser::ClearTransactionOwner
       
   493 // -----------------------------------------------------------------------------
       
   494 //
       
   495 TInt
       
   496 CTransactionUser::ClearTransactionOwner(TTransactionId aTransactionId) const
       
   497 	{
       
   498 	__TEST_INVARIANT;
       
   499 	__SIP_ASSERT_RETURN_VALUE(aTransactionId != KEmptyTransactionId,
       
   500                               KErrArgument);
       
   501 	CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   502 	if (ua)
       
   503 		{
       
   504 		ua->ClearTransactionOwner();
       
   505 		return KErrNone;
       
   506 		}
       
   507 
       
   508 	return KErrNotFound;
       
   509 	}
       
   510 
       
   511 // -----------------------------------------------------------------------------
       
   512 // CTransactionUser::ClearTransactionOwner
       
   513 // -----------------------------------------------------------------------------
       
   514 //
       
   515 TInt CTransactionUser::ClearTransactionOwner(MTransactionOwner* aObserver) const
       
   516 	{
       
   517 	__TEST_INVARIANT;
       
   518 	__SIP_ASSERT_RETURN_VALUE(aObserver, KErrArgument);
       
   519 
       
   520 	return iTransactionStore->ClearTransactionOwner(aObserver);
       
   521 	}
       
   522 
       
   523 // -----------------------------------------------------------------------------
       
   524 // CTransactionUser::TransactionHeadersL
       
   525 // -----------------------------------------------------------------------------
       
   526 //
       
   527 MTransactionHeaders*
       
   528 CTransactionUser::TransactionHeadersL(TTransactionId aTransactionId) const
       
   529 	{
       
   530 	__TEST_INVARIANT;
       
   531 	__SIP_ASSERT_LEAVE(aTransactionId != KEmptyTransactionId, KErrArgument);
       
   532 
       
   533 	return iTransactionStore->TransactionHeadersL(aTransactionId);
       
   534 	}
       
   535 
       
   536 // -----------------------------------------------------------------------------
       
   537 // CTransactionUser::MakeTagL
       
   538 // -----------------------------------------------------------------------------
       
   539 //
       
   540 void CTransactionUser::MakeTagL(TDes8& aTag) const
       
   541 	{
       
   542 	__TEST_INVARIANT;
       
   543 	__ASSERT_ALWAYS(aTag.Length() != aTag.MaxLength(),
       
   544 					User::Leave(KErrArgument));
       
   545 	TTransactionId taId = KEmptyTransactionId;
       
   546 	CUserAgent* ua = NULL;
       
   547     CSIPMessage* message = NULL;
       
   548 	iTransactionStore->RandomTaInfoL(taId, &ua, &message);
       
   549 
       
   550 	CleanupStack::PushL(message);
       
   551 	iSIPMsgUtility->AddRandomStringL(aTag,
       
   552 									 aTag.MaxLength() - aTag.Length(),
       
   553 									 EFalse,
       
   554 									 message,
       
   555 									 taId,
       
   556 									 ua);
       
   557 	CleanupStack::PopAndDestroy(message);
       
   558 	}
       
   559 
       
   560 // -----------------------------------------------------------------------------
       
   561 // CTransactionUser::NewTransactionL
       
   562 // -----------------------------------------------------------------------------
       
   563 //
       
   564 MReceiverObserver*
       
   565 CTransactionUser::NewTransactionL(CSIPRequest& aRequest,
       
   566                                   const TSIPTransportParams& aParams,
       
   567 								  TTransactionId& aTransactionId)
       
   568 	{
       
   569 	__TEST_INVARIANT;	
       
   570 
       
   571 	if (CSIPMessageUtility::IsAck(aRequest) ||
       
   572 		!iTransactionStore->AllowMoreServerTransactions())
       
   573 		{
       
   574 		return NULL;
       
   575 		}
       
   576 
       
   577 	aTransactionId = iTransactionStore->NewTransactionId();
       
   578 	CUserAgent* ua = CreateUasL(aTransactionId, aRequest.Method(), aParams);
       
   579 	MReceiverObserver* receiver = ua->Transaction();
       
   580 
       
   581 	CleanupStack::PushL(ua);
       
   582 	iTransactionStore->AddL(aTransactionId,
       
   583 			        ua,
       
   584 			        ua->Transaction(),
       
   585                     &aRequest,
       
   586                     CSIPMessageUtility::TransactionType(aRequest, ETrue));
       
   587 	CleanupStack::Pop(ua);
       
   588 
       
   589 	__TEST_INVARIANT;
       
   590 	return receiver;
       
   591 	}
       
   592 
       
   593 // -----------------------------------------------------------------------------
       
   594 // CTransactionUser::FillUserAgentParamsLC
       
   595 // -----------------------------------------------------------------------------
       
   596 //
       
   597 CUserAgentCreateParams*
       
   598 CTransactionUser::FillUserAgentParamsLC(TTransactionId aTransactionId,
       
   599 									MTransactionOwner* aObserver,
       
   600 									TBool aDeleteOutgoingMsg,
       
   601 		                            const TSIPTransportParams& aParams) const
       
   602 	{
       
   603 	__TEST_INVARIANT;
       
   604 	CTimerValueRetriever::BearerType bearerType = 
       
   605 		(CTimerValueRetriever::BearerType)TimerRetrieverMappedBearerTypeL(aParams.IapId());
       
   606 	CUserAgentCreateParams* uaParams =
       
   607 		CUserAgentCreateParams::NewLC(*iTransactionMgr,
       
   608                                       *iTimers,
       
   609 									  *iSIPMsgUtility,
       
   610 									  iTimerValueRetriever->TimerValues(bearerType),
       
   611 									  *iRegistrations,
       
   612                                       *iRegistrationContact,
       
   613                                       *iConnectionMgr,
       
   614                                       *iTransactionStore,
       
   615                                       *iDeleteMgr,
       
   616 									  aDeleteOutgoingMsg,
       
   617                                       aParams);
       
   618 	uaParams->iTransactionId = aTransactionId;
       
   619 	uaParams->iObserver = aObserver;
       
   620 
       
   621 	return uaParams;
       
   622 	}
       
   623 
       
   624 // -----------------------------------------------------------------------------
       
   625 // CTransactionUser::CreateUasL
       
   626 // -----------------------------------------------------------------------------
       
   627 //
       
   628 CUserAgent* CTransactionUser::CreateUasL(TTransactionId aTaId,
       
   629 									 RStringF aMethod,
       
   630 		                             const TSIPTransportParams& aParams) const
       
   631 	{
       
   632 	__TEST_INVARIANT;
       
   633 
       
   634 	CUserAgent* ua = NULL;
       
   635 	CUserAgentCreateParams* uaParams =
       
   636         FillUserAgentParamsLC(aTaId,
       
   637 							  NULL,  // Observer not yet known
       
   638 							  ETrue, // UAS sends responses
       
   639                               aParams);
       
   640 	if (aMethod == SIPStrings::StringF(SipStrConsts::EInvite))
       
   641 		{
       
   642 		uaParams->iInitialUaState = iInviteUAS_Start;
       
   643 		ua = CInviteUAS::NewL(*uaParams, *iConnectionMgr, *iRouter, *iDialogs);
       
   644 		}
       
   645 	else
       
   646 		{
       
   647 		if (aMethod == SIPStrings::StringF(SipStrConsts::ECancel))
       
   648 			{
       
   649 			uaParams->iInitialUaState = iCancelUAS_Start;
       
   650 			ua = CCancelUAS::NewL(*uaParams,
       
   651 								  *iConnectionMgr,
       
   652 								  *iRouter,
       
   653 								  *iDialogs);
       
   654 			}
       
   655 		else
       
   656 			{
       
   657 			uaParams->iInitialUaState = iNormalUAS_Start;
       
   658 			ua = CNormalUAS::NewL(*uaParams,
       
   659 								  *iConnectionMgr,
       
   660 								  *iRouter,
       
   661                                   *iDialogs);
       
   662 			}
       
   663 		}
       
   664 	CleanupStack::PopAndDestroy(uaParams);
       
   665 	return ua;
       
   666 	}
       
   667 
       
   668 // -----------------------------------------------------------------------------
       
   669 // CTransactionUser::CreateUacL
       
   670 // -----------------------------------------------------------------------------
       
   671 //
       
   672 CUserAgent* CTransactionUser::CreateUacL(TTransactionId aTaId,
       
   673 									 RStringF aMethod,
       
   674 									 MTransactionOwner& aObserver,
       
   675 									 TBool aDeleteRequest,
       
   676 									 TUint32 aCSeqNumber,
       
   677 		                             const TSIPTransportParams& aParams) const
       
   678 	{
       
   679 	__TEST_INVARIANT;	
       
   680 
       
   681 	CUserAgent* ua = NULL;
       
   682 	CUserAgentCreateParams* uaParams = FillUserAgentParamsLC(aTaId,
       
   683 															 &aObserver,
       
   684 															 aDeleteRequest,
       
   685                                                              aParams);
       
   686 	if (aMethod == SIPStrings::StringF(SipStrConsts::EInvite))
       
   687 		{
       
   688 		uaParams->iInitialUaState = iInviteUAC_Start;
       
   689 		ua = CInviteUAC::NewL(*uaParams,
       
   690 							  *iConnectionMgr,
       
   691                               *iConnectionMgr,
       
   692 							  *iSIPSec,
       
   693 							  aCSeqNumber,							  
       
   694 							  CSIPMessageUtility::IsPrivateAddressL(
       
   695 							  	*iConnectionMgr, aParams.IapId()),
       
   696 							  iInviteUAC_WaitAckFromApp);
       
   697 		}
       
   698 	else
       
   699 		{
       
   700 		uaParams->iInitialUaState = iNormalUAC_Start;
       
   701 		ua = CNormalUAC::NewL(*uaParams,
       
   702 							  *iConnectionMgr,
       
   703                               *iConnectionMgr,
       
   704 							  *iSIPSec,
       
   705 							  aCSeqNumber);
       
   706 		}
       
   707 
       
   708 	CleanupStack::PopAndDestroy(uaParams);
       
   709 	return ua;
       
   710 	}
       
   711 
       
   712 // -----------------------------------------------------------------------------
       
   713 // CTransactionUser::CreateCancelUacL
       
   714 // -----------------------------------------------------------------------------
       
   715 //
       
   716 CCancelUAC* CTransactionUser::CreateCancelUacL(TTransactionId aTaId,
       
   717 						           MTransactionOwner& aObserver,
       
   718 		                           TUint32 aCSeqNumber,
       
   719 		                           const TSIPTransportParams& aParams) const
       
   720 	{
       
   721 	__TEST_INVARIANT;	
       
   722 
       
   723 	CUserAgentCreateParams* uaParams = FillUserAgentParamsLC(aTaId,
       
   724 									                         &aObserver,
       
   725 									                         ETrue,
       
   726                                                              aParams);
       
   727     uaParams->iInitialUaState = iCancelUAC_Start;
       
   728 
       
   729 	CCancelUAC* ua = CCancelUAC::NewL(*uaParams,
       
   730 									  *iConnectionMgr,
       
   731                                       *iConnectionMgr,
       
   732 									  *iSIPSec,
       
   733 									  aCSeqNumber);
       
   734     CleanupStack::PopAndDestroy(uaParams);
       
   735     return ua;
       
   736 	}
       
   737 
       
   738 // -----------------------------------------------------------------------------
       
   739 // CTransactionUser::GetLocalAddress
       
   740 // No invariant as iDialogs/iRegistrations/iRegistrationContact aren't set yet.
       
   741 // -----------------------------------------------------------------------------
       
   742 //
       
   743 void CTransactionUser::GetLocalAddress(TUint32 aIapId, TInetAddr& aAddr) const
       
   744     {
       
   745     __SIP_ASSERT_RETURN(iConnectionMgr, KErrGeneral);
       
   746 
       
   747     iConnectionMgr->GetLocalAddress(aIapId, aAddr);
       
   748     }
       
   749 
       
   750 // -----------------------------------------------------------------------------
       
   751 // CTransactionUser::FreeResources
       
   752 // No invariant as iDialogs/iRegistrations/iRegistrationContact aren't set yet.
       
   753 // -----------------------------------------------------------------------------
       
   754 //
       
   755 void
       
   756 CTransactionUser::FreeResources(MSIPNATBindingObserver& aSIPNATBindingObserver)
       
   757 	{
       
   758     __SIP_ASSERT_RETURN(iConnectionMgr, KErrGeneral);
       
   759 
       
   760     iConnectionMgr->FreeResources(aSIPNATBindingObserver);
       
   761 	}
       
   762 
       
   763 // -----------------------------------------------------------------------------
       
   764 // CTransactionUser::ConnectionStateChangedL
       
   765 // EInit/EActive: no action. If application opens an IAP that has been opened by
       
   766 // another application, ConnectionMgr passes connection's current state.
       
   767 // No invariant as iDialogs/iRegistrations/iRegistrationContact aren't set yet.
       
   768 // -----------------------------------------------------------------------------
       
   769 //
       
   770 void CTransactionUser::ConnectionStateChangedL(TUint32 aIapId,
       
   771                                                CSIPConnection::TState aState)
       
   772 	{
       
   773     __SIP_ASSERT_LEAVE(iTransactionStore, KErrGeneral);
       
   774 
       
   775 	iStateObserver.ConnectionStateChangedL(aIapId, aState);
       
   776 
       
   777 	switch (aState)
       
   778 		{
       
   779 		case CSIPConnection::ESuspended:
       
   780 	        iTransactionStore->EndResolvingTransactions(aIapId,
       
   781 	                                                KErrSIPTransportFailure);
       
   782 			break;
       
   783 
       
   784 		case CSIPConnection::EInactive:
       
   785 	    case CSIPConnection::EUnavailable:
       
   786 	        iTransactionStore->RemoveItemsByIapId(aIapId);
       
   787 			break;
       
   788 
       
   789 		default:
       
   790 	        break;
       
   791 		}
       
   792 	}
       
   793 
       
   794 // -----------------------------------------------------------------------------
       
   795 // CTransactionUser::TimerRetrieverMappedBearerType
       
   796 // -----------------------------------------------------------------------------
       
   797 //
       
   798 TInt CTransactionUser::TimerRetrieverMappedBearerTypeL(TUint32 aIapID) const
       
   799 {
       
   800 	CTimerValueRetriever::BearerType mappedBearerType(CTimerValueRetriever::EModemBearer);
       
   801 
       
   802 	if (aIapID)
       
   803 	{
       
   804 	   	CMDBSession* cdb = CMDBSession::NewLC( KCDVersion1_1 ); 
       
   805 	    
       
   806 	   	cdb->SetAttributeMask( ECDHidden );
       
   807 	    
       
   808 		// Create an iap record
       
   809 		CCDIAPRecord* iapRecord = static_cast<CCDIAPRecord*>( 
       
   810 	            CCDRecordBase::RecordFactoryL( KCDTIdIAPRecord ) );
       
   811 		CleanupStack::PushL( iapRecord );
       
   812 	    
       
   813 		iapRecord->SetRecordId( aIapID );
       
   814 
       
   815 		iapRecord->LoadL( *cdb );
       
   816 
       
   817 		if (!iapRecord->iBearerType.IsNull())
       
   818 		{
       
   819 	       		TPtrC bearerType(iapRecord->iBearerType);
       
   820 			if(bearerType.CompareF(TPtrC(KCDTypeNameLANBearer)) == 0)
       
   821 				mappedBearerType = CTimerValueRetriever::ELanBearer;
       
   822 	   	}
       
   823 		
       
   824 	
       
   825 		CleanupStack::PopAndDestroy( iapRecord );
       
   826 		CleanupStack::PopAndDestroy( cdb );
       
   827 	}
       
   828 
       
   829 	return mappedBearerType;
       
   830 }
       
   831 
       
   832 // -----------------------------------------------------------------------------
       
   833 // CTransactionUser::NextHopIP
       
   834 // -----------------------------------------------------------------------------
       
   835 //
       
   836 TInt CTransactionUser::NextHopIP(
       
   837 		const TTransactionId& aTransactionId, TInetAddr& aAddr )
       
   838     {
       
   839     TInt error = KErrNone;
       
   840 
       
   841     CUserAgent* ua = iTransactionStore->SearchById(aTransactionId);
       
   842     if (!ua || ua->IsUAS())
       
   843         {
       
   844         error = CSIPClient::ENonExistingRequestId;
       
   845         }
       
   846     else
       
   847         {
       
   848     	aAddr = static_cast<CUserAgentClient*>(ua)->NextHopIP();
       
   849         }
       
   850     
       
   851     return error;
       
   852     
       
   853     }
       
   854 
       
   855 // -----------------------------------------------------------------------------
       
   856 // CTransactionUser::__DbgTestInvariant
       
   857 // -----------------------------------------------------------------------------
       
   858 //
       
   859 
       
   860 void CTransactionUser::__DbgTestInvariant() const
       
   861 	{
       
   862 	if (!iRouter ||
       
   863 		!iTimers ||
       
   864 		!iTransactionStore ||
       
   865 		!iConnectionMgr ||
       
   866 		!iDialogs ||
       
   867 		!iRegistrations ||
       
   868 		!iRegistrationContact ||
       
   869 		!iDeleteMgr ||
       
   870 		!iTimerValueRetriever ||		
       
   871         iCSeqCounter > KMaxCSeqValue)
       
   872 		{
       
   873 		User::Invariant();
       
   874 		}
       
   875 	}