epoc32/include/sipauthenticateheaderbase.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
     1 /*
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     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
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name          : sipauthenticateheaderbase.h
    16 * Part of       : SIP Codec
    17 * Version       : SIP/5.0 
    18 *
    19 */
    20 
    21 
    22 
    23 #ifndef CSIPAUTHENTICATEHEADERBASE_H
    24 #define CSIPAUTHENTICATEHEADERBASE_H
    25 
    26 //  INCLUDES
    27 #include "sipauthheaderbase.h"
    28 #include "_sipcodecdefs.h"
    29 
    30 // FORWARD DECLARATIONS
    31 class CSIPAuthenticateHeaderParams;
    32 
    33 // CLASS DECLARATION
    34 /**
    35 * @publishedAll
    36 * @released
    37 *
    38 * A base class for SIP Proxy-Authenticate- and WWW-Authenticate-headers
    39 *
    40 * @lib sipcodec.lib
    41 */
    42 class CSIPAuthenticateHeaderBase : public CSIPAuthHeaderBase
    43 	{
    44 	public: // Constructors and destructor
    45 
    46 		/**
    47 		* Destructor.
    48 		*/
    49 		IMPORT_C virtual ~CSIPAuthenticateHeaderBase();
    50 
    51 
    52 	public: // New functions
    53 
    54 		/**
    55 		* Check whether a qop-value in qop-options is present. 
    56 		* @param aQopValue the qop-value
    57 		* @return ETrue if present, otherwise EFalse. 
    58 		*/
    59 		IMPORT_C TBool HasQopValueL(const TDesC8& aQopValue) const;
    60 
    61 	public: // From CSIPHeaderBase
    62 
    63 		/**
    64 		* From CSIPHeaderBase ExternalizeSupported
    65 		*/
    66 		IMPORT_C virtual TBool ExternalizeSupported() const;
    67 		
    68 	protected: // Constructors
    69 
    70 		CSIPAuthenticateHeaderBase();
    71 		void ConstructL();
    72 		void ConstructL(const CSIPAuthenticateHeaderBase& aHeader);
    73 
    74 	protected: // From CSIPHeaderBase
    75 
    76 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
    77 
    78 	protected: // From CSIPAuthBase
    79 
    80 		const CSIPParamContainerBase& Params() const;
    81 		CSIPParamContainerBase& Params();
    82 
    83 	protected: // New functions
    84 
    85 		void DoInternalizeValueL(RReadStream& aReadStream);
    86 
    87 	protected: // Data
    88 
    89 		CSIPAuthenticateHeaderParams* iParams;
    90 	};
    91 
    92 #endif // CSIPAUTHENTICATEHEADERBASE_H
    93 
    94 // End of File