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        : sipcontactheader.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 CSIPCONTACTHEADER_H
williamr@2: #define CSIPCONTACTHEADER_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 CSIPAddress;
williamr@2: class CSIPContactHeaderParams;
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 SIP "Contact"
williamr@2: * header fields.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPContactHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public: // Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPContactHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* Note that "Contact: *" can be only created using this function.
williamr@2: 		* @param aValue a value part of a "Contact"-header
williamr@2: 		* @return an array containing 1..n instances of CSIPContactHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static RPointerArray<CSIPContactHeader> 
williamr@2: 			DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPContactHeader
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred 
williamr@2: 		* @return a new instance of CSIPContactHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPContactHeader* NewL(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPContactHeader and puts it to CleanupStack
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred 
williamr@2: 		* @return a new instance of CSIPContactHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPContactHeader* NewLC(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPContactHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPContactHeader();
williamr@2: 
williamr@2: 	
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Compares this object to another instance of CSIPContactHeader
williamr@2: 		* @param aHeader a CSIPContactHeader header to compare to
williamr@2: 		* @return ETrue if the objects are equal otherwise EFalse
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool operator==(const CSIPContactHeader& aHeader) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Checks if the address is set to a STAR ("*")
williamr@2: 		* @return ETrue, if the address is a "*" otherwise EFalse
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool Star() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of the "expires"-parameter
williamr@2: 		* @return the "expires"-parameter, or 
williamr@2: 		*         KErrNotFound if the parameter is not present.
williamr@2: 		*/
williamr@2: 		IMPORT_C TInt ExpiresParameter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "expires"-parameter
williamr@2: 		* @pre aExpiresParam >= 0
williamr@2: 		* @param aExpiresParam a "expires"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetExpiresParameterL(TInt aExpiresParam);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of "q"-parameter
williamr@2: 		* @pre Star() == EFalse
williamr@2: 		* @return the "q"-parameter value, 
williamr@2: 		*         or zero if the parameter is not present.
williamr@2: 		*/
williamr@2: 		IMPORT_C TReal QParameter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "q"-parameter value in the "Contact" header
williamr@2: 		* @pre Star() == EFalse
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: 		* Gets the name-address as const
williamr@2: 		* @return name-address or 0 if not present
williamr@2: 		*         The ownership is NOT transferred.
williamr@2: 		*/
williamr@2: 		IMPORT_C const CSIPAddress* SIPAddress() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the name-address
williamr@2: 		* @return name-address or 0 if not present
williamr@2: 		*         The ownership is NOT transferred.
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPAddress* SIPAddress();
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the name-address
williamr@2: 		* @pre Star() == EFalse
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address to set, the ownership is transferred
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPContactHeader 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 CSIPContactHeader
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: 		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: 		TBool ParamInsertionAllowed() const;
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: 		CSIPContactHeader(TBool aIsStar=EFalse);
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(CSIPAddress* aSIPAddress);
williamr@2: 		void ConstructL(const CSIPContactHeader& aContactHeader);
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: 		CSIPAddress* iSIPAddress;
williamr@2: 		CSIPContactHeaderParams* iParams;
williamr@2: 		TBool iIsStar;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPContactHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPCONTACTHEADER_H
williamr@2: 
williamr@2: // End of File