williamr@2: /*
williamr@2: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : sipextensionheader.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPEXTENSIONHEADER_H
williamr@2: #define CSIPEXTENSIONHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * The class stores unknown and extension headers that are either not 
williamr@2: * supported by the current SIP codec implementation or not specified in
williamr@2: * current SIP RFC or both.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPExtensionHeader : public CSIPHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPExtensionHeader
williamr@2: 		* @param aName the full or compact name of the header
williamr@2: 		* @param aValue the value of the header
williamr@2: 		* @return a new instance of CSIPExtensionHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPExtensionHeader* 
williamr@2: 			NewL(const TDesC8& aName, const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPExtensionHeader 
williamr@2: 		* and puts it to CleanupStack
williamr@2: 		* @param aName the full or compact name of the header
williamr@2: 		* @param aValue the value of the header
williamr@2: 		* @return a new instance of CSIPExtensionHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPExtensionHeader* 
williamr@2: 			NewLC(const TDesC8& aName, const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPExtensionHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPExtensionHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the header value
williamr@2: 		* @param aValue the header value to be set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetValueL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the header value
williamr@2: 		* @return the header value
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& Value() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPExtensionHeader from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized header object (header name not included).
williamr@2: 		* @return an instance of a CSIPExtensionHeader
williamr@2: 		*/
williamr@2: 
williamr@2: 		IMPORT_C static CSIPExtensionHeader* 
williamr@2: 			InternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase CloneL
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase Name
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF Name() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase ToTextValueL
williamr@2: 		*/
williamr@2: 		IMPORT_C HBufC8* ToTextValueL() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase ExternalizeSupported
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool ExternalizeSupported() const;
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions, for internal use
williamr@2: 
williamr@2: 		void SetNameL(const TDesC8& aName);
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */	
williamr@2: 		TBool IsExtensionHeader() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TBool EncodeMultipleToOneLine() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TBool MoreThanOneAllowed() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TBool HasCompactName() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		RStringF CompactName() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2: 
williamr@2: 	private: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2: 
williamr@2: 	private: // Constructors
williamr@2: 
williamr@2: 		CSIPExtensionHeader();
williamr@2: 		void ConstructL(const TDesC8& aName, const TDesC8& aValue);
williamr@2: 		void ConstructL(const CSIPExtensionHeader& aExtensionHeader);
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		TBool CheckValue (const TDesC8& aValue);
williamr@2: 	
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		// data
williamr@2: 		RStringF iName;
williamr@2: 		HBufC8* iValue;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPExtensionHeaderTest)
williamr@2: 		UNIT_TEST(CSIPHeaderLookupTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPEXTENSIONHEADER_H
williamr@2: 
williamr@2: // End of File