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        : sipretryafterheader.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 CSIPRETRYAFTERHEADER_H
williamr@2: #define CSIPRETRYAFTERHEADER_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 CSIPRetryAfterHeaderParams;
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 SIP 
williamr@2: * "Retry-After" header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPRetryAfterHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPRetryAfterHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Retry-After"-header 
williamr@2: 		*        (e.g. "18000;duration=3600")
williamr@2: 		* @return a new instance of CSIPRetryAfterHeader   
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPRetryAfterHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPRetryAfterHeader
williamr@2: 		* @param aRetryAfter a retry after value.
williamr@2: 		* @return a new instance of CSIPRetryAfterHeader
williamr@2: 		*/
williamr@2:         IMPORT_C static CSIPRetryAfterHeader* NewL(TUint aRetryAfter);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPRetryAfterHeader
williamr@2:         * On return the new instance has left to the CleanupStack.
williamr@2: 		* @param aRetryAfter a retry after value.
williamr@2: 		* @return a new instance of CSIPRetryAfterHeader
williamr@2: 		*/
williamr@2:         IMPORT_C static CSIPRetryAfterHeader* NewLC(TUint aRetryAfter);
williamr@2: 
williamr@2:         /**
williamr@2: 		* Destructor, deletes the resources of CSIPRetryAfterHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual ~CSIPRetryAfterHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the retry after value
williamr@2: 		* @param aValue a new retry after value to set.
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetRetryAfter(TUint aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the retry after value
williamr@2: 		* @return a retry after value
williamr@2: 		*/
williamr@2: 		IMPORT_C TUint RetryAfter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the comment value
williamr@2: 		* @return a comment value or KNullDesC8
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& Comment() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of the "duration"-parameter
williamr@2: 		* @return the "duration"-parameter, or 
williamr@2: 		*         KErrNotFound if the parameter is not present.
williamr@2: 		*/
williamr@2: 		IMPORT_C TInt DurationParam() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "duration"-parameter
williamr@2: 		* @pre aDurationParam >= 0
williamr@2: 		* @param aDurationParam a "duration"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetDurationParamL(TInt aDurationParam);
williamr@2: 
williamr@2:         /**
williamr@2: 		* Constructs an instance of a CSIPRetryAfterHeader 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 CSIPRetryAfterHeader
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: 		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:         CSIPRetryAfterHeader();
williamr@2: 		CSIPRetryAfterHeader(TUint aRetryAfter);
williamr@2:         void ConstructL();
williamr@2: 		void ConstructL(const CSIPRetryAfterHeader& aRetryAfterHeader);
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: 		TUint iRetryAfter;
williamr@2:         HBufC8* iComment;
williamr@2: 		CSIPRetryAfterHeaderParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPRetryAfterHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // end of CSIPRETRYAFTERHEADER_H
williamr@2: 
williamr@2: // End of File