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        : sipsubscriptionstateheader.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 CSIPSUBSCRIPTIONSTATEHEADER_H
williamr@2: #define CSIPSUBSCRIPTIONSTATEHEADER_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 CSIPSubscriptionStateHeaderParams;
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 "Subscription-State"
williamr@2: * header fields.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPSubscriptionStateHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Subscription-State"-header
williamr@2: 		* @return a new instance of CSIPSubscriptionStateHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPSubscriptionStateHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPSubscriptionStateHeader
williamr@2: 		* @param aSubStateValue a substate-value value
williamr@2: 		* @return a new instance of CSIPSubscriptionStateHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPSubscriptionStateHeader* 
williamr@2: 			NewL(const TDesC8& aSubStateValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPSubscriptionStateHeader 
williamr@2: 		* and puts it to CleanupStack
williamr@2: 		* @param aSubStateValue a substate-value value
williamr@2: 		* @return a new instance of CSIPSubscriptionStateHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPSubscriptionStateHeader* 
williamr@2: 			NewLC(const TDesC8& aSubStateValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPSubscriptionStateHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPSubscriptionStateHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Gets the substate-value parameter from the "Subscription-State" header
williamr@2: 		* @return the substate-value parameter
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& SubStateValue() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the substate-value parameter in the "Subscription-State" header; 
williamr@2: 		* @param aSubStateValue a substate-value parameter to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetSubStateValueL(const TDesC8& aSubStateValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of the "expires"-parameter
williamr@2: 		* @return "expires"-parameter or KErrNotFound if 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 the "retry-after"-parameter
williamr@2: 		* @return "retry-after"-parameter or KErrNotFound if not present
williamr@2: 		*/
williamr@2: 		IMPORT_C TInt RetryAfterParameter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "retry-after"-parameter
williamr@2: 		* @pre aRetryAfterParam >= 0
williamr@2: 		* @param aRetryAfterParam a "retry-after"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetRetryAfterParameterL(TInt aRetryAfterParam);
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPSubscriptionStateHeader 
williamr@2: 		* 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 CSIPSubscriptionStateHeader
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: 		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: 		CSIPSubscriptionStateHeader();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aSubStateValue);
williamr@2:         void ConstructL (const CSIPSubscriptionStateHeader&
williamr@2:             aSubscriptionStateHeader);
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: 		HBufC8* iSubStateValue;
williamr@2: 		CSIPSubscriptionStateHeaderParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPSubscriptionStateHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: #endif // CSIPSUBSCRIPTIONSTATEHEADER_H
williamr@2: 
williamr@2: // End of File