epoc32/include/mw/sipaddressheaderbase.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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
williamr@2
    31
// FORWARD DECLARATIONS
williamr@2
    32
class CSIPAddress;
williamr@2
    33
class CSIPHeaderGenericParams;
williamr@2
    34
williamr@2
    35
// CLASS DECLARATION
williamr@2
    36
/**
williamr@2
    37
* @publishedAll
williamr@2
    38
* @released
williamr@2
    39
*
williamr@2
    40
* A base class for SIP headers having syntax
williamr@2
    41
* ( name-addr/ addr-spec ) *(generic-param)
williamr@2
    42
*
williamr@2
    43
*  @lib sipcodec.lib
williamr@2
    44
*/
williamr@2
    45
class CSIPAddressHeaderBase : public CSIPParameterHeaderBase
williamr@2
    46
	{
williamr@2
    47
	public:	// Constructors and destructor
williamr@2
    48
williamr@2
    49
		/**
williamr@2
    50
		* Destructor, deletes the resources of CSIPAddressHeaderBase.
williamr@2
    51
		*/
williamr@2
    52
        IMPORT_C virtual ~CSIPAddressHeaderBase();
williamr@2
    53
williamr@2
    54
williamr@2
    55
	public: // New functions
williamr@2
    56
williamr@2
    57
		/**
williamr@2
    58
		* Sets the name-address
williamr@2
    59
		* @pre aSIPAddress != 0
williamr@2
    60
		* @param aSIPAddress a name-address to set, the ownership is transferred
williamr@2
    61
		*/
williamr@2
    62
		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
williamr@2
    63
williamr@2
    64
		/**
williamr@2
    65
		* Gets the name-address as const
williamr@2
    66
		* @return name-address object
williamr@2
    67
		*/
williamr@2
    68
		IMPORT_C const CSIPAddress& SIPAddress() const;
williamr@2
    69
williamr@2
    70
		/**
williamr@2
    71
		* Gets the name-address
williamr@2
    72
		* @return name-address object
williamr@2
    73
		*/
williamr@2
    74
		IMPORT_C CSIPAddress& SIPAddress();
williamr@2
    75
williamr@2
    76
williamr@2
    77
	protected: // Constructors
williamr@2
    78
williamr@2
    79
		CSIPAddressHeaderBase();
williamr@2
    80
        void ConstructL();
williamr@2
    81
		void ConstructL(CSIPAddress* aSIPAddress);
williamr@2
    82
        void ConstructL(const CSIPAddressHeaderBase& aHeader);
williamr@2
    83
williamr@2
    84
	protected: // Data
williamr@2
    85
williamr@2
    86
        /**
williamr@2
    87
        * @internalComponent
williamr@2
    88
        */
williamr@2
    89
		CSIPAddress* iSIPAddress;
williamr@2
    90
		
williamr@2
    91
        /**
williamr@2
    92
        * @internalComponent
williamr@2
    93
        */		
williamr@2
    94
		CSIPHeaderGenericParams* iParams;
williamr@2
    95
williamr@2
    96
	protected: // New functions
williamr@2
    97
williamr@2
    98
		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2
    99
williamr@2
   100
	protected: // From CSIPHeaderBase
williamr@2
   101
williamr@2
   102
        /**
williamr@2
   103
        * @internalComponent
williamr@2
   104
        */
williamr@2
   105
		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2
   106
williamr@2
   107
	private: // From CSIPParameterHeaderBase
williamr@2
   108
williamr@2
   109
		HBufC8* ToTextMandatoryPartLC() const;
williamr@2
   110
		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2
   111
		const CSIPParamContainerBase& Params() const;
williamr@2
   112
		CSIPParamContainerBase& Params();
williamr@2
   113
	};
williamr@2
   114
williamr@2
   115
#endif // end of CSIPADDRESSHEADERBASE_H
williamr@2
   116
williamr@2
   117
// End of File