epoc32/include/mw/sipexpiresheader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/sipexpiresheader.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

/*
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* Name        : sipexpiresheader.h
* Part of     : SIP Codec
* Interface   : SDK API, SIP Codec API
* Version     : SIP/4.0 
*
*/




#ifndef CSIPEXPIRESHEADER_H
#define CSIPEXPIRESHEADER_H

//  INCLUDES
#include "sipunsignedintheaderbase.h"
#include "_sipcodecdefs.h"

// CLASS DECLARATION
/**
* @publishedAll
* @released
*
* Class encapsulates a "Expires" header value.
*
*  @lib sipcodec.lib
*/
class CSIPExpiresHeader : public CSIPUnsignedIntHeaderBase
	{
	public:	// Constructors and destructor

		/**
		* Constructs a CSIPExpiresHeader from textual representation 
		* of the header's value part.
		* @param aValue a value part of a "Expires"-header (e.g. "3600")
		* @return a new instance of CSIPExpiresHeader
		*/
		IMPORT_C static CSIPExpiresHeader* DecodeL(const TDesC8& aValue);
	
		/**
		* Constructor
		* @param aValue the value to set
		*/
		IMPORT_C CSIPExpiresHeader(TUint aValue);
	
		/**
		* Destructor, deletes the resources of CSIPExpiresHeader.
		*/
		IMPORT_C ~CSIPExpiresHeader();


	public: // New functions

		/**
		* Constructs an instance of a CSIPExpiresHeader from a RReadStream
		* @param aReadStream a stream containing the value of the
		*        externalized header object (header name not included).
		* @return an instance of a CSIPExpiresHeader
		*/
		IMPORT_C static CSIPHeaderBase* 
			InternalizeValueL(RReadStream& aReadStream);


	public: // From CSIPHeaderBase

		/**
		* From CSIPHeaderBase CloneL
		*/
		IMPORT_C CSIPHeaderBase* CloneL() const;

		/**
		* From CSIPHeaderBase Name
		*/
		IMPORT_C RStringF Name() const;


	public: // From CSIPHeaderBase, for internal use

        /**
        * @internalComponent
        */
		TPreferredPlace PreferredPlaceInMessage() const;

	public: // New functions, for internal use

		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);

	private: // For testing purposes
	
		UNIT_TEST(CSIPExpiresHeaderTest)
	};

#endif // CSIPEXPIRESHEADER_H

// End of File