realtimenetprots/sipfw/SIP/Codec/api/sipsecurityheaderbase.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) 2004-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        : sipsecurityheaderbase.h
* Part of     : SIP Codec
* Interface   : SDK API, SIP Codec API
* Version     : SIP/4.0 
*
*/




#ifndef CSIPSECURITYHEADERBASE_H
#define CSIPSECURITYHEADERBASE_H

//  INCLUDES
#include "sipparameterheaderbase.h"

// FORWARD DECLARATIONS
class CSIPSecurityHeaderBaseParams;

// CLASS DECLARATION
/**
* @publishedAll
* @released
*
* A base class for Security-Client, Security-Server and Security-Verify.
*
*  @lib sipcodec.lib
*/
class CSIPSecurityHeaderBase : public CSIPParameterHeaderBase
	{
	public:	// Constructors and destructor

		/**
		* Destructor, deletes the resources of CSIPSecurityHeaderBase.
		*/
		IMPORT_C virtual ~CSIPSecurityHeaderBase();

	public: // New functions

		/**
		* Gets the value of "q"-parameter
		* @return the "q"-parameter value, zero if not present 
		*/
		IMPORT_C TReal PreferenceParam() const;

		/**
		* Sets the "q"-parameter value
		* @param aPreferenceValue a "q"-parameter value to set
		*/
		IMPORT_C void SetPreferenceParamL(TReal aPreferenceValue);

		/**
		* Gets the Mechanism-Name from the Security header
		* @return a Mechanism-Name
		*/
		IMPORT_C const TDesC8& MechanismName() const;

		/**
		* Sets the Mechanism-Name in the Security header
		* @param aMechanismName a Mechanism-Name
		*/
		IMPORT_C void SetMechanismNameL(const TDesC8& aMechanismName);

	public: // From CSIPHeaderBase, for internal use

        /**
        * @internalComponent
        */
		TBool MoreThanOneAllowed() const;
		
        /**
        * @internalComponent
        */		
		TPreferredPlace PreferredPlaceInMessage() const;

	protected: // Constructors

		CSIPSecurityHeaderBase();
		void ConstructL();
		void ConstructL(const TDesC8& aMechanismName);
		void ConstructL(const CSIPSecurityHeaderBase& aSecurityHeaderBase);
	
	protected: // New functions	
		
		void DoInternalizeValueL(RReadStream& aReadStream);

	private: // From CSIPHeaderBase

		void ExternalizeValueL(RWriteStream& aWriteStream) const;

	private: // From CSIPParameterHeaderBase

		HBufC8* ToTextMandatoryPartLC() const;
		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
		const CSIPParamContainerBase& Params() const;
		CSIPParamContainerBase& Params();

	private: // Data

		HBufC8* iMechanismName;
		CSIPSecurityHeaderBaseParams* iParams;

	private: // For testing purposes
#ifdef CPPUNIT_TEST	
		friend class CSIPSecurityHeaderBaseTest;
#endif
	};

#endif // CSIPSECURITYHEADERBASE_H

// End of File