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        : sipeventheader.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 CSIPEVENTHEADER_H
williamr@2: #define CSIPEVENTHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <bamdesca.h>
williamr@2: #include <badesca.h>
williamr@2: #include "sipparameterheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPEventHeaderParams;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * Class provides functions for setting and getting parameters in 
williamr@2: * SIP "Event" header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPEventHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPEventHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Event"-header
williamr@2: 		* @return a new instance of CSIPEventHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPEventHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPEventHeader
williamr@2: 		* @param aEventPackage a Event-Package value
williamr@2: 		* @return a new instance of CSIPEventHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPEventHeader* NewL(const TDesC8& aEventPackage);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPEventHeader and puts it to CleanupStack
williamr@2: 		* @param aEventPackage a Event-Package value
williamr@2: 		* @return a new instance of CSIPEventHeader
williamr@2: 		*/
williamr@2: 
williamr@2: 		IMPORT_C static CSIPEventHeader* NewLC(const TDesC8& aEventPackage);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPEventHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPEventHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public:	// New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Compares this instance to another CSIPEventHeader instance
williamr@2: 		* @param aHeader a header to compare to
williamr@2: 		* @return ETrue if the objects are equal otherwise EFalse
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool operator==(const CSIPEventHeader& aHeader) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the Event-Package parameter from the "Event" header
williamr@2: 		* @return the Event-Package parameter
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& EventPackage() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the Event-Package parameter in the "Event" header; 
williamr@2: 		* @param aEventPackage a Event-Package parameter to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetEventPackageL(const TDesC8& aEventPackage);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the event templates overwriting all the existing ones.
williamr@2: 		* @param aEventTemplates an array of event templates
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetEventTemplatesL(const MDesC8Array& aEventTemplates);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the event templates.
williamr@2: 		* @return a reference to the currently set event templates.
williamr@2: 		*/
williamr@2: 		IMPORT_C const MDesC8Array& EventTemplates() const;
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPEventHeader from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized object (header name not included).
williamr@2: 		* @return an instance of a CSIPEventHeader 
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPHeaderBase* 
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: 	public: // From CSIPHeaderBase, for internal use
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: 	public: // New functions, for internal use
williamr@2: 
williamr@2: 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 	private: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2: 
williamr@2: 	private: // From CSIPParameterHeaderBase
williamr@2: 
williamr@2: 		HBufC8* ToTextMandatoryPartLC() const;
williamr@2: 		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2: 		const CSIPParamContainerBase& Params() const;
williamr@2: 		CSIPParamContainerBase& Params();
williamr@2: 
williamr@2: 	private: // Constructors
williamr@2: 
williamr@2: 		CSIPEventHeader();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aEventPackage);
williamr@2: 		void ConstructL(const CSIPEventHeader& aSIPEventHeader);
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 		void CheckTemplateL(const TDesC8& aParam) const;
williamr@2: 		// Needed for cleanup of a RPointerArray<HBufC8>:
williamr@2: 		static void ResetAndDestroy(TAny* anArray);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		HBufC8* iEventPackage;
williamr@2: 		CSIPEventHeaderParams* iParams;
williamr@2: 		CDesC8ArraySeg* iEventTemplates;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPEventHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPEVENTHEADER_H
williamr@2: 
williamr@2: // End of File