epoc32/include/sipsecurityheaderbase.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
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        : sipsecurityheaderbase.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 CSIPSECURITYHEADERBASE_H
williamr@2
    26
#define CSIPSECURITYHEADERBASE_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 CSIPSecurityHeaderBaseParams;
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 Security-Client, Security-Server and Security-Verify.
williamr@2
    41
*
williamr@2
    42
*  @lib sipcodec.lib
williamr@2
    43
*/
williamr@2
    44
class CSIPSecurityHeaderBase : public CSIPParameterHeaderBase
williamr@2
    45
	{
williamr@2
    46
	public:	// Constructors and destructor
williamr@2
    47
williamr@2
    48
		/**
williamr@2
    49
		* Destructor, deletes the resources of CSIPSecurityHeaderBase.
williamr@2
    50
		*/
williamr@2
    51
		IMPORT_C virtual ~CSIPSecurityHeaderBase();
williamr@2
    52
williamr@2
    53
	public: // New functions
williamr@2
    54
williamr@2
    55
		/**
williamr@2
    56
		* Gets the value of "q"-parameter
williamr@2
    57
		* @return the "q"-parameter value, zero if not present 
williamr@2
    58
		*/
williamr@2
    59
		IMPORT_C TReal PreferenceParam() const;
williamr@2
    60
williamr@2
    61
		/**
williamr@2
    62
		* Sets the "q"-parameter value
williamr@2
    63
		* @param aPreferenceValue a "q"-parameter value to set
williamr@2
    64
		*/
williamr@2
    65
		IMPORT_C void SetPreferenceParamL(TReal aPreferenceValue);
williamr@2
    66
williamr@2
    67
		/**
williamr@2
    68
		* Gets the Mechanism-Name from the Security header
williamr@2
    69
		* @return a Mechanism-Name
williamr@2
    70
		*/
williamr@2
    71
		IMPORT_C const TDesC8& MechanismName() const;
williamr@2
    72
williamr@2
    73
		/**
williamr@2
    74
		* Sets the Mechanism-Name in the Security header
williamr@2
    75
		* @param aMechanismName a Mechanism-Name
williamr@2
    76
		*/
williamr@2
    77
		IMPORT_C void SetMechanismNameL(const TDesC8& aMechanismName);
williamr@2
    78
williamr@2
    79
	public: // From CSIPHeaderBase, for internal use
williamr@2
    80
williamr@2
    81
        /**
williamr@2
    82
        * @internalComponent
williamr@2
    83
        */
williamr@2
    84
		TBool MoreThanOneAllowed() const;
williamr@2
    85
		
williamr@2
    86
        /**
williamr@2
    87
        * @internalComponent
williamr@2
    88
        */		
williamr@2
    89
		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2
    90
williamr@2
    91
	protected: // Constructors
williamr@2
    92
williamr@2
    93
		CSIPSecurityHeaderBase();
williamr@2
    94
		void ConstructL();
williamr@2
    95
		void ConstructL(const TDesC8& aMechanismName);
williamr@2
    96
		void ConstructL(const CSIPSecurityHeaderBase& aSecurityHeaderBase);
williamr@2
    97
	
williamr@2
    98
	protected: // New functions	
williamr@2
    99
		
williamr@2
   100
		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2
   101
williamr@2
   102
	private: // From CSIPHeaderBase
williamr@2
   103
williamr@2
   104
		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2
   105
williamr@2
   106
	private: // From CSIPParameterHeaderBase
williamr@2
   107
williamr@2
   108
		HBufC8* ToTextMandatoryPartLC() const;
williamr@2
   109
		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2
   110
		const CSIPParamContainerBase& Params() const;
williamr@2
   111
		CSIPParamContainerBase& Params();
williamr@2
   112
williamr@2
   113
	private: // Data
williamr@2
   114
williamr@2
   115
		HBufC8* iMechanismName;
williamr@2
   116
		CSIPSecurityHeaderBaseParams* iParams;
williamr@2
   117
williamr@2
   118
	private: // For testing purposes
williamr@2
   119
	
williamr@2
   120
		UNIT_TEST(CSIPSecurityHeaderBaseTest)
williamr@2
   121
	};
williamr@2
   122
williamr@2
   123
#endif // CSIPSECURITYHEADERBASE_H
williamr@2
   124
williamr@2
   125
// End of File