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          : sipcallidheader.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 CSIPCALLIDHEADER_H
williamr@2: #define CSIPCALLIDHEADER_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 Call-ID header.
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPCallIDHeader : public CSIPHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPCallIDHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Call-ID"-header (e.g. "ab2x@zb7y")
williamr@2: 		* @returns a new instance of CSIPCallIDHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPCallIDHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPCallIDHeader ();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Compares this instance to another "Call-ID" header object
williamr@2: 		* @param aCallIDHeader a header to compare to
williamr@2: 		* @returns ETrue if "Call-ID" headers are similar
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool operator==(const CSIPCallIDHeader& aCallIDHeader);
williamr@2: 		
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPCallIDHeader 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 CSIPCallIDHeader
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: 		TBool HasCompactName() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		RStringF CompactName() const;
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: 		CSIPCallIDHeader();
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		void ParseL(const TDesC8& aValue);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		HBufC8* iCallID;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPCallIDHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: #endif // end of CSIPCALLIDHEADER_H
williamr@2: 
williamr@2: // End of File