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          : siptimestampheader.h
williamr@2: * Part of       : SIP Codec
williamr@2: * Version       : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPTIMESTAMPHEADER_H
williamr@2: #define CSIPTIMESTAMPHEADER_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 for a SIP Timestamp header.
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPTimestampHeader : public CSIPHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPTimestampHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Timestamp"-header (e.g. "12 3.4")
williamr@2: 		* @returns a new instance of CSIPTimestampHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPTimestampHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2:         /**
williamr@2: 		* Constructor
williamr@2:         * @param aTimestamp a timestamp value to set.
williamr@2:         * @param aDealy a delay value to set.
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPTimestampHeader(TReal aTimestamp);
williamr@2: 
williamr@2:         /**
williamr@2: 		* Destructor
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPTimestampHeader ();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2:         /**
williamr@2:         * Set the timestamp from the "Timestamp" header.
williamr@2:         * @param aTimestamp a timestamp to set.
williamr@2:         */
williamr@2:         IMPORT_C void SetTimestamp(TReal aTimestamp);
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the timestamp from the "Timestamp" header.
williamr@2:         * @return a timestamp value.
williamr@2:         */
williamr@2:         IMPORT_C TReal Timestamp() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Check if the delay-part is present
williamr@2:         * @return a delay value.
williamr@2:         */
williamr@2:         IMPORT_C TBool HasDelay() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Set the delay-part of the "Timestamp" header.
williamr@2:         * @param aDelay a delay to set.
williamr@2:         */
williamr@2:         IMPORT_C void SetDelay(TReal aDelay);
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the delay-part of the "Timestamp" header, 
williamr@2:         * if delay-part is present
williamr@2:         * @return a delay value or zero if HasDelay() == EFalse
williamr@2:         */
williamr@2:         IMPORT_C TReal Delay() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPTimestampHeader 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 CSIPTimestampHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPHeaderBase* 
williamr@2: 			InternalizeValueL(RReadStream& aReadStream);
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: // New functions
williamr@2: 
williamr@2: 		void ParseL(const TDesC8& aValue);
williamr@2:         void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		TReal iTimestamp;
williamr@2:         TBool iHasDelay;
williamr@2:         TReal iDelay;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPTimestampHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: #endif // end of CSIPTIMESTAMPHEADER_H
williamr@2: 
williamr@2: // End of File