epoc32/include/sipaddressheaderbase.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : sipaddressheaderbase.h
williamr@2
    16
* Part of     : SIP Codec
williamr@2
    17
* Interface   : SDK API, SIP Codec API
williamr@2
    18
* Version     : SIP/4.0 
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef CSIPADDRESSHEADERBASE_H
williamr@2
    26
#define CSIPADDRESSHEADERBASE_H
williamr@2
    27
williamr@2
    28
//  INCLUDES
williamr@2
    29
#include "sipparameterheaderbase.h"
williamr@2
    30
#include "_sipcodecdefs.h"
williamr@2
    31
williamr@2
    32
// FORWARD DECLARATIONS
williamr@2
    33
class CSIPAddress;
williamr@2
    34
class CSIPHeaderGenericParams;
williamr@2
    35
williamr@2
    36
// CLASS DECLARATION
williamr@2
    37
/**
williamr@2
    38
* @publishedAll
williamr@2
    39
* @released
williamr@2
    40
*
williamr@2
    41
* A base class for SIP headers having syntax
williamr@2
    42
* ( name-addr/ addr-spec ) *(generic-param)
williamr@2
    43
*
williamr@2
    44
*  @lib sipcodec.lib
williamr@2
    45
*/
williamr@2
    46
class CSIPAddressHeaderBase : public CSIPParameterHeaderBase
williamr@2
    47
	{
williamr@2
    48
	public:	// Constructors and destructor
williamr@2
    49
williamr@2
    50
		/**
williamr@2
    51
		* Destructor, deletes the resources of CSIPAddressHeaderBase.
williamr@2
    52
		*/
williamr@2
    53
        IMPORT_C virtual ~CSIPAddressHeaderBase();
williamr@2
    54
williamr@2
    55
williamr@2
    56
	public: // New functions
williamr@2
    57
williamr@2
    58
		/**
williamr@2
    59
		* Sets the name-address
williamr@2
    60
		* @pre aSIPAddress != 0
williamr@2
    61
		* @param aSIPAddress a name-address to set, the ownership is transferred
williamr@2
    62
		*/
williamr@2
    63
		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
williamr@2
    64
williamr@2
    65
		/**
williamr@2
    66
		* Gets the name-address as const
williamr@2
    67
		* @return name-address object
williamr@2
    68
		*/
williamr@2
    69
		IMPORT_C const CSIPAddress& SIPAddress() const;
williamr@2
    70
williamr@2
    71
		/**
williamr@2
    72
		* Gets the name-address
williamr@2
    73
		* @return name-address object
williamr@2
    74
		*/
williamr@2
    75
		IMPORT_C CSIPAddress& SIPAddress();
williamr@2
    76
williamr@2
    77
williamr@2
    78
	protected: // Constructors
williamr@2
    79
williamr@2
    80
		CSIPAddressHeaderBase();
williamr@2
    81
        void ConstructL();
williamr@2
    82
		void ConstructL(CSIPAddress* aSIPAddress);
williamr@2
    83
        void ConstructL(const CSIPAddressHeaderBase& aHeader);
williamr@2
    84
williamr@2
    85
	protected: // Data
williamr@2
    86
williamr@2
    87
        /**
williamr@2
    88
        * @internalComponent
williamr@2
    89
        */
williamr@2
    90
		CSIPAddress* iSIPAddress;
williamr@2
    91
		
williamr@2
    92
        /**
williamr@2
    93
        * @internalComponent
williamr@2
    94
        */		
williamr@2
    95
		CSIPHeaderGenericParams* iParams;
williamr@2
    96
williamr@2
    97
	protected: // New functions
williamr@2
    98
williamr@2
    99
		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2
   100
williamr@2
   101
	protected: // From CSIPHeaderBase
williamr@2
   102
williamr@2
   103
        /**
williamr@2
   104
        * @internalComponent
williamr@2
   105
        */
williamr@2
   106
		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2
   107
williamr@2
   108
	private: // From CSIPParameterHeaderBase
williamr@2
   109
williamr@2
   110
		HBufC8* ToTextMandatoryPartLC() const;
williamr@2
   111
		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2
   112
		const CSIPParamContainerBase& Params() const;
williamr@2
   113
		CSIPParamContainerBase& Params();
williamr@2
   114
	};
williamr@2
   115
williamr@2
   116
#endif // end of CSIPADDRESSHEADERBASE_H
williamr@2
   117
williamr@2
   118
// End of File