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        : siprackheader.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 CSIPRACKHEADER_H
williamr@2: #define CSIPRACKHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
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 sequence number and
williamr@2: * method in SIP "RAck"-header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPRAckHeader : public CSIPHeaderBase
williamr@2: 	{
williamr@2: 	public: // Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPRAckHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "RAck"-header (e.g. "1 2 INVITE")
williamr@2: 		* @return a new instance of CSIPRAckHeader.  
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPRAckHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPRAckHeader
williamr@2: 		* @param aSeq a sequence number to set
williamr@2:         * @param aCSeqNum a sequence number from CSeq-header
williamr@2: 		* @param aMethod a method to set. For example "REGISTER"
williamr@2: 		* @return a new instance of CSIPRAckHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPRAckHeader* NewL(TUint aSeq,
williamr@2:                                              TUint aCSeqNum,
williamr@2:                                              RStringF aMethod);
williamr@2: 
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPRAckHeader and puts it to CleanupStack
williamr@2: 		* @param aSeq a sequence number to set
williamr@2:         * @param aCSeqNum a sequence number from CSeq-header
williamr@2: 		* @param aMethod a method to set. For example "REGISTER"
williamr@2: 		* @return a new instance of CSIPRAckHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPRAckHeader* NewLC(TUint aSeq,
williamr@2:                                               TUint aCSeqNum,
williamr@2:                                               RStringF aMethod);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPRAckHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPRAckHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the sequence number from the "RAck" header
williamr@2: 		* @return the current sequence number
williamr@2: 		*/
williamr@2: 		IMPORT_C TUint Seq() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the sequence number in the "RAck" header
williamr@2: 		* @param aSeq a sequence number to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetSeq(TUint aSeq);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the sequence number from the "RAck" header
williamr@2: 		* @return the current sequence number
williamr@2: 		*/
williamr@2: 		IMPORT_C TUint CSeqNum() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the sequence number in the "RAck" header
williamr@2: 		* @param aCSeqNum a sequence number to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetCSeqNum(TUint aCSeqNum);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the method from the "RAck" header
williamr@2: 		* @return the method 
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF Method() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the method in the "RAck" header
williamr@2: 		* @param aMethod a method to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetMethodL(RStringF aMethod);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPRAckHeader 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 CSIPRAckHeader
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: 		* From CSIPHeaderBase ToTextValueL
williamr@2: 		*/
williamr@2: 		IMPORT_C HBufC8* ToTextValueL() 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: // Constructors
williamr@2: 
williamr@2:         CSIPRAckHeader();
williamr@2: 		CSIPRAckHeader(TUint aSeq, TUint aCSeqNum);
williamr@2: 		void ConstructL(RStringF aMethod);
williamr@2: 		void ConstructL(const CSIPRAckHeader& aRAckHeader);
williamr@2: 	
williamr@2: 	private: // New functions
williamr@2: 		
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 		void ParseL(const TDesC8& aValue);
williamr@2: 		void SetMethodL(const TDesC8& aMethod);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		TUint iSeq;
williamr@2:         TUint iCSeqNum;
williamr@2: 		RStringF iMethod;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPRAckHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPRACKHEADER_H
williamr@2: 
williamr@2: // End of File