realtimenetprots/sipfw/SIP/TransactionUser/src/NormalUASStates.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 0 307788aac0a8
permissions -rw-r--r--
This release addresses the following issues: 1. The crash bug fix when receiving file 2. Now the sending is based on MSRP messages, there is no longer file receiving or sending. Client sends data as MSRP was designed. 3. Soma MSRP stack was created so that the client told the correct session-id, Symbian stack generated it by itself. This is not allowed, it was changed so that clients tell the session-id (same as used in SIP INVITE). 4. Unnecessary division of data to chunks removed when there is no need to interrupt sending. The message is sent in as few chunks as possible. 5. Stack can now receive files and chunks with ?unlimited? size. Old stack wrote the incoming data to memory and did not utilize disk space until the end of chunk was reached (large chunks from another client crashed it). 6. Now when writing the incoming data to file, it will take into account the byte-range header values. So, this complies with the RFC4975 requirements that stack must be able to handle chunks that come in any sequence. 7. Some buffering changes to outgoing/incoming data. 8. The outgoing data is now checked that it does not contain the created transaction-id before sending the data. 9. MSRP success reports are now implemented and tested against servers. 10. Progress report system fixed so progress is now visible on client (all the way to 100%). 11. Message Cancel receiving / Cancel sending now corrected and made to work as rfc4975 requires. (termination from sender and error code from receiver when cancelling). 12. Bug correction related to messages received not belonging to any session, old stack implementation did send error response, but after response was written it did give the buffer to client anyway. Now corrected.

/*
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* Name          : NormalUASStates.h
* Part of       : TransactionUser
* Version       : SIP/5.0
*
*/




/**
 @internalComponent
*/


#ifndef NORMALUASSTATES_H
#define NORMALUASSTATES_H

// INCLUDES
#include "UserAgentState.h"

// FORWARD DECLARATIONS

// CLASS DECLARATION

// Waiting SIP request from transaction layer. Transaction can't be canceled now,
// as TransactionId hasn't yet been passed to MTransactionOwner.
class CNormalUAS_Start : public CUserAgentState
	{
public: // Constructors and destructor

	CNormalUAS_Start();

	~CNormalUAS_Start();

public: // From CUserAgentState

	void TransactionEndsL(CUserAgent& aUserAgent, TInt aReason) const;
	
	void ReceiveL(CUserAgent& aUserAgent, CSIPRequest* aRequest) const;

	// TransactionEndsL does not occur in this state

	// Upper layer shouldn't send response yet, as UA hasn't passed the request
	// yet, but in theory this can happen if upper layer happens to use this
	// UAS's TransactionId.
	void SendResponseL(CUserAgent& aUserAgent,
					   CSIPResponse* aResp,
					   const TSIPTransportParams& aParams) const;

public: // New functions

	void SetNeighbourStates(CUserAgentState& aGetTxOwner,
							CUserAgentState& aWaitRespFromApp,
							CUserAgentState& aFinalRespSent);

private: // Data

	// Next possible states, not owned.
	CUserAgentState* iGetTxOwner;
	CUserAgentState* iWaitRespFromApp;
	CUserAgentState* iFinalRespSent;

	// For testing purposes
#ifdef CPPUNIT_TEST
	friend class CNormalUAS_Start_Test;
#endif
	};



// Waiting to obtain MTransactionOwner. Transaction can't be canceled now,
// as TransactionId hasn't yet been passed to MTransactionOwner.
class CNormalUAS_GetTxOwner : public CUserAgentState
	{
public: // Constructors and destructor

	CNormalUAS_GetTxOwner();

	~CNormalUAS_GetTxOwner();
	
public: // From CUserAgentState

	void OwnerFoundL(CUserAgent& aUserAgent, MTransactionOwner* aOwner) const;

	void OwnerNotFoundL(CUserAgent& aUserAgent, CSIPResponse* aResp) const;

	// Upper layer shouldn't send response yet, as UA hasn't passed the request
	// yet, but in theory this can happen if upper layer happens to use this
	// UAS's TransactionId.
	void SendResponseL(CUserAgent& aUserAgent,
					   CSIPResponse* aResp,
					   const TSIPTransportParams& aParams) const;

    void TransactionEndsL(CUserAgent& aUserAgent, TInt aReason) const;

    void TimerExpiredL(CUserAgent& aUserAgent,
					   TTimerId aTimerId,
					   TAny* aTimerParam) const;

    void RequestRouterErrorL(CUserAgent& aUserAgent) const;

public: // New functions

	void SetNeighbourStates(CUserAgentState& aWaitRespFromApp,
							CUserAgentState& aFinalRespSent);	

private: // Data

	// Next possible states, not owned.
	CUserAgentState* iWaitRespFromApp;
	CUserAgentState* iFinalRespSent;

	// For testing purposes
#ifdef CPPUNIT_TEST
	friend class CNormalUAS_GetTxOwner_Test;
	friend class CUserAgentServer_Test;
#endif
	};



//Waiting upper layer to send a SIP response.
class CNormalUAS_WaitRespFromApp : public CUserAgentState
	{
public: // Constructors and destructor

	CNormalUAS_WaitRespFromApp();

	~CNormalUAS_WaitRespFromApp();
	
public: // From CUserAgentState

	void SendResponseL(CUserAgent& aUserAgent,
					   CSIPResponse* aResp,
					   const TSIPTransportParams& aParams) const;

	void TransactionEndsL(CUserAgent& aUserAgent, TInt aReason) const;

public: // New functions

	void SetNeighbourStates(CUserAgentState& aFinalRespSent);

private: // Data

	// Next possible state, not owned.
	CUserAgentState* iFinalRespSent;

	// For testing purposes
#ifdef CPPUNIT_TEST
	friend class CNormalUAS_WaitRespFromApp_Test;
#endif
	};



//Waiting transaction state machine to end
class CNormalUAS_FinalRespSent : public CUserAgentState
	{
public: // Constructors and destructor

	CNormalUAS_FinalRespSent();

	~CNormalUAS_FinalRespSent();
	
public: // From CUserAgentState

	void TransactionEndsL(CUserAgent& aUserAgent, TInt aReason) const;

	// Upper layer shouldn't send response anymore, as a final response has
	// already been sent.
	void SendResponseL(CUserAgent& aUserAgent,
					   CSIPResponse* aResp,
					   const TSIPTransportParams& aParams) const;

	// For testing purposes
#ifdef CPPUNIT_TEST
	friend class CNormalUAS_FinalRespSent_Test;
#endif
	};

#endif // end of NORMALUASSTATES_H

// End of File