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        : sipacceptheader.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 CSIPACCEPTHEADER_H
williamr@2: #define CSIPACCEPTHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipparameterheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPAcceptHeaderParams;
williamr@2: 
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 media types and
williamr@2: * parameters in SIP "Accept" header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPAcceptHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPAcceptHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* An empty Accept-header can be created using this function
williamr@2: 		* by passing a KNullDesC8 as a parameter.
williamr@2: 		* @param aValue a value part of a "Accept"-header
williamr@2: 		* @return an array containing one to many instances of CSIPAcceptHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C static RPointerArray<CSIPAcceptHeader> 
williamr@2: 			DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPAcceptHeader
williamr@2: 		* @param aMediaType a media type to set. For example "application"
williamr@2: 		* @param aMediaSubtype a media subtype to set. For example "sdp"
williamr@2: 		* @return a new instance of CSIPAcceptHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPAcceptHeader* NewL(const TDesC8& aMediaType,
williamr@2: 		                                       const TDesC8& aMediaSubtype);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPAcceptHeader and puts it into 
williamr@2: 		* the cleanup stack
williamr@2: 		* @param aMediaType a media type to set. For example "application"
williamr@2: 		* @param aMediaSubtype a media subtype to set. For example "sdp"
williamr@2: 		* @return a new instance of CSIPAcceptHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPAcceptHeader* NewLC(const TDesC8& aMediaType,
williamr@2: 		                                        const TDesC8& aMediaSubtype);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPAcceptHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPAcceptHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Check if the header is empty. If so, 
williamr@2: 		* the other getters will not return a meaningful value.
williamr@2: 		* @return ETrue if empty, EFalse otherwise.
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool IsEmpty() const;
williamr@2:     
williamr@2: 		/**
williamr@2: 		* Gets the media type from the "Accept" header
williamr@2: 		* @return a media type
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& MediaType() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the media type in the "Accept" header
williamr@2: 		* @pre IsEmpty() == EFalse
williamr@2: 		* @param aMediaType a media type
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetMediaTypeL(const TDesC8& aMediaType);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the media subtype from the "Accept" header
williamr@2: 		* @return a media subtype
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& MediaSubtype() const;
williamr@2: 		/**
williamr@2: 		* Sets the media subtype in the "Accept" header
williamr@2: 		* @pre IsEmpty() == EFalse
williamr@2: 		* @param aMediaSubtype a media subtype
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetMediaSubtypeL(const TDesC8& aMediaSubtype);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of "q"-parameter
williamr@2: 		* @return the "q"-parameter value
williamr@2: 		*/
williamr@2: 		IMPORT_C TReal QParameter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "q"-parameter value
williamr@2: 		* @param aQValue a "q"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetQParameterL(TReal aQValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPAcceptHeader 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 CSIPAcceptHeader
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 MoreThanOneAllowed() 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: 		CSIPAcceptHeader(TBool aEmpty=EFalse);
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
williamr@2: 		void ConstructL(const CSIPAcceptHeader& aAcceptHeader);
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		TBool iEmpty;
williamr@2: 		HBufC8* iMediaType;
williamr@2: 		HBufC8* iMediaSubtype;
williamr@2: 		CSIPAcceptHeaderParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPAcceptHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPACCEPTHEADER_H
williamr@2: 
williamr@2: // End of File