realtimenetprots/sipfw/SIP/Codec/api/sipsupportedheader.h
changeset 0 307788aac0a8
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/realtimenetprots/sipfw/SIP/Codec/api/sipsupportedheader.h	Tue Feb 02 01:03:15 2010 +0200
@@ -0,0 +1,133 @@
+/*
+* 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 "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+* Name        : sipsupportedheader.h
+* Part of     : SIP Codec
+* Interface   : SDK API, SIP Codec API
+* Version     : SIP/4.0 
+*
+*/
+
+
+
+
+#ifndef CSIPSUPPORTEDHEADER_H
+#define CSIPSUPPORTEDHEADER_H
+
+//  INCLUDES
+#include "siptokenheaderbase.h"
+
+// CLASS DECLARATION
+/**
+* @publishedAll
+* @released
+*
+* Class provides functions for setting and getting SIP "Supported" header.
+*
+* @lib sipcodec.lib
+*/
+class CSIPSupportedHeader : public CSIPTokenHeaderBase
+	{
+	public:	// Constructors and destructor
+
+		/**
+		* Constructs a CSIPSupportedHeader from textual representation 
+		* of the header's value part.
+		* @param aValue a value part of a "Supported"-header
+		* @return an array containing 1..n instances of CSIPSupportedHeader  
+		*/
+		IMPORT_C static RPointerArray<CSIPSupportedHeader> 
+			DecodeL(const TDesC8& aValue);
+
+		/**
+		* Creates a new instance of CSIPSupportedHeader
+		* @param aValue a tag value 
+		* @return a new instance of CSIPSupportedHeader
+		*/
+		IMPORT_C static CSIPSupportedHeader* NewL(RStringF aValue);
+
+		/**
+		* Creates a new instance of CSIPSupportedHeader 
+		* and puts it to CleanupStack
+		* @param aValue a tag value   
+		* @return a new instance of CSIPSupportedHeader
+		*/
+		IMPORT_C static CSIPSupportedHeader* NewLC(RStringF aValue);
+
+		/**
+		* Destructor, deletes the resources of CSIPSupportedHeader.
+		*/
+		IMPORT_C ~CSIPSupportedHeader();
+
+
+	public: // New functions
+
+		/**
+		* Constructs an instance of a CSIPSupportedHeader from a RReadStream
+		* @param aReadStream a stream containing the value of the
+		*        externalized object (header name not included). 
+		* @return an instance of a CSIPSupportedHeader
+		*/
+		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
+        */
+		TBool HasCompactName() const;
+		
+        /**
+        * @internalComponent
+        */		
+		RStringF CompactName() const;
+		
+        /**
+        * @internalComponent
+        */		
+		TPreferredPlace PreferredPlaceInMessage() const;
+
+	public: // New functions, for internal use
+
+		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
+
+	private: // New functions
+
+		CSIPSupportedHeader();
+		CSIPSupportedHeader(const CSIPSupportedHeader& aHeader);
+
+	private: // For testing purposes
+#ifdef CPPUNIT_TEST	
+		friend class CSIPSupportedHeaderTest;
+#endif
+	};
+
+#endif // CSIPSUPPORTEDHEADER_H
+
+// End of File