epoc32/include/mw/siptokenheaderbase.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/siptokenheaderbase.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,114 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Name        : siptokenheaderbase.h
    1.19 +* Part of     : SIP Codec
    1.20 +* Interface   : SDK API, SIP Codec API
    1.21 +* Version     : SIP/4.0 
    1.22 +*
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +#ifndef CSIPTOKENHEADERBASE_H
    1.29 +#define CSIPTOKENHEADERBASE_H
    1.30 +
    1.31 +//  INCLUDES
    1.32 +#include "sipheaderbase.h"
    1.33 +#include "_sipcodecdefs.h"
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +/**
    1.37 +* @publishedAll
    1.38 +* @released
    1.39 +*
    1.40 +* A base class for SIP headers having form "Name: token *(COMMA token)"
    1.41 +*
    1.42 +* @lib sipcodec.lib
    1.43 +*/
    1.44 +class CSIPTokenHeaderBase : public CSIPHeaderBase
    1.45 +	{
    1.46 +	public:	// Constructors and destructor
    1.47 +
    1.48 +		/**
    1.49 +		* Destructor, deletes the resources of CSIPTokenHeaderBase.
    1.50 +		*/
    1.51 +		IMPORT_C virtual ~CSIPTokenHeaderBase();
    1.52 +
    1.53 +
    1.54 +	public: // New functions
    1.55 +
    1.56 +		/**
    1.57 +		* Sets the header value as a token 
    1.58 +		* @param aValue a value to set
    1.59 +		*/
    1.60 +		IMPORT_C void SetValueL(RStringF aValue);
    1.61 +	
    1.62 +		/**
    1.63 +		* Gets the header value as a token 
    1.64 +		* @return the header value
    1.65 +		*/
    1.66 +		IMPORT_C RStringF Value() const;
    1.67 +
    1.68 +
    1.69 +	public: // From CSIPHeaderBase
    1.70 +
    1.71 +		/**
    1.72 +		* From CSIPHeaderBase ToTextValueL
    1.73 +		*/
    1.74 +		IMPORT_C HBufC8* ToTextValueL() const;
    1.75 +
    1.76 +
    1.77 +	public: // From CSIPHeaderBase, for internal use
    1.78 +
    1.79 +        /**
    1.80 +        * @internalComponent
    1.81 +        */
    1.82 +		virtual TBool MoreThanOneAllowed() const;
    1.83 +
    1.84 +	protected: // Constructors
    1.85 +
    1.86 +		CSIPTokenHeaderBase();
    1.87 +	    CSIPTokenHeaderBase(const CSIPTokenHeaderBase& aHeader);
    1.88 +		void ConstructL(const TDesC8& aValue, TBool aEmptyValueAllowed=EFalse);
    1.89 +		void ConstructL(RStringF aValue, TBool aEmptyValueAllowed=EFalse);
    1.90 +		
    1.91 +	protected: // New functions		
    1.92 +		
    1.93 +		void DoInternalizeValueL(RReadStream& aReadStream);
    1.94 +
    1.95 +	protected: // Data	
    1.96 +	
    1.97 +        /**
    1.98 +        * @internalComponent
    1.99 +        */	
   1.100 +		RStringF iValue;
   1.101 +
   1.102 +	private: // From CSIPHeaderBase
   1.103 +
   1.104 +		void ExternalizeValueL(RWriteStream& aWriteStream) const;
   1.105 +
   1.106 +	private: // New functions
   1.107 +
   1.108 +		void SetValueL(const TDesC8& aValue);	
   1.109 +
   1.110 +	private: // For testing purposes
   1.111 +	
   1.112 +		UNIT_TEST(CSIPTokenHeaderBaseTest)
   1.113 +	};
   1.114 +
   1.115 +#endif // CSIPTOKENHEADERBASE_H
   1.116 +
   1.117 +// End of File