1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipsecurityheaderbase.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,125 @@
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 : sipsecurityheaderbase.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 CSIPSECURITYHEADERBASE_H
1.29 +#define CSIPSECURITYHEADERBASE_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 CSIPSecurityHeaderBaseParams;
1.37 +
1.38 +// CLASS DECLARATION
1.39 +/**
1.40 +* @publishedAll
1.41 +* @released
1.42 +*
1.43 +* A base class for Security-Client, Security-Server and Security-Verify.
1.44 +*
1.45 +* @lib sipcodec.lib
1.46 +*/
1.47 +class CSIPSecurityHeaderBase : public CSIPParameterHeaderBase
1.48 + {
1.49 + public: // Constructors and destructor
1.50 +
1.51 + /**
1.52 + * Destructor, deletes the resources of CSIPSecurityHeaderBase.
1.53 + */
1.54 + IMPORT_C virtual ~CSIPSecurityHeaderBase();
1.55 +
1.56 + public: // New functions
1.57 +
1.58 + /**
1.59 + * Gets the value of "q"-parameter
1.60 + * @return the "q"-parameter value, zero if not present
1.61 + */
1.62 + IMPORT_C TReal PreferenceParam() const;
1.63 +
1.64 + /**
1.65 + * Sets the "q"-parameter value
1.66 + * @param aPreferenceValue a "q"-parameter value to set
1.67 + */
1.68 + IMPORT_C void SetPreferenceParamL(TReal aPreferenceValue);
1.69 +
1.70 + /**
1.71 + * Gets the Mechanism-Name from the Security header
1.72 + * @return a Mechanism-Name
1.73 + */
1.74 + IMPORT_C const TDesC8& MechanismName() const;
1.75 +
1.76 + /**
1.77 + * Sets the Mechanism-Name in the Security header
1.78 + * @param aMechanismName a Mechanism-Name
1.79 + */
1.80 + IMPORT_C void SetMechanismNameL(const TDesC8& aMechanismName);
1.81 +
1.82 + public: // From CSIPHeaderBase, for internal use
1.83 +
1.84 + /**
1.85 + * @internalComponent
1.86 + */
1.87 + TBool MoreThanOneAllowed() const;
1.88 +
1.89 + /**
1.90 + * @internalComponent
1.91 + */
1.92 + TPreferredPlace PreferredPlaceInMessage() const;
1.93 +
1.94 + protected: // Constructors
1.95 +
1.96 + CSIPSecurityHeaderBase();
1.97 + void ConstructL();
1.98 + void ConstructL(const TDesC8& aMechanismName);
1.99 + void ConstructL(const CSIPSecurityHeaderBase& aSecurityHeaderBase);
1.100 +
1.101 + protected: // New functions
1.102 +
1.103 + void DoInternalizeValueL(RReadStream& aReadStream);
1.104 +
1.105 + private: // From CSIPHeaderBase
1.106 +
1.107 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.108 +
1.109 + private: // From CSIPParameterHeaderBase
1.110 +
1.111 + HBufC8* ToTextMandatoryPartLC() const;
1.112 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.113 + const CSIPParamContainerBase& Params() const;
1.114 + CSIPParamContainerBase& Params();
1.115 +
1.116 + private: // Data
1.117 +
1.118 + HBufC8* iMechanismName;
1.119 + CSIPSecurityHeaderBaseParams* iParams;
1.120 +
1.121 + private: // For testing purposes
1.122 +
1.123 + UNIT_TEST(CSIPSecurityHeaderBaseTest)
1.124 + };
1.125 +
1.126 +#endif // CSIPSECURITYHEADERBASE_H
1.127 +
1.128 +// End of File