realtimenetprots/sipfw/SIP/Transaction/src/ResponseQueueItem.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          : ResponseQueueItem.h
* Part of       : Transaction
* Version       : SIP/5.0
*
*/




/**
 @internalComponent
*/


#ifndef RESPONSEQUEUEITEM_H
#define RESPONSEQUEUEITEM_H

// INCLUDES
#include <e32base.h>
#include "TSIPTransportParams.h"

// FORWARD DECLARATIONS
class CSIPResponse;


/**
 * This class contains a SIP response and the related transport parameters.
 */
class CResponseQueueItem : public CBase
	{
public: // Constructor and destructor

	/**
	 * Creates a new instance of CResponseQueueItem. CResponseQueueItem never
	 * takes ownership of a 2xx response that is sent to INVITE.
	 *
	 * @pre aResp != NULL
	 *
	 * @param aResp SIP response, ownership is not transferred yet.
	 *	Ownership transfer is done later by using SetResponseOwnership(ETrue)
	 * @param aParams Transport parameters
	 * @param aRespToInvite ETrue if aResp is a response to INVITE
	 * @return new CResponseQueueItem object, ownership is transferred
	 */
	static CResponseQueueItem* NewLC(CSIPResponse* aResp,
									 const TSIPTransportParams& aParams,
									 TBool aRespToInvite);

	~CResponseQueueItem();

public: // New functions

	/**
	 * Takes or releases the ownership of iResp member. If iResp is 2xx and
	 * iRespToInvite is ETrue, the ownership is not taken, regardless of the
	 * value of aOwnsResponse.
	 *
	 * @param aOwnsResponse If ETrue, the CResponseQueueItem owns the response
	 *	stored in iResp.
	 */
	void SetResponseOwnership(TBool aOwnsResponse);

	/**	
	 * Returns the stored SIP response.
	 *
	 * @return SIP response.
	 */
	CSIPResponse& Response();

	/**
	 * Returns the stored transport parameters.
	 *
	 * @return Transport parameters
	 */
	const TSIPTransportParams& TransportParams() const;

	/**	
	 * Checks if the response is to an INVITE request.
	 *	 
	 * @return ETrue Response is to an INVITE request, EFalse otherwise
	 */
	TBool IsRespToInvite() const;

private: // Constructor, for internal use

	/**	
	 * Constructor
	 *
	 * @pre aUri != NULL
	 *
	 * @param aResp SIP response, ownership is transferred
	 * @param aParams Transport parameters	 
	 */
	CResponseQueueItem(CSIPResponse* aResp,
					   const TSIPTransportParams& aParams,
					   TBool aRespToInvite);

private: // Data
	
	CSIPResponse* iResp;
	TSIPTransportParams iParams;	

	//If ETrue, the SIP response in iResp is a response to INVITE.
	//If iResp is 2xx and iRespToInvite is ETrue, iOwnsResponse remains always
	//EFalse, as UAS owns the 2xx response to INVITE.
	TBool iRespToInvite;

	//If ETrue, CResponseQueueItem owns the response in iResp.
	TBool iOwnsResponse;
	};

#endif // end of RESPONSEQUEUEITEM_H

// End of File