epoc32/include/mw/siprouteheaderbase.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/siprouteheaderbase.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,122 @@
     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        : siprouteheaderbase.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 CSIPROUTEHEADERBASE_H
    1.29 +#define CSIPROUTEHEADERBASE_H
    1.30 +
    1.31 +//  INCLUDES
    1.32 +#include "sipparameterheaderbase.h"
    1.33 +#include "_sipcodecdefs.h"
    1.34 +
    1.35 +// FORWARD DECLARATIONS
    1.36 +class CSIPAddress;
    1.37 +class CSIPHeaderGenericParams;
    1.38 +
    1.39 +// CLASS DECLARATION
    1.40 +/**
    1.41 +* @publishedAll
    1.42 +* @released
    1.43 +*
    1.44 +* A base class for "Route"-, "Record-Route"- and "Service-Route"-headers.
    1.45 +*
    1.46 +*  @lib sipcodec.lib
    1.47 +*/
    1.48 +class CSIPRouteHeaderBase : public CSIPParameterHeaderBase
    1.49 +	{
    1.50 +	public:	// Constructors and destructor
    1.51 +
    1.52 +		/**
    1.53 +		* Destructor, deletes the resources of CSIPRouteHeaderBase.
    1.54 +		*/
    1.55 +		IMPORT_C virtual ~CSIPRouteHeaderBase();
    1.56 +
    1.57 +
    1.58 +	public:	// New functions
    1.59 +		
    1.60 +		/**
    1.61 +		* Sets the name-address
    1.62 +		* @pre aSIPAddress != 0
    1.63 +		* @param aSIPAddress a name-address, the ownership is transferred
    1.64 +		*/
    1.65 +		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
    1.66 +	
    1.67 +		/**
    1.68 +		* Gets the name-address as const
    1.69 +		* @return name-address
    1.70 +		*/
    1.71 +		IMPORT_C const CSIPAddress& SIPAddress() const;
    1.72 +
    1.73 +		/**
    1.74 +		* Gets the name-address
    1.75 +		* @return name-address
    1.76 +		*/
    1.77 +		IMPORT_C CSIPAddress& SIPAddress();
    1.78 +
    1.79 +
    1.80 +	public: // From CSIPHeaderBase, for internal use
    1.81 +
    1.82 +        /**
    1.83 +        * @internalComponent
    1.84 +        */	
    1.85 +		TBool MoreThanOneAllowed() const;
    1.86 +		
    1.87 +        /**
    1.88 +        * @internalComponent
    1.89 +        */		
    1.90 +		TPreferredPlace PreferredPlaceInMessage() const;
    1.91 +
    1.92 +	protected: // Contructors
    1.93 +
    1.94 +		CSIPRouteHeaderBase();
    1.95 +		void ConstructL();
    1.96 +		void ConstructL(CSIPAddress* aSIPAddress);
    1.97 +		void ConstructL(const CSIPRouteHeaderBase& aRouteHeaderBase);
    1.98 +
    1.99 +	protected: // Data
   1.100 +
   1.101 +        /**
   1.102 +        * @internalComponent
   1.103 +        */
   1.104 +		CSIPAddress* iSIPAddress;
   1.105 +		
   1.106 +        /**
   1.107 +        * @internalComponent
   1.108 +        */		
   1.109 +		CSIPHeaderGenericParams* iParams;
   1.110 +
   1.111 +	private: // From CSIPParameterHeaderBase
   1.112 +
   1.113 +		HBufC8* ToTextMandatoryPartLC() const;
   1.114 +		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
   1.115 +		const CSIPParamContainerBase& Params() const;
   1.116 +		CSIPParamContainerBase& Params();
   1.117 +
   1.118 +	private: // For testing purposes
   1.119 +	
   1.120 +		UNIT_TEST(CSIPRouteHeaderBaseTest)
   1.121 +	};
   1.122 +
   1.123 +#endif // CSIPROUTEHEADERBASE_H
   1.124 +
   1.125 +// End of File